SchemaPerTenantOptions<TKey> class
Namespace: Tenantry.Pro.EfCore · Package: Tenantry.Pro.EfCore · API reference
Schema per tenant: each tenant's tables in a schema of its own, in a shared database. Set with pro.UseSchemaPerTenant(o => o.GetSchemaName = …).
EF Core compiles a model for each schema, and compiles each query again for each schema's model. Its own cache holds the models of about 40 schemas (about 100 on EF Core 8), or about 500 compiled queries, in all; past that, it evicts them and compiles them again as tenants take turns. So each context type gets a cache of its own, sized for SchemaPerTenantOptions<TKey>.MaxCachedSchemas schemas with SchemaPerTenantOptions<TKey>.MaxCompiledQueriesPerSchema queries each, on top of EF Core's default.
Each cached schema holds a compiled model and its compiled queries in memory, so with a large model and many schemas, weigh the limits against your memory budget. Past them, the least recently used entries are compiled again when next needed.
public sealed class SchemaPerTenantOptions<TKey> where TKey : IEquatable<TKey>, IParsable<TKey>Type parameters
TKey: The tenant identifier type.
Properties
GetSchemaName
Returns the name of a tenant's schema. Required. It is called often, so it must be fast, and it must give the same name for a tenant each time; tenants given the same name share a schema. In mixed mode it is called only for TenantIsolation.Schema tenants.
public Func<ITenantDescriptor<TKey>, string>? GetSchemaName { get; set; }Value: Func<ITenantDescriptor<TKey>, string>
o.GetSchemaName = tenant => $"tenant_{tenant.TenantId}";MaxCachedSchemas
How many schemas' models each DbContext type keeps compiled: at least the number of tenant schemas in use at once. Defaults to 500; must be greater than zero.
public int MaxCachedSchemas { get; set; }Value: int
MaxCompiledQueriesPerSchema
How many compiled queries the cache has room for per schema: about the number of distinct queries your application runs against the context. Defaults to 100; must not be negative.
public int MaxCompiledQueriesPerSchema { get; set; }Value: int
MigrationStatusEntry<TKey> class
Which of a context's migrations a database or schema has applied, and which are pending: the database or schema the context connects to for the tenants in MigrationStatusEntry<TKey>.TenantIdstenantry-pro-efcore-migrationstatusentry.md.
SchemaProvisioningOptions<TContext> class
How tenant provisioning creates each tenant's schema.