TenantMigrationRunnerExtensions class

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

Shorter forms of ITenantMigrationRunner<TKey>'s runs and reads: every tenant, or one.

public static class TenantMigrationRunnerExtensions

MethodsCopy Anchor Link

GetTenantStatusAsync<TKey>(ITenantMigrationRunner<TKey>, TKey, CancellationToken)Copy Anchor Link

Reads, for one tenant, which of each context's migrations are applied and which are pending.

[RequiresDynamicCode("EF Core migrations use dynamic code generation and are not Native AOT-compatible. Use a migration bundle for AOT applications.")]
[RequiresUnreferencedCode("EF Core migrations use reflection and are not trim-safe. Use a migration bundle for trimmed applications.")]
public static Task<IReadOnlyList<MigrationStatusEntry<TKey>>> GetTenantStatusAsync<TKey>(this ITenantMigrationRunner<TKey> runner, TKey tenantId, CancellationToken cancellationToken = default) where TKey : IEquatable<TKey>, IParsable<TKey>

Type parameters:

• TKey: The tenant identifier type.

Parameters:

• runner ITenantMigrationRunner<TKey>: The runner.
• tenantId TKey: The tenant to read.
• cancellationToken CancellationToken: Cancels the read.

Returns: Task<IReadOnlyList<MigrationStatusEntry<TKey>>>: An entry for each context; one that cannot be read has MigrationStatusEntry<TKey>.Error set.

Exceptions:

• ArgumentNullException: runner or tenantId is null.
• ArgumentException: tenantId is one Tenantry reserves for "no tenant": the key type's default (Guid.Empty, 0) or an empty string.
• TenantNotFoundException: The tenant store has no tenant tenantId.
• OperationCanceledException: cancellationToken was cancelled.

MigrateAllAsync<TKey>(ITenantMigrationRunner<TKey>, IProgress<MigrationResult<TKey>>?, CancellationToken)Copy Anchor Link

Applies each context's pending migrations for every tenant in the store, reporting each database's or schema's result as it completes, as ITenantMigrationRunner<TKey>.MigrateAsync describes.

[RequiresDynamicCode("EF Core migrations use dynamic code generation and are not Native AOT-compatible. Use a migration bundle for AOT applications.")]
[RequiresUnreferencedCode("EF Core migrations use reflection and are not trim-safe. Use a migration bundle for trimmed applications.")]
public static Task<MigrationReport<TKey>> MigrateAllAsync<TKey>(this ITenantMigrationRunner<TKey> runner, IProgress<MigrationResult<TKey>>? progress, CancellationToken cancellationToken = default) where TKey : IEquatable<TKey>, IParsable<TKey>

Type parameters:

• TKey: The tenant identifier type.

Parameters:

• runner ITenantMigrationRunner<TKey>: The runner.
• progress IProgress<MigrationResult<TKey>>: Gets each result as it completes.
• cancellationToken CancellationToken: Stops the run: the migrations in progress are abandoned and no other is started; those already migrated stay migrated.

Returns: Task<MigrationReport<TKey>>: A result for each context and database or schema.

Exceptions:

• ArgumentNullException: runner is null.
• LicenseRequiredException: The licence key is missing or invalid; nothing was migrated.
• OperationCanceledException: cancellationToken was cancelled.

MigrateAllAsync<TKey>(ITenantMigrationRunner<TKey>, CancellationToken)Copy Anchor Link

Applies each context's pending migrations for every tenant in the store.

[RequiresDynamicCode("EF Core migrations use dynamic code generation and are not Native AOT-compatible. Use a migration bundle for AOT applications.")]
[RequiresUnreferencedCode("EF Core migrations use reflection and are not trim-safe. Use a migration bundle for trimmed applications.")]
public static Task<MigrationReport<TKey>> MigrateAllAsync<TKey>(this ITenantMigrationRunner<TKey> runner, CancellationToken cancellationToken = default) where TKey : IEquatable<TKey>, IParsable<TKey>

Type parameters:

• TKey: The tenant identifier type.

Parameters:

• runner ITenantMigrationRunner<TKey>: The runner.
• cancellationToken CancellationToken: Stops the run: the migrations in progress are abandoned and no other is started; those already migrated stay migrated.

Returns: Task<MigrationReport<TKey>>: A result for each context and database or schema.

Exceptions:

• ArgumentNullException: runner is null.
• LicenseRequiredException: The licence key is missing or invalid; nothing was migrated.
• OperationCanceledException: cancellationToken was cancelled.

MigrateTenantAsync<TKey>(ITenantMigrationRunner<TKey>, TKey, CancellationToken)Copy Anchor Link

Applies each context's pending migrations for one tenant: ITenantMigrationRunner<TKey>.MigrateAsync with MigrationRunOptions<TKey>.Tenants set to it alone.

[RequiresDynamicCode("EF Core migrations use dynamic code generation and are not Native AOT-compatible. Use a migration bundle for AOT applications.")]
[RequiresUnreferencedCode("EF Core migrations use reflection and are not trim-safe. Use a migration bundle for trimmed applications.")]
public static Task<MigrationReport<TKey>> MigrateTenantAsync<TKey>(this ITenantMigrationRunner<TKey> runner, TKey tenantId, CancellationToken cancellationToken = default) where TKey : IEquatable<TKey>, IParsable<TKey>

Type parameters:

• TKey: The tenant identifier type.

Parameters:

• runner ITenantMigrationRunner<TKey>: The runner.
• tenantId TKey: The tenant to migrate.
• cancellationToken CancellationToken: Stops the run: the migrations in progress are abandoned and no other is started; those already migrated stay migrated.

Returns: Task<MigrationReport<TKey>>: A result for each context. In a database or schema the tenant shares, the result names every tenant it migrated.

Exceptions:

• ArgumentNullException: runner or tenantId is null.
• ArgumentException: tenantId is one Tenantry reserves for "no tenant": the key type's default (Guid.Empty, 0) or an empty string.
• LicenseRequiredException: The licence key is missing or invalid; nothing was migrated.
• TenantNotFoundException: The tenant store has no tenant tenantId.
• OperationCanceledException: cancellationToken was cancelled.