ITenantConnectionStringProvider<TKey> interface

Namespace: Tenantry · Package: Tenantry.Core · API reference

Returns a tenant's connection string, as configured by TenantConnectionStringOptions<TKey>.

Registered as a singleton by UseConnectionStrings. It takes the tenant explicitly, for code such as migration runners that visits tenants without making each one current. For the current tenant's connection string, use CurrentTenantConnectionString<TKey>.

Implement it to decorate the default TenantConnectionStringProvider<TKey>, for example to cache.

public interface ITenantConnectionStringProvider<TKey> where TKey : IEquatable<TKey>, IParsable<TKey>

Type parametersCopy Anchor Link

• TKey: The tenant identifier type. See ITenantDescriptor<TKey> for constraints.

Derived types: TenantConnectionStringProvider<TKey>.

MethodsCopy Anchor Link

Get(ITenantDescriptor<TKey>)Copy Anchor Link

Returns tenant's connection string.

string Get(ITenantDescriptor<TKey> tenant)

Parameters:

• tenant ITenantDescriptor<TKey>: The tenant whose connection string to return.

Returns: string

Exceptions:

• InvalidOperationException: Only TenantConnectionStringOptions<TKey>.GetConnectionStringAsync is configured (use ITenantConnectionStringProvider<TKey>.GetAsync), or the delegate returned an empty value.

GetAsync(ITenantDescriptor<TKey>, CancellationToken)Copy Anchor Link

Returns tenant's connection string, using the asynchronous delegate if configured.

ValueTask<string> GetAsync(ITenantDescriptor<TKey> tenant, CancellationToken cancellationToken = default)

Parameters:

• tenant ITenantDescriptor<TKey>: The tenant whose connection string to return.
• cancellationToken CancellationToken: Cancels the lookup.

Returns: ValueTask<string>

Exceptions:

• InvalidOperationException: The delegate returned an empty value.