Class DatabaseMigrationOperationalStep
Namespace: Cephalon.Abstractions.Data
Assembly: Cephalon.Abstractions.dll
Describes one ordered operator step in the engine-owned database-migration playbook.
public sealed class DatabaseMigrationOperationalStepInheritance
Section titled “Inheritance”object ← DatabaseMigrationOperationalStep
Inherited Members
Section titled “Inherited Members”object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.ReferenceEquals(object?, object?), object.ToString()
Constructors
Section titled “Constructors”DatabaseMigrationOperationalStep(int, string, string, string, DatabaseMigrationStatus, string, bool, string?, string?, IReadOnlyList<string>?, string?, DatabaseMigrationCommandDescriptor?, DatabaseMigrationCommandDescriptor?)
Section titled “ DatabaseMigrationOperationalStep(int, string, string, string, DatabaseMigrationStatus, string, bool, string?, string?, IReadOnlyList<string>?, string?, DatabaseMigrationCommandDescriptor?, DatabaseMigrationCommandDescriptor?)”Creates a new database-migration operational step.
public DatabaseMigrationOperationalStep(int order, string databaseMigrationId, string requestedRoleId, string resolvedRoleId, DatabaseMigrationStatus status, string executionMode, bool applyOnStartup, string? physicalTargetId = null, string? physicalTargetDisplayName = null, IReadOnlyList<string>? coordinatedMigrationIds = null, string? coordinationHint = null, DatabaseMigrationCommandDescriptor? productionCommand = null, DatabaseMigrationCommandDescriptor? manualCommand = null)Parameters
Section titled “Parameters”order int
The positive playbook order for this step.
databaseMigrationId string
The logical database-migration target identifier for this step.
requestedRoleId string
The logical database role requested by migration policy.
resolvedRoleId string
The concrete database role that backs this step.
status DatabaseMigrationStatus
The current execution status for this step.
executionMode string
The execution mode such as startup-hosted-service or manual-or-deploy-time.
applyOnStartup bool
Whether startup execution is enabled for this step.
physicalTargetId string?
The stable physical-target identifier that backs this step when known.
physicalTargetDisplayName string?
The operator-facing description of the physical target that backs this step when known.
coordinatedMigrationIds IReadOnlyList<string>?
Other logical migration targets that share the same physical database target.
coordinationHint string?
The operator-facing coordination guidance for shared physical targets, when available.
productionCommand DatabaseMigrationCommandDescriptor?
The primary production-recommended command selected for this step when available.
manualCommand DatabaseMigrationCommandDescriptor?
The primary direct or manual command selected for this step when available.
Properties
Section titled “Properties”ApplyOnStartup
Section titled “ ApplyOnStartup”Gets a value indicating whether startup execution is enabled for this step.
public bool ApplyOnStartup { get; }Property Value
Section titled “Property Value”CoordinatedMigrationIds
Section titled “ CoordinatedMigrationIds”Gets the other logical migration targets that share the same physical database target.
public IReadOnlyList<string> CoordinatedMigrationIds { get; }Property Value
Section titled “Property Value”CoordinationHint
Section titled “ CoordinationHint”Gets the operator-facing coordination guidance for shared physical targets, when available.
public string? CoordinationHint { get; }Property Value
Section titled “Property Value”DatabaseMigrationId
Section titled “ DatabaseMigrationId”Gets the logical database-migration target identifier for this step.
public string DatabaseMigrationId { get; }Property Value
Section titled “Property Value”ExecutionMode
Section titled “ ExecutionMode”Gets the execution mode for this step.
public string ExecutionMode { get; }Property Value
Section titled “Property Value”HasProductionRecommendedCommand
Section titled “ HasProductionRecommendedCommand”Gets a value indicating whether this step publishes a production-recommended command.
public bool HasProductionRecommendedCommand { get; }Property Value
Section titled “Property Value”ManualCommand
Section titled “ ManualCommand”Gets the primary direct or manual command selected for this step when available.
public DatabaseMigrationCommandDescriptor? ManualCommand { get; }Property Value
Section titled “Property Value”DatabaseMigrationCommandDescriptor?
Gets the positive playbook order for this step.
public int Order { get; }Property Value
Section titled “Property Value”PhysicalTargetDisplayName
Section titled “ PhysicalTargetDisplayName”Gets the operator-facing description of the physical target that backs this step when known.
public string? PhysicalTargetDisplayName { get; }Property Value
Section titled “Property Value”PhysicalTargetId
Section titled “ PhysicalTargetId”Gets the stable physical-target identifier that backs this step when known.
public string? PhysicalTargetId { get; }Property Value
Section titled “Property Value”ProductionCommand
Section titled “ ProductionCommand”Gets the primary production-recommended command selected for this step when available.
public DatabaseMigrationCommandDescriptor? ProductionCommand { get; }Property Value
Section titled “Property Value”DatabaseMigrationCommandDescriptor?
RequestedRoleId
Section titled “ RequestedRoleId”Gets the logical database role requested by migration policy.
public string RequestedRoleId { get; }Property Value
Section titled “Property Value”RequiresPhysicalTargetCoordination
Section titled “ RequiresPhysicalTargetCoordination”Gets a value indicating whether this step needs shared-physical-target coordination.
public bool RequiresPhysicalTargetCoordination { get; }Property Value
Section titled “Property Value”ResolvedRoleId
Section titled “ ResolvedRoleId”Gets the concrete database role that backs this step.
public string ResolvedRoleId { get; }Property Value
Section titled “Property Value”Status
Section titled “ Status”Gets the current execution status for this step.
public DatabaseMigrationStatus Status { get; }