summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--.gitignore1
-rw-r--r--python-django-multitenant.spec726
-rw-r--r--sources1
3 files changed, 728 insertions, 0 deletions
diff --git a/.gitignore b/.gitignore
index e69de29..f9178c0 100644
--- a/.gitignore
+++ b/.gitignore
@@ -0,0 +1 @@
+/django-multitenant-3.2.1.tar.gz
diff --git a/python-django-multitenant.spec b/python-django-multitenant.spec
new file mode 100644
index 0000000..3aabe5f
--- /dev/null
+++ b/python-django-multitenant.spec
@@ -0,0 +1,726 @@
+%global _empty_manifest_terminate_build 0
+Name: python-django-multitenant
+Version: 3.2.1
+Release: 1
+Summary: Django Library to Implement Multi-tenant databases
+License: MIT License
+URL: https://github.com/citusdata/django-multitenant
+Source0: https://mirrors.nju.edu.cn/pypi/web/packages/c3/5f/611ed8d58ed9dd2941938f99b870b2b527d0afc0e0cb336691316a43794b/django-multitenant-3.2.1.tar.gz
+BuildArch: noarch
+
+
+%description
+# django-multitenant <br>[![Build Status](https://github.com/citusdata/django-multitenant/actions/workflows/django-multitenant-tests.yml/badge.svg)](https://github.com/citusdata/django-multitenant/actions/workflows/django-multitenant-tests.yml) [![Latest Documentation Status](https://readthedocs.org/projects/django-multitenant/badge/?version=latest)](https://django-multitenant.readthedocs.io/en/latest/?badge=latest) [![Coverage Status](https://codecov.io/gh/citusdata/django-multitenant/branch/main/graph/badge.svg?token=taRgoSgHUw)](https://codecov.io/gh/citusdata/django-multitenant) [![PyPI Version](https://badge.fury.io/py/django-multitenant.svg)](https://badge.fury.io/py/django-multitenant)
+
+Python/Django support for distributed multi-tenant databases like Postgres+Citus
+
+Enables easy scale-out by adding the tenant context to your queries, enabling the database (e.g. Citus) to efficiently route queries to the right database node.
+
+There are architecures for building multi-tenant databases viz. **Create one database per tenant**, **Create one schema per tenant** and **Have all tenants share the same table(s)**. This library is based on the 3rd design i.e **Have all tenants share the same table(s)**, it assumes that all the tenant relates models/tables have a tenant_id column for representing a tenant.
+
+The following link talks more about the trade-offs on when and how to choose the right architecture for your multi-tenat database:
+
+https://www.citusdata.com/blog/2016/10/03/designing-your-saas-database-for-high-scalability/
+
+**Other useful links on multi-tenancy**:
+1. https://www.citusdata.com/blog/2017/03/09/multi-tenant-sharding-tutorial/
+1. https://www.citusdata.com/blog/2017/06/02/scaling-complex-sql-transactions/
+
+
+## Installation:
+1. `pip install --no-cache-dir django_multitenant`
+
+## Supported Django versions/Pre-requisites.
+
+| Python | Django |Citus |
+| ----------------------| --------------|---------------|
+| 3.8 3.9 3.10 3.11 | 4.1 | 11 |
+| 3.8 3.9 3.10 3.11 | 4.0 | 10 11 |
+| 3.7 | 3.2 | 10 11 |
+
+
+
+
+## Usage:
+
+In order to use this library you can either use Mixins or have your models inherit from our custom model class.
+
+
+### Changes in Models:
+1. In whichever files you want to use the library import it:
+ ```python
+ from django_multitenant.fields import *
+ from django_multitenant.models import *
+ ```
+2. All models should inherit the TenantModel class.
+ `Ex: class Product(TenantModel):`
+3. Define a static variable named tenant_id and specify the tenant column using this variable.You can define tenant_id in three ways. Any of them is acceptavle
+ * Using TenantMeta.tenant_field_name variable
+ * Using TenantMeta.tenant_id variable
+ * Using tenant_id field
+ <br>
+
+
+ > **Warning**
+ > Using tenant_id field directly in the class is not suggested since it may cause collision if class has a field named with 'tenant'
+ <br>
+
+4. All foreign keys to TenantModel subclasses should use TenantForeignKey in place of
+ models.ForeignKey
+5. A sample model implementing the above 2 steps:
+ ```python
+ class Store(TenantModel):
+ name = models.CharField(max_length=50)
+ address = models.CharField(max_length=255)
+ email = models.CharField(max_length=50)
+ class TenantMeta:
+ tenant_field_name = "id"
+
+ class Product(TenantModel):
+ store = models.ForeignKey(Store)
+ name = models.CharField(max_length=255)
+ description = models.TextField()
+ class Meta:
+ unique_together = ["id", "store"]
+ class TenantMeta:
+ tenant_field_name = "store_id"
+ class Purchase(TenantModel):
+ store = models.ForeignKey(Store)
+ product_purchased = TenantForeignKey(Product)
+ class TenantMeta:
+ tenant_field_name = "store_id"
+ ```
+
+
+### Changes in Models using mixins:
+1. In whichever files you want to use the library import it by just saying
+ ```python
+ from django_multitenant.mixins import *
+ ```
+1. All models should use the `TenantModelMixin` and the django `models.Model` or your customer Model class
+ `Ex: class Product(TenantModelMixin, models.Model):`
+1. Define a static variable named tenant_id and specify the tenant column using this variable.
+ `Ex: tenant_id='store_id'`
+1. All foreign keys to TenantModel subclasses should use TenantForeignKey in place of
+ models.ForeignKey
+1. Referenced table in TenenatForeignKey should include a unique key including tenant_id and primary key
+ ```
+ Ex:
+ class Meta:
+ unique_together = ["id", "store"]
+ ```
+1. A sample model implementing the above 3 steps:
+ ```python
+
+ class ProductManager(TenantManagerMixin, models.Manager):
+ pass
+
+ class Product(TenantModelMixin, models.Model):
+ store = models.ForeignKey(Store)
+ tenant_id='store_id'
+ name = models.CharField(max_length=255)
+ description = models.TextField()
+
+ objects = ProductManager()
+
+ class Meta:
+ unique_together = ["id", "store"]
+
+ class PurchaseManager(TenantManagerMixin, models.Manager):
+ pass
+
+ class Purchase(TenantModelMixin, models.Model):
+ store = models.ForeignKey(Store)
+ tenant_id='store_id'
+ product_purchased = TenantForeignKey(Product)
+
+ objects = PurchaseManager()
+ ```
+
+
+
+### Automating composite foreign keys at db layer:
+1. Creating foreign keys between tenant related models using TenantForeignKey would automate adding tenant_id to reference queries (ex. product.purchases) and join queries (ex. product__name). If you want to ensure to create composite foreign keys (with tenant_id) at the db layer, you should change the database ENGINE in the settings.py to `django_multitenant.backends.postgresql`.
+ ```python
+ 'default': {
+ 'ENGINE': 'django_multitenant.backends.postgresql',
+ ......
+ ......
+ ......
+ }
+ ```
+### Where to Set the Tenant?
+1. Write authentication logic using a middleware which also sets/unsets a tenant for each session/request. This way developers need not worry about setting a tenant on a per view basis. Just set it while authentication and the library would ensure the rest (adding tenant_id filters to the queries). A sample implementation of the above is as follows:
+ ```python
+ from django_multitenant.utils import set_current_tenant
+
+ class MultitenantMiddleware:
+ def __init__(self, get_response):
+ self.get_response = get_response
+
+ def __call__(self, request):
+ if request.user and not request.user.is_anonymous:
+ set_current_tenant(request.user.employee.company)
+ return self.get_response(request)
+ ```
+
+ In your settings, you will need to update the `MIDDLEWARE` setting to include the one you created.
+ ```python
+ MIDDLEWARE = [
+ # ...
+ # existing items
+ # ...
+ 'appname.middleware.MultitenantMiddleware'
+ ]
+ ```
+2. Set the tenant using set_current_tenant(t) api in all the views which you want to be scoped based on tenant. This would scope all the django API calls automatically(without specifying explicit filters) to a single tenant. If the current_tenant is not set, then the default/native API without tenant scoping is used.
+ ```python
+ def application_function:
+ # current_tenant can be stored as a SESSION variable when a user logs in.
+ # This should be done by the app
+ t = current_tenant
+ #set the tenant
+ set_current_tenant(t);
+ #Django ORM API calls;
+ #Command 1;
+ #Command 2;
+ #Command 3;
+ #Command 4;
+ #Command 5;
+ ```
+
+## Supported APIs:
+1. Most of the APIs under Model.objects.*.
+1. Model.save() injects tenant_id for tenant inherited models.
+ ```python
+ s=Store.objects.all()[0]
+ set_current_tenant(s)
+
+ #All the below API calls would add suitable tenant filters.
+ #Simple get_queryset()
+ Product.objects.get_queryset()
+
+ #Simple join
+ Purchase.objects.filter(id=1).filter(store__name='The Awesome Store').filter(product__description='All products are awesome')
+
+ #Update
+ Purchase.objects.filter(id=1).update(id=1)
+
+ #Save
+ p=Product(8,1,'Awesome Shoe','These shoes are awesome')
+ p.save()
+
+ #Simple aggregates
+ Product.objects.count()
+ Product.objects.filter(store__name='The Awesome Store').count()
+
+ #Subqueries
+ Product.objects.filter(name='Awesome Shoe');
+ Purchase.objects.filter(product__in=p);
+
+ ```
+
+## Credits
+
+This library uses similar logic of setting/getting tenant object as in [django-simple-multitenant](https://github.com/pombredanne/django-simple-multitenant). We thank the authors for their efforts.
+
+## License
+
+Copyright (C) 2023, Citus Data
+Licensed under the MIT license, see LICENSE file for details.
+
+
+%package -n python3-django-multitenant
+Summary: Django Library to Implement Multi-tenant databases
+Provides: python-django-multitenant
+BuildRequires: python3-devel
+BuildRequires: python3-setuptools
+BuildRequires: python3-pip
+%description -n python3-django-multitenant
+# django-multitenant <br>[![Build Status](https://github.com/citusdata/django-multitenant/actions/workflows/django-multitenant-tests.yml/badge.svg)](https://github.com/citusdata/django-multitenant/actions/workflows/django-multitenant-tests.yml) [![Latest Documentation Status](https://readthedocs.org/projects/django-multitenant/badge/?version=latest)](https://django-multitenant.readthedocs.io/en/latest/?badge=latest) [![Coverage Status](https://codecov.io/gh/citusdata/django-multitenant/branch/main/graph/badge.svg?token=taRgoSgHUw)](https://codecov.io/gh/citusdata/django-multitenant) [![PyPI Version](https://badge.fury.io/py/django-multitenant.svg)](https://badge.fury.io/py/django-multitenant)
+
+Python/Django support for distributed multi-tenant databases like Postgres+Citus
+
+Enables easy scale-out by adding the tenant context to your queries, enabling the database (e.g. Citus) to efficiently route queries to the right database node.
+
+There are architecures for building multi-tenant databases viz. **Create one database per tenant**, **Create one schema per tenant** and **Have all tenants share the same table(s)**. This library is based on the 3rd design i.e **Have all tenants share the same table(s)**, it assumes that all the tenant relates models/tables have a tenant_id column for representing a tenant.
+
+The following link talks more about the trade-offs on when and how to choose the right architecture for your multi-tenat database:
+
+https://www.citusdata.com/blog/2016/10/03/designing-your-saas-database-for-high-scalability/
+
+**Other useful links on multi-tenancy**:
+1. https://www.citusdata.com/blog/2017/03/09/multi-tenant-sharding-tutorial/
+1. https://www.citusdata.com/blog/2017/06/02/scaling-complex-sql-transactions/
+
+
+## Installation:
+1. `pip install --no-cache-dir django_multitenant`
+
+## Supported Django versions/Pre-requisites.
+
+| Python | Django |Citus |
+| ----------------------| --------------|---------------|
+| 3.8 3.9 3.10 3.11 | 4.1 | 11 |
+| 3.8 3.9 3.10 3.11 | 4.0 | 10 11 |
+| 3.7 | 3.2 | 10 11 |
+
+
+
+
+## Usage:
+
+In order to use this library you can either use Mixins or have your models inherit from our custom model class.
+
+
+### Changes in Models:
+1. In whichever files you want to use the library import it:
+ ```python
+ from django_multitenant.fields import *
+ from django_multitenant.models import *
+ ```
+2. All models should inherit the TenantModel class.
+ `Ex: class Product(TenantModel):`
+3. Define a static variable named tenant_id and specify the tenant column using this variable.You can define tenant_id in three ways. Any of them is acceptavle
+ * Using TenantMeta.tenant_field_name variable
+ * Using TenantMeta.tenant_id variable
+ * Using tenant_id field
+ <br>
+
+
+ > **Warning**
+ > Using tenant_id field directly in the class is not suggested since it may cause collision if class has a field named with 'tenant'
+ <br>
+
+4. All foreign keys to TenantModel subclasses should use TenantForeignKey in place of
+ models.ForeignKey
+5. A sample model implementing the above 2 steps:
+ ```python
+ class Store(TenantModel):
+ name = models.CharField(max_length=50)
+ address = models.CharField(max_length=255)
+ email = models.CharField(max_length=50)
+ class TenantMeta:
+ tenant_field_name = "id"
+
+ class Product(TenantModel):
+ store = models.ForeignKey(Store)
+ name = models.CharField(max_length=255)
+ description = models.TextField()
+ class Meta:
+ unique_together = ["id", "store"]
+ class TenantMeta:
+ tenant_field_name = "store_id"
+ class Purchase(TenantModel):
+ store = models.ForeignKey(Store)
+ product_purchased = TenantForeignKey(Product)
+ class TenantMeta:
+ tenant_field_name = "store_id"
+ ```
+
+
+### Changes in Models using mixins:
+1. In whichever files you want to use the library import it by just saying
+ ```python
+ from django_multitenant.mixins import *
+ ```
+1. All models should use the `TenantModelMixin` and the django `models.Model` or your customer Model class
+ `Ex: class Product(TenantModelMixin, models.Model):`
+1. Define a static variable named tenant_id and specify the tenant column using this variable.
+ `Ex: tenant_id='store_id'`
+1. All foreign keys to TenantModel subclasses should use TenantForeignKey in place of
+ models.ForeignKey
+1. Referenced table in TenenatForeignKey should include a unique key including tenant_id and primary key
+ ```
+ Ex:
+ class Meta:
+ unique_together = ["id", "store"]
+ ```
+1. A sample model implementing the above 3 steps:
+ ```python
+
+ class ProductManager(TenantManagerMixin, models.Manager):
+ pass
+
+ class Product(TenantModelMixin, models.Model):
+ store = models.ForeignKey(Store)
+ tenant_id='store_id'
+ name = models.CharField(max_length=255)
+ description = models.TextField()
+
+ objects = ProductManager()
+
+ class Meta:
+ unique_together = ["id", "store"]
+
+ class PurchaseManager(TenantManagerMixin, models.Manager):
+ pass
+
+ class Purchase(TenantModelMixin, models.Model):
+ store = models.ForeignKey(Store)
+ tenant_id='store_id'
+ product_purchased = TenantForeignKey(Product)
+
+ objects = PurchaseManager()
+ ```
+
+
+
+### Automating composite foreign keys at db layer:
+1. Creating foreign keys between tenant related models using TenantForeignKey would automate adding tenant_id to reference queries (ex. product.purchases) and join queries (ex. product__name). If you want to ensure to create composite foreign keys (with tenant_id) at the db layer, you should change the database ENGINE in the settings.py to `django_multitenant.backends.postgresql`.
+ ```python
+ 'default': {
+ 'ENGINE': 'django_multitenant.backends.postgresql',
+ ......
+ ......
+ ......
+ }
+ ```
+### Where to Set the Tenant?
+1. Write authentication logic using a middleware which also sets/unsets a tenant for each session/request. This way developers need not worry about setting a tenant on a per view basis. Just set it while authentication and the library would ensure the rest (adding tenant_id filters to the queries). A sample implementation of the above is as follows:
+ ```python
+ from django_multitenant.utils import set_current_tenant
+
+ class MultitenantMiddleware:
+ def __init__(self, get_response):
+ self.get_response = get_response
+
+ def __call__(self, request):
+ if request.user and not request.user.is_anonymous:
+ set_current_tenant(request.user.employee.company)
+ return self.get_response(request)
+ ```
+
+ In your settings, you will need to update the `MIDDLEWARE` setting to include the one you created.
+ ```python
+ MIDDLEWARE = [
+ # ...
+ # existing items
+ # ...
+ 'appname.middleware.MultitenantMiddleware'
+ ]
+ ```
+2. Set the tenant using set_current_tenant(t) api in all the views which you want to be scoped based on tenant. This would scope all the django API calls automatically(without specifying explicit filters) to a single tenant. If the current_tenant is not set, then the default/native API without tenant scoping is used.
+ ```python
+ def application_function:
+ # current_tenant can be stored as a SESSION variable when a user logs in.
+ # This should be done by the app
+ t = current_tenant
+ #set the tenant
+ set_current_tenant(t);
+ #Django ORM API calls;
+ #Command 1;
+ #Command 2;
+ #Command 3;
+ #Command 4;
+ #Command 5;
+ ```
+
+## Supported APIs:
+1. Most of the APIs under Model.objects.*.
+1. Model.save() injects tenant_id for tenant inherited models.
+ ```python
+ s=Store.objects.all()[0]
+ set_current_tenant(s)
+
+ #All the below API calls would add suitable tenant filters.
+ #Simple get_queryset()
+ Product.objects.get_queryset()
+
+ #Simple join
+ Purchase.objects.filter(id=1).filter(store__name='The Awesome Store').filter(product__description='All products are awesome')
+
+ #Update
+ Purchase.objects.filter(id=1).update(id=1)
+
+ #Save
+ p=Product(8,1,'Awesome Shoe','These shoes are awesome')
+ p.save()
+
+ #Simple aggregates
+ Product.objects.count()
+ Product.objects.filter(store__name='The Awesome Store').count()
+
+ #Subqueries
+ Product.objects.filter(name='Awesome Shoe');
+ Purchase.objects.filter(product__in=p);
+
+ ```
+
+## Credits
+
+This library uses similar logic of setting/getting tenant object as in [django-simple-multitenant](https://github.com/pombredanne/django-simple-multitenant). We thank the authors for their efforts.
+
+## License
+
+Copyright (C) 2023, Citus Data
+Licensed under the MIT license, see LICENSE file for details.
+
+
+%package help
+Summary: Development documents and examples for django-multitenant
+Provides: python3-django-multitenant-doc
+%description help
+# django-multitenant <br>[![Build Status](https://github.com/citusdata/django-multitenant/actions/workflows/django-multitenant-tests.yml/badge.svg)](https://github.com/citusdata/django-multitenant/actions/workflows/django-multitenant-tests.yml) [![Latest Documentation Status](https://readthedocs.org/projects/django-multitenant/badge/?version=latest)](https://django-multitenant.readthedocs.io/en/latest/?badge=latest) [![Coverage Status](https://codecov.io/gh/citusdata/django-multitenant/branch/main/graph/badge.svg?token=taRgoSgHUw)](https://codecov.io/gh/citusdata/django-multitenant) [![PyPI Version](https://badge.fury.io/py/django-multitenant.svg)](https://badge.fury.io/py/django-multitenant)
+
+Python/Django support for distributed multi-tenant databases like Postgres+Citus
+
+Enables easy scale-out by adding the tenant context to your queries, enabling the database (e.g. Citus) to efficiently route queries to the right database node.
+
+There are architecures for building multi-tenant databases viz. **Create one database per tenant**, **Create one schema per tenant** and **Have all tenants share the same table(s)**. This library is based on the 3rd design i.e **Have all tenants share the same table(s)**, it assumes that all the tenant relates models/tables have a tenant_id column for representing a tenant.
+
+The following link talks more about the trade-offs on when and how to choose the right architecture for your multi-tenat database:
+
+https://www.citusdata.com/blog/2016/10/03/designing-your-saas-database-for-high-scalability/
+
+**Other useful links on multi-tenancy**:
+1. https://www.citusdata.com/blog/2017/03/09/multi-tenant-sharding-tutorial/
+1. https://www.citusdata.com/blog/2017/06/02/scaling-complex-sql-transactions/
+
+
+## Installation:
+1. `pip install --no-cache-dir django_multitenant`
+
+## Supported Django versions/Pre-requisites.
+
+| Python | Django |Citus |
+| ----------------------| --------------|---------------|
+| 3.8 3.9 3.10 3.11 | 4.1 | 11 |
+| 3.8 3.9 3.10 3.11 | 4.0 | 10 11 |
+| 3.7 | 3.2 | 10 11 |
+
+
+
+
+## Usage:
+
+In order to use this library you can either use Mixins or have your models inherit from our custom model class.
+
+
+### Changes in Models:
+1. In whichever files you want to use the library import it:
+ ```python
+ from django_multitenant.fields import *
+ from django_multitenant.models import *
+ ```
+2. All models should inherit the TenantModel class.
+ `Ex: class Product(TenantModel):`
+3. Define a static variable named tenant_id and specify the tenant column using this variable.You can define tenant_id in three ways. Any of them is acceptavle
+ * Using TenantMeta.tenant_field_name variable
+ * Using TenantMeta.tenant_id variable
+ * Using tenant_id field
+ <br>
+
+
+ > **Warning**
+ > Using tenant_id field directly in the class is not suggested since it may cause collision if class has a field named with 'tenant'
+ <br>
+
+4. All foreign keys to TenantModel subclasses should use TenantForeignKey in place of
+ models.ForeignKey
+5. A sample model implementing the above 2 steps:
+ ```python
+ class Store(TenantModel):
+ name = models.CharField(max_length=50)
+ address = models.CharField(max_length=255)
+ email = models.CharField(max_length=50)
+ class TenantMeta:
+ tenant_field_name = "id"
+
+ class Product(TenantModel):
+ store = models.ForeignKey(Store)
+ name = models.CharField(max_length=255)
+ description = models.TextField()
+ class Meta:
+ unique_together = ["id", "store"]
+ class TenantMeta:
+ tenant_field_name = "store_id"
+ class Purchase(TenantModel):
+ store = models.ForeignKey(Store)
+ product_purchased = TenantForeignKey(Product)
+ class TenantMeta:
+ tenant_field_name = "store_id"
+ ```
+
+
+### Changes in Models using mixins:
+1. In whichever files you want to use the library import it by just saying
+ ```python
+ from django_multitenant.mixins import *
+ ```
+1. All models should use the `TenantModelMixin` and the django `models.Model` or your customer Model class
+ `Ex: class Product(TenantModelMixin, models.Model):`
+1. Define a static variable named tenant_id and specify the tenant column using this variable.
+ `Ex: tenant_id='store_id'`
+1. All foreign keys to TenantModel subclasses should use TenantForeignKey in place of
+ models.ForeignKey
+1. Referenced table in TenenatForeignKey should include a unique key including tenant_id and primary key
+ ```
+ Ex:
+ class Meta:
+ unique_together = ["id", "store"]
+ ```
+1. A sample model implementing the above 3 steps:
+ ```python
+
+ class ProductManager(TenantManagerMixin, models.Manager):
+ pass
+
+ class Product(TenantModelMixin, models.Model):
+ store = models.ForeignKey(Store)
+ tenant_id='store_id'
+ name = models.CharField(max_length=255)
+ description = models.TextField()
+
+ objects = ProductManager()
+
+ class Meta:
+ unique_together = ["id", "store"]
+
+ class PurchaseManager(TenantManagerMixin, models.Manager):
+ pass
+
+ class Purchase(TenantModelMixin, models.Model):
+ store = models.ForeignKey(Store)
+ tenant_id='store_id'
+ product_purchased = TenantForeignKey(Product)
+
+ objects = PurchaseManager()
+ ```
+
+
+
+### Automating composite foreign keys at db layer:
+1. Creating foreign keys between tenant related models using TenantForeignKey would automate adding tenant_id to reference queries (ex. product.purchases) and join queries (ex. product__name). If you want to ensure to create composite foreign keys (with tenant_id) at the db layer, you should change the database ENGINE in the settings.py to `django_multitenant.backends.postgresql`.
+ ```python
+ 'default': {
+ 'ENGINE': 'django_multitenant.backends.postgresql',
+ ......
+ ......
+ ......
+ }
+ ```
+### Where to Set the Tenant?
+1. Write authentication logic using a middleware which also sets/unsets a tenant for each session/request. This way developers need not worry about setting a tenant on a per view basis. Just set it while authentication and the library would ensure the rest (adding tenant_id filters to the queries). A sample implementation of the above is as follows:
+ ```python
+ from django_multitenant.utils import set_current_tenant
+
+ class MultitenantMiddleware:
+ def __init__(self, get_response):
+ self.get_response = get_response
+
+ def __call__(self, request):
+ if request.user and not request.user.is_anonymous:
+ set_current_tenant(request.user.employee.company)
+ return self.get_response(request)
+ ```
+
+ In your settings, you will need to update the `MIDDLEWARE` setting to include the one you created.
+ ```python
+ MIDDLEWARE = [
+ # ...
+ # existing items
+ # ...
+ 'appname.middleware.MultitenantMiddleware'
+ ]
+ ```
+2. Set the tenant using set_current_tenant(t) api in all the views which you want to be scoped based on tenant. This would scope all the django API calls automatically(without specifying explicit filters) to a single tenant. If the current_tenant is not set, then the default/native API without tenant scoping is used.
+ ```python
+ def application_function:
+ # current_tenant can be stored as a SESSION variable when a user logs in.
+ # This should be done by the app
+ t = current_tenant
+ #set the tenant
+ set_current_tenant(t);
+ #Django ORM API calls;
+ #Command 1;
+ #Command 2;
+ #Command 3;
+ #Command 4;
+ #Command 5;
+ ```
+
+## Supported APIs:
+1. Most of the APIs under Model.objects.*.
+1. Model.save() injects tenant_id for tenant inherited models.
+ ```python
+ s=Store.objects.all()[0]
+ set_current_tenant(s)
+
+ #All the below API calls would add suitable tenant filters.
+ #Simple get_queryset()
+ Product.objects.get_queryset()
+
+ #Simple join
+ Purchase.objects.filter(id=1).filter(store__name='The Awesome Store').filter(product__description='All products are awesome')
+
+ #Update
+ Purchase.objects.filter(id=1).update(id=1)
+
+ #Save
+ p=Product(8,1,'Awesome Shoe','These shoes are awesome')
+ p.save()
+
+ #Simple aggregates
+ Product.objects.count()
+ Product.objects.filter(store__name='The Awesome Store').count()
+
+ #Subqueries
+ Product.objects.filter(name='Awesome Shoe');
+ Purchase.objects.filter(product__in=p);
+
+ ```
+
+## Credits
+
+This library uses similar logic of setting/getting tenant object as in [django-simple-multitenant](https://github.com/pombredanne/django-simple-multitenant). We thank the authors for their efforts.
+
+## License
+
+Copyright (C) 2023, Citus Data
+Licensed under the MIT license, see LICENSE file for details.
+
+
+%prep
+%autosetup -n django-multitenant-3.2.1
+
+%build
+%py3_build
+
+%install
+%py3_install
+install -d -m755 %{buildroot}/%{_pkgdocdir}
+if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi
+if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi
+if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi
+if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi
+pushd %{buildroot}
+if [ -d usr/lib ]; then
+ find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst
+fi
+if [ -d usr/lib64 ]; then
+ find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst
+fi
+if [ -d usr/bin ]; then
+ find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst
+fi
+if [ -d usr/sbin ]; then
+ find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst
+fi
+touch doclist.lst
+if [ -d usr/share/man ]; then
+ find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst
+fi
+popd
+mv %{buildroot}/filelist.lst .
+mv %{buildroot}/doclist.lst .
+
+%files -n python3-django-multitenant -f filelist.lst
+%dir %{python3_sitelib}/*
+
+%files help -f doclist.lst
+%{_docdir}/*
+
+%changelog
+* Fri May 05 2023 Python_Bot <Python_Bot@openeuler.org> - 3.2.1-1
+- Package Spec generated
diff --git a/sources b/sources
new file mode 100644
index 0000000..09b6985
--- /dev/null
+++ b/sources
@@ -0,0 +1 @@
+c9b634574998fbf86f9a29b8a3f6b240 django-multitenant-3.2.1.tar.gz