Class DatabaseMigrationCommandDescriptor
Namespace: Cephalon.Abstractions.Data
Assembly: Cephalon.Abstractions.dll
Describes one operator-facing command template for executing a database-migration target.
public sealed class DatabaseMigrationCommandDescriptorInheritance
Section titled “Inheritance”object ← DatabaseMigrationCommandDescriptor
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”DatabaseMigrationCommandDescriptor(string, string, string, string, bool, IReadOnlyDictionary<string, string>?, string?, string?, string?)
Section titled “ DatabaseMigrationCommandDescriptor(string, string, string, string, bool, IReadOnlyDictionary<string, string>?, string?, string?, string?)”Creates a new database-migration command descriptor.
public DatabaseMigrationCommandDescriptor(string id, string displayName, string description, string commandTemplate, bool recommendedForProduction = false, IReadOnlyDictionary<string, string>? metadata = null, string? toolId = null, string? executionCategory = null, string? workingDirectoryHint = null)Parameters
Section titled “Parameters”id string
The stable command identifier such as bundle, script, or update.
displayName string
The operator-facing command name.
description string
The human-readable command description.
commandTemplate string
The command template that operators can adapt for their environment.
recommendedForProduction bool
Whether this command is recommended for production use.
metadata IReadOnlyDictionary<string, string>?
Optional operator-facing metadata associated with the command.
toolId string?
An optional stable tool identifier such as dotnet-ef.
executionCategory string?
An optional execution category such as deploy-time or manual.
workingDirectoryHint string?
An optional working-directory hint for where the command is typically run.
Properties
Section titled “Properties”CommandTemplate
Section titled “ CommandTemplate”Gets the command template that operators can adapt for their environment.
public string CommandTemplate { get; }Property Value
Section titled “Property Value”Description
Section titled “ Description”Gets the human-readable command description.
public string Description { get; }Property Value
Section titled “Property Value”DisplayName
Section titled “ DisplayName”Gets the operator-facing command name.
public string DisplayName { get; }Property Value
Section titled “Property Value”ExecutionCategory
Section titled “ ExecutionCategory”Gets the execution category when the provider can distinguish deploy-time, manual, or other command paths.
public string? ExecutionCategory { get; }Property Value
Section titled “Property Value”Gets the stable command identifier.
public string Id { get; }Property Value
Section titled “Property Value”Metadata
Section titled “ Metadata”Gets optional operator-facing metadata associated with the command.
public IReadOnlyDictionary<string, string> Metadata { get; }Property Value
Section titled “Property Value”IReadOnlyDictionary<string, string>
RecommendedForProduction
Section titled “ RecommendedForProduction”Gets a value indicating whether this command is recommended for production use.
public bool RecommendedForProduction { get; }Property Value
Section titled “Property Value”ToolId
Section titled “ ToolId”Gets the stable operator tool identifier when the provider can name one.
public string? ToolId { get; }Property Value
Section titled “Property Value”WorkingDirectoryHint
Section titled “ WorkingDirectoryHint”Gets the provider-published working-directory hint when one is known.
public string? WorkingDirectoryHint { get; }