Documentation / @zerotal/tenancy / TenantManager
Class: TenantManager
Defined in: tenancy/src/TenantManager.ts:30
Constructors
Constructor
new TenantManager(
opts):TenantManager
Defined in: tenancy/src/TenantManager.ts:34
Parameters
opts
Returns
TenantManager
Methods
connection()
connection():
SQLInstance
Defined in: tenancy/src/TenantManager.ts:42
Return the database connection for the currently active tenant. Throws if called outside a TenantContext boundary.
Returns
connectionFor()
connectionFor(
tenant):SQLInstance
Defined in: tenancy/src/TenantManager.ts:51
Return the database connection for a specific tenant without requiring an active TenantContext. Useful in background jobs that iterate tenants.
Parameters
tenant
Returns
warmUp()
warmUp(
tenant):void
Defined in: tenancy/src/TenantManager.ts:59
Pre-open the connection for a tenant so the first request is instant. Safe to call at boot time before any requests arrive.
Parameters
tenant
Returns
void
evict()
evict(
tenant):void
Defined in: tenancy/src/TenantManager.ts:64
Close and evict a tenant's connection (e.g. after a tenant is deleted).
Parameters
tenant
Tenant
Returns
void
closeAll()
closeAll():
void
Defined in: tenancy/src/TenantManager.ts:71
Close all open connections.
Returns
void