Skip to content

Admin

django_db_tenants.admin registers Client in the Django admin, with its domains inline. Use it on a control host: Client lives in the shared database.

Client admin

Feature Detail
List columns name, slug, status, database strategy, database name, last update
Filters status, database strategy
Search name, slug, domain
Sections general (name, slug, status), Database (strategy select, database name, db_params as JSON), Timestamps (collapsed, read-only)
Slug editable on creation, read-only afterwards
Secrets db_params, with the database password and any other secret the strategy keeps there, is shown decrypted in a JSON text area
Domains ClientDomain tabular inline, one empty row
Action Provision database (create + migrate + activate): runs provision() for each selected client and reports success or the error per client

Secrets in the page source

The change form contains the decrypted db_params (including database passwords) in its HTML. Give the change_client permission only to people allowed to see tenant credentials.

The form validates with Client.clean(), so reserved slugs and db_params the strategy refuses are rejected. The strategy select lists the registered strategies only.

django_db_tenants.admin

ClientForm

Bases: ModelForm

Meta

model class-attribute instance-attribute 
model = Client
fields class-attribute instance-attribute 
fields = '__all__'

ClientDomainInline

Bases: TabularInline

model class-attribute instance-attribute 

model = ClientDomain

extra class-attribute instance-attribute 

extra = 1

ClientAdmin

Bases: ModelAdmin

form class-attribute instance-attribute 

form = ClientForm

inlines class-attribute instance-attribute 

inlines = [ClientDomainInline]

list_display class-attribute instance-attribute 

list_display = (
    "name",
    "slug",
    "status",
    "db_strategy",
    "db_name",
    "updated_at",
)

list_filter class-attribute instance-attribute 

list_filter = ('status', 'db_strategy')

search_fields class-attribute instance-attribute 

search_fields = ('name', 'slug', 'domains__domain')

readonly_fields class-attribute instance-attribute 

readonly_fields = ('created_at', 'updated_at')

actions class-attribute instance-attribute 

actions = ['provision_selected']

fieldsets class-attribute instance-attribute 

fieldsets = (
    (None, {"fields": ("name", "slug", "status")}),
    (
        "Database",
        {"fields": ("db_strategy", "db_name", "db_params")},
    ),
    (
        "Timestamps",
        {
            "fields": ("created_at", "updated_at"),
            "classes": ("collapse",),
        },
    ),
)

get_readonly_fields 

get_readonly_fields(request, obj=None)

provision_selected 

provision_selected(request, queryset)