Skip to main content

Multi-tenancy on Django using PostgreSQL schemas.

Project description

Packaging: poetry Code style: black Join the chat at https://gitter.im/django-pgschemas Build status Documentation status Code coverage PyPi version Downloads

This app uses PostgreSQL schemas to support data multi-tenancy in a single Django project. It is a fork of 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 simultaneously routed via subdomain and via subfolder on shared subdomain.
  • Public is no longer the schema for storing the main site data. Public should be used only for true shared data across all tenants. Table “overriding” via search path is no longer encouraged.
  • Management commands can be run on multiple schemas via wildcards - the multiproc behavior of migrations was extended to just any tenant command.

Which package to use?

There are currently multiple packages to handle multi-tenancy via PostgreSQL schemas. This table should help you make an informed decision on which one to choose.

Package Features
django-tenant-schemas Original project. Active and maintained by @goodtune.
django-tenants Active and maintained by @tomturner. Built on top of django-tenant-schemas. Uses a Domain model for allowing multiple domains per tenant. Allows for parallel migrations with custom migration executor. Other multiple improvements.
django-pgschemas Active and maintained by @lorinkoz. Built on top of django-tenants. Different philosphy for tenants. Other improvements listed above.

Breaking changes

v0.7.0

  • Changed public API for getting/setting active schema. Public API is now get_current_schema, activate(schema), activate_public(). Any schema descriptor can still be used as context manager.
  • Changed location of tenant model and domain model in settings. TENANT_MODEL and DOMAIN_MODEL keys are now under TENANTS["default"] instead of TENANTS["public"]. This is required for future static-tenant-only configurations.
  • Module cache renamed to contrib.cache.
  • Module contrib.channels renamed to contrib.channels2.
  • Added module contrib.channels3.
  • Management command option --executor {sequential, parallel} renamed to --parallel.
  • All signals renamed. Added schema_activate signal.

Contributing

  • Join the discussion at https://gitter.im/django-pgschemas/community.
  • PRs are welcome! If you have questions or comments, please use the link above.
  • To run the test suite run make or make coverage. The tests for this project live inside a small django project called dpgs_sandbox. Database password and database host can be set through the environment variables DATABASE_PASSWORD and DATABASE_HOST.

Credits

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for django-pgschemas, version 0.7.0
Filename, size File type Python version Upload date Hashes
Filename, size django_pgschemas-0.7.0-py3-none-any.whl (46.7 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size django-pgschemas-0.7.0.tar.gz (36.0 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page