https://github.com/lorinkoz/django-pgschemas

Django multi-tenancy through Postgres schemas
https://github.com/lorinkoz/django-pgschemas

django multi-tenancy postgres python

Last synced: 1 day ago
JSON representation

Django multi-tenancy through Postgres schemas

• Host: GitHub
• URL: https://github.com/lorinkoz/django-pgschemas
• Owner: lorinkoz
• License: mit
• Created: 2018-12-24T14:04:14.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2024-10-29T19:29:11.000Z (2 months ago)
• Last Synced: 2024-10-30T07:42:44.858Z (2 months ago)
• Topics: django, multi-tenancy, postgres, python
• Language: Python
• Homepage: https://django-pgschemas.readthedocs.io/
• Size: 1.26 MB
• Stars: 144
• Watchers: 13
• Forks: 19
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

• cuban-opensource - django-pgschemas - tenancy using PostgreSQL schemas. (Web Development / Python)

README

        
# django-pgschemas

[![Packaging: poetry](https://img.shields.io/badge/packaging-poetry-purple.svg)](https://python-poetry.org/)

[![Build status](https://github.com/lorinkoz/django-pgschemas/workflows/code/badge.svg)](https://github.com/lorinkoz/django-pgschemas/actions)

[![Documentation status](https://readthedocs.org/projects/django-pgschemas/badge/?version=latest)](https://django-pgschemas.readthedocs.io/)

[![Code coverage](https://coveralls.io/repos/github/lorinkoz/django-pgschemas/badge.svg?branch=master)](https://coveralls.io/github/lorinkoz/django-pgschemas?branch=master)

[![PyPi version](https://badge.fury.io/py/django-pgschemas.svg)](http://badge.fury.io/py/django-pgschemas)

[![Downloads](https://pepy.tech/badge/django-pgschemas/month)](https://pepy.tech/project/django-pgschemas/)

This package uses Postgres schemas to support data multi-tenancy in a single Django project. It is a fork of [django-tenants](https://github.com/django-tenants/django-tenants) with some conceptual changes:

- There are static tenants and dynamic tenants. Static tenants can have their own apps and urlconf.

- Tenants can be routed via:

  - URL using subdomain or subfolder on shared subdomain

  - Session

  - Headers

- Public schema should not be used for storing the main site data, but the true shared data across all tenants. Table "overriding" via search path is not encouraged.

- Management commands can be run on multiple schemas via wildcards, either sequentially or in parallel using multithreading.

## Documentation

https://django-pgschemas.readthedocs.io/

Version 1.0 has several breaking changes from the 0.\* series. Please refer to [this discussion](https://github.com/lorinkoz/django-pgschemas/discussions/277) for details and bug reports.

## Contributing

- Join the discussion at https://github.com/lorinkoz/django-pgschemas/discussions.

- PRs are welcome! If you have questions or comments, please use the discussions link above.

- To run the test suite run `make` or `make coverage`. The tests for this project live inside a small django project called `sandbox`.

## Credits

- Tom Turner for [django-tenants](https://github.com/django-tenants/django-tenants).

- Bernardo Pires for [django-tenant-schemas](https://github.com/bernardopires/django-tenant-schemas).

- Denish Patel for [pg-clone-schema](https://github.com/denishpatel/pg-clone-schema)