Handle multi-tenancy in Django with no additional global state using schemas.
http://pypi.python.org/pypi/django-tenancy
Assuming you have django installed, the first step is to install django-tenancy: :
pip install django-tenany
Now you can import the tenancy
module in your Django project.
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.
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
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)
You can manipulate the tenant and tenant-specific models as any other Django models.
tenant = MyTenantModel.objects.create("myfirsttenant")
<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)
tenant_project.objects.create("myfirsttenant_project")