TenantConnectionStringProvider<TKey> class

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

The default ITenantConnectionStringProvider<TKey>: calls the configured delegates on every call, without caching.

Public so that other providers (for example a caching one) can wrap it. UseConnectionStrings registers it as a singleton, and forwards ITenantConnectionStringProvider<TKey> to it.

public sealed class TenantConnectionStringProvider<TKey> : ITenantConnectionStringProvider<TKey> where TKey : IEquatable<TKey>, IParsable<TKey>

Type parametersCopy Anchor Link

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

Implements ITenantConnectionStringProvider<TKey>.

ConstructorsCopy Anchor Link

TenantConnectionStringProvider(TenantConnectionStringOptions<TKey>)Copy Anchor Link

The default ITenantConnectionStringProvider<TKey>: calls the configured delegates on every call, without caching.

public TenantConnectionStringProvider(TenantConnectionStringOptions<TKey> options)

Parameters:

• options TenantConnectionStringOptions<TKey>: The delegates that return a tenant's connection string.

Public so that other providers (for example a caching one) can wrap it. UseConnectionStrings registers it as a singleton, and forwards ITenantConnectionStringProvider<TKey> to it.

MethodsCopy Anchor Link

Get(ITenantDescriptor<TKey>)Copy Anchor Link

Returns tenant's connection string.

public 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.

public 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.