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.

Documentation

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

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.

Source Distribution

django-pgschemas-0.7.0.tar.gz (36.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

django_pgschemas-0.7.0-py3-none-any.whl (46.7 kB view details)

Uploaded Python 3

File details

Details for the file django-pgschemas-0.7.0.tar.gz.

File metadata

  • Download URL: django-pgschemas-0.7.0.tar.gz
  • Upload date:
  • Size: 36.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/54.1.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.2

File hashes

Hashes for django-pgschemas-0.7.0.tar.gz
Algorithm Hash digest
SHA256 77aa381bad058d2a20cc9a49c84dbcf738a99a9df0373e4ef08436dd43bdd78c
MD5 4f62baaa6faf6c9f52099c8a22c68cb4
BLAKE2b-256 fb92c820f2ca5c3bb616f2969a6a7036ba010cb990c052d6dfac00324d65039f

See more details on using hashes here.

File details

Details for the file django_pgschemas-0.7.0-py3-none-any.whl.

File metadata

  • Download URL: django_pgschemas-0.7.0-py3-none-any.whl
  • Upload date:
  • Size: 46.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/54.1.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.2

File hashes

Hashes for django_pgschemas-0.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f48954be949b8708288afc7ef8bc872d86e4c87415b132d6cf38a759f4db72d4
MD5 cee3a3e508a9a9aa9e04b1d78a3a3400
BLAKE2b-256 0f13d6d1fbd412e651d0fb6e09b97a1397d9b0c5b5ca60f047707fdfedf123b5

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page