Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

Handle multi-tenancy in Django with no additional global state using schemas.

Project Description

Handle multi-tenancy in Django with no additional global state using schemas.

Installation

Assuming you have django installed, the first step is to install django-tenancy:

pip install django-tenancy

Now you can import the tenancy module in your Django project.

Using django-tenancy

Define a Tenant Model

The tenant model must be a subclass of tenancy.models.AbstractTenant.

For instance, your myapp/models.py might look like:

from tenancy.models import AbstractTenant

class MyTenantModel(AbstractTenant):
   name = models.CharField(max_length=50)
   # other fields
   def natural_key(self):
      return (self.name, )

Important note: the natural_key method must return a tuple that will be used to prefix the model and its database table. This prefix must be unique to the tenant.

Declare the Tenant Model

Now that you have your tenant model, let’s declare in your project in settings.py:

TENANCY_TENANT_MODEL = 'myapp.MyTenantModel'

Run a database synchronization to create the corresponding table:

python manage.py syncdb

Define the tenant-specific models

The tenant-specific models must subclass tenancy.models.TenantModel.

For instance, each tenant will have projects and reports. Here is how myapp/models.py might look like:

from tenancy.models import AbstractTenant, TenantModel

class MyTenantModel(AbstractTenant):
   name = models.CharField(max_length=50)
   # other fields
   def natural_key(self):
      return (self.name, )

class Project(TenantModel):
   name = models.CharField(max_length=50)
   description = models.CharField(max_length=300, blank=True, null=True)

class Report(TenantModel):
   name = models.CharField(max_length=50)
   content = models.CharField(max_length=300, blank=True, null=True)

Playing with the defined models

You can manipulate the tenant and tenant-specific models as any other Django models.

Create a tenant instance

tenant = MyTenantModel.objects.create("myfirsttenant")

Get a tenant-specific model: for_tenant()

<TenantModel>.for_tenant(<AbtractTenantConcreteSubclass instance>)

TenantModel comes with a method that allows you to get the specific AbstractTenantModel for a given Tenant instance. For instance:

tenant_project = Project.for_tenant(tenant)

Create a tenant-specific model instance

tenant_project.objects.create("myfirsttenant_project")

Python 3.5

An issue with circular references between Model objects prevent garbage collection of tenant specific models on tenant deletion.

Release History

Release History

History Node

0.3.1a4

History Node

0.3.1a3

History Node

0.3.1a2

History Node

0.3.1a1

This version
History Node

0.3

History Node

0.3a7

History Node

0.3a6

History Node

0.3a5

History Node

0.3a4

History Node

0.3a3

History Node

0.3a2

History Node

0.3a1

History Node

0.2.2

History Node

0.2.1

History Node

0.2.0

History Node

0.1.2

History Node

0.1.1

History Node

0.1.0

History Node

0.0.1

Download Files

Download Files

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

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
django_tenancy-0.3-py2.py3-none-any.whl (27.9 kB) Copy SHA256 Checksum SHA256 py2.py3 Wheel Oct 6, 2016
django-tenancy-0.3.tar.gz (21.4 kB) Copy SHA256 Checksum SHA256 Source Oct 6, 2016

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting