Docs
Tenantry ProAPI reference

MigrationResult<TKey> class

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

The outcome of running EF Core migrations against a single tenant's database.

public sealed record MigrationResult<TKey> : IEquatable<MigrationResult<TKey>>

Type parameters

  • TKey: The tenant identifier type.

Implements IEquatable<MigrationResult<TKey>>.

Properties

AppliedMigrations

The migrations that were applied during this run. Empty when the database was already up to date or when the migration failed.

public required IReadOnlyList<string> AppliedMigrations { get; init; }

Value: IReadOnlyList<string>

Duration

Wall-clock time taken to run migrations for this tenant.

public required TimeSpan Duration { get; init; }

Value: TimeSpan

Error

The exception that caused migration to fail, or null if successful.

public Exception? Error { get; init; }

Value: Exception

Succeeded

True if migrations completed without error.

public required bool Succeeded { get; init; }

Value: bool

TenantId

The tenant whose database was targeted.

public required TKey TenantId { get; init; }

Value: TKey

On this page