TenantConnectionStringResolver<TKey> class

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

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

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

public sealed class TenantConnectionStringResolver<TKey> : ITenantConnectionStringResolver<TKey> where TKey : IEquatable<TKey>, IParsable<TKey>

Type parametersCopy Anchor Link

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

Implements ITenantConnectionStringResolver<TKey>.

ConstructorsCopy Anchor Link

TenantConnectionStringResolver(ITenantContext<TKey>, TenantConnectionStringOptions<TKey>)Copy Anchor Link

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

public TenantConnectionStringResolver(ITenantContext<TKey> tenantContext, TenantConnectionStringOptions<TKey> options)

Parameters:

• tenantContext ITenantContext<TKey>: Supplies the current tenant.
• options TenantConnectionStringOptions<TKey>: The delegates that return a tenant's connection string.

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

MethodsCopy Anchor Link

Resolve()Copy Anchor Link

Returns the current tenant's connection string.

public string Resolve()

Returns: string

Exceptions:

• TenantNotResolvedException: No tenant is current.
• InvalidOperationException: Only TenantConnectionStringOptions<TKey>.GetConnectionStringAsync is configured (use ITenantConnectionStringResolver<TKey>.ResolveAsync), or the delegate returned an empty value.

Resolve(ITenantDescriptor<TKey>)Copy Anchor Link

Returns tenant's connection string.

public string Resolve(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 ITenantConnectionStringResolver<TKey>.ResolveAsync), or the delegate returned an empty value.

ResolveAsync(CancellationToken)Copy Anchor Link

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

public ValueTask<string> ResolveAsync(CancellationToken cancellationToken = default)

Parameters:

• cancellationToken CancellationToken: Cancels the lookup.

Returns: ValueTask<string>

Exceptions:

• TenantNotResolvedException: No tenant is current.
• InvalidOperationException: The delegate returned an empty value.

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

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

public ValueTask<string> ResolveAsync(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.