ITenantProvisioner<TKey> interface

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

Provisions a new tenant: runs every ITenantProvisioningStep<TKey> for it, in order, and reports each step's outcome. UsePro registers it, as a singleton.

The steps run in this order: creating the tenant's database or schema (AddDatabaseProvisioning, AddSchemaProvisioning), applying migrations (AddMigrations), then the steps and seeders added with IProBuilder<TKey>.AddProvisioningStep<TStep> and IProBuilder<TKey>.AddSeeder<TSeeder>, in the order they were added. With none registered, provisioning succeeds and does nothing.

It does not add the tenant to your store: add it first, then pass its descriptor. To recover from a failure, provision the tenant again, which runs every step again, so steps and seeders must be idempotent.

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

Type parametersCopy Anchor Link

• TKey: The tenant identifier type.

MethodsCopy Anchor Link

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

Runs the provisioning steps for tenant.

Task<TenantProvisioningResult<TKey>> ProvisionAsync(ITenantDescriptor<TKey> tenant, CancellationToken cancellationToken = default)

Parameters:

• tenant ITenantDescriptor<TKey>: The tenant to provision, already in the tenant store.
• cancellationToken CancellationToken: Cancels provisioning.

Returns: Task<TenantProvisioningResult<TKey>>: Each step's outcome. A step that throws is reported in the result, not thrown; by default the steps after it do not run (TenantProvisioningOptions.StopOnFailure).

Exceptions:

• ArgumentNullException: tenant is null.
• ArgumentException: The tenant's id is one Tenantry reserves for "no tenant": the key type's default (Guid.Empty, 0) or an empty string. No step runs.
• LicenseRequiredException: The licence key is missing or invalid. No step runs.
• InvalidOperationException: In mixed mode, MixedModeOptions<TKey>.GetIsolation returned a value that is not a TenantIsolation. No step runs. An exception GetIsolation throws is not caught either.
• OperationCanceledException: cancellationToken was cancelled. Provisioning stops: no further step starts, and steps that completed are not undone. A step that fails after the cancellation, in whatever way, is reported this way too, with its exception as the inner exception.