TenantryProBuilderExtensions class

Namespace: Microsoft.Extensions.DependencyInjection · Package: Tenantry.Pro · API reference

Extension methods for configuring Tenantry.Pro's features on IProBuilder<TKey>.

public static class TenantryProBuilderExtensions

MethodsCopy Anchor Link

CacheConnectionStrings<TKey>(IProBuilder<TKey>, Action<ConnectionStringCacheOptions>?)Copy Anchor Link

Caches each tenant's connection string, so the connection-string delegates run once per tenant per ConnectionStringCacheOptions.Duration instead of for every context. Use it when the delegate is slow, such as one that reads a secrets store.

public static IProBuilder<TKey> CacheConnectionStrings<TKey>(this IProBuilder<TKey> pro, Action<ConnectionStringCacheOptions>? configure = null) where TKey : IEquatable<TKey>, IParsable<TKey>

Type parameters:

• TKey: The tenant identifier type.

Parameters:

• pro IProBuilder<TKey>: The Pro builder.
• configure Action<ConnectionStringCacheOptions>: Sets how long a connection string is cached (30 minutes by default).

Returns: IProBuilder<TKey>: The same pro for chaining.

It wraps the tenants' ITenantConnectionStringProvider<TKey>, from UseConnectionStrings in the same AddTenantry, called before or after UsePro, or a provider of your own registered before UsePro. Everything that reads connection strings through it is then cached: AddDbContextPerTenantDatabase, CurrentTenantConnectionString<TKey>, migrations and health checks. Inject IConnectionStringCache<TKey> to remove a tenant's cached connection string when it changes.

The application fails to start if there are no connection strings to cache. A provider registered after UsePro that does not wrap the cache takes its place, and a warning says so at startup. Calling it again only applies configure.

builder.Services.AddTenantry<string>(tenant => tenant
    .UseStore<MyTenantStore>()
    .UseConnectionStrings(o => o.GetConnectionStringAsync = (t, ct) => secrets.GetAsync($"db-{t.TenantId}", ct))
    .UsePro(pro => pro.CacheConnectionStrings(o => o.Duration = TimeSpan.FromMinutes(10))));

ConfigureProvisioning<TKey>(IProBuilder<TKey>, Action<TenantProvisioningOptions>)Copy Anchor Link

Sets how ITenantProvisioner<TKey> runs the provisioning steps.

public static IProBuilder<TKey> ConfigureProvisioning<TKey>(this IProBuilder<TKey> pro, Action<TenantProvisioningOptions> configure) where TKey : IEquatable<TKey>, IParsable<TKey>

Type parameters:

• TKey: The tenant identifier type.

Parameters:

• pro IProBuilder<TKey>: The Pro builder.
• configure Action<TenantProvisioningOptions>: Sets the options.

Returns: IProBuilder<TKey>: The same pro for chaining.

UseLicenseKey<TKey>(IProBuilder<TKey>, string)Copy Anchor Link

Sets the licence key, in place of the Tenantry:License setting.

public static IProBuilder<TKey> UseLicenseKey<TKey>(this IProBuilder<TKey> pro, string key) where TKey : IEquatable<TKey>, IParsable<TKey>

Type parameters:

• TKey: The tenant identifier type.

Parameters:

• pro IProBuilder<TKey>: The Pro builder.
• key string: The licence key issued by Tenantry, from tenantry.dev/dashboard/pro. It does not expire. A missing or invalid key stops the application from starting (LicenseRequiredException).

Returns: IProBuilder<TKey>: The same pro for chaining.

Exceptions:

• ArgumentException: key is empty or white space.

Without it, the key is read from configuration when the application starts, so it can come from any configuration source, including the Tenantry__License environment variable. Use this when the key comes from somewhere else.

UseMixedMode<TKey>(IProBuilder<TKey>, Action<MixedModeOptions<TKey>>)Copy Anchor Link

Turns on mixed mode: tenants with different isolation in one application, some on their own database, some on their own schema, and some sharing tables. configure says which tenant is which.

public static IProBuilder<TKey> UseMixedMode<TKey>(this IProBuilder<TKey> pro, Action<MixedModeOptions<TKey>> configure) where TKey : IEquatable<TKey>, IParsable<TKey>

Type parameters:

• TKey: The tenant identifier type.

Parameters:

• pro IProBuilder<TKey>: The Pro builder.
• configure Action<MixedModeOptions<TKey>>: Sets MixedModeOptions<TKey>.GetIsolation.

Returns: IProBuilder<TKey>: The same pro for chaining.

Exceptions:

• InvalidOperationException: configure does not set GetIsolation.

Provisioning steps see each tenant's isolation (TenantProvisioningContext<TKey>.Isolation): creating a database applies only to TenantIsolation.Database tenants, creating a schema only to TenantIsolation.Schema tenants, and migrations to both (the shared database is migrated with the other tenants, by Tenantry.Pro.EfCore's migration runner). Each tenant's connection string comes from your UseConnectionStrings delegate, which returns the shared database's for tenants without their own. Tenantry.Pro.EfCore's UseSchemaPerTenant gives only TenantIsolation.Schema tenants a schema of their own.