Router¶

TenantRouter sends the models of shared apps to the shared database and every other model to the active tenant's database.

DATABASE_ROUTERS = ["django_db_tenants.router.TenantRouter"]

Decisions¶

Method	Shared app	Other app
`db_for_read`, `db_for_write`	`TEMPLATE_ALIAS`	active tenant alias, else `TEMPLATE_ALIAS`
`allow_migrate(db, ...)`	only on `TEMPLATE_ALIAS`	on tenant aliases; on `TEMPLATE_ALIAS` when `TENANT_APPS_ON_DEFAULT`
`allow_relation(obj1, obj2)`	`False` when both objects are saved in different databases, otherwise `None` (no opinion)	same

Add other routers after this one only for aliases it does not know about: Django uses the first router that returns a non-None answer, and TenantRouter always answers db_for_read, db_for_write and allow_migrate.

See Architecture for the consequences on foreign keys.

django_db_tenants.router ¶

Database router: shared apps -> template DB, everything else -> current tenant.

TenantRouter ¶

db_for_read ¶

db_for_read(model, **hints)

db_for_write ¶

db_for_write(model, **hints)

allow_relation ¶

allow_relation(obj1, obj2, **hints)

allow_migrate ¶

allow_migrate(db, app_label, model_name=None, **hints)