SqlServerMigrationsSqlGenerator Class

Definition

Namespace:

Microsoft.EntityFrameworkCore.Migrations

Assembly:

Microsoft.EntityFrameworkCore.SqlServer.dll

Package:

Microsoft.EntityFrameworkCore.SqlServer v8.0.0

SQL Server-specific implementation of MigrationsSqlGenerator.

public class SqlServerMigrationsSqlGenerator : Microsoft.EntityFrameworkCore.Migrations.MigrationsSqlGenerator

type SqlServerMigrationsSqlGenerator = class
    inherit MigrationsSqlGenerator

Public Class SqlServerMigrationsSqlGenerator
Inherits MigrationsSqlGenerator

Inheritance

Object

MigrationsSqlGenerator

SqlServerMigrationsSqlGenerator

Remarks

The service lifetime is Scoped. This means that each DbContext instance will use its own instance of this service. The implementation may depend on other services registered with any lifetime. The implementation does not need to be thread-safe.

See Database migrations, and Accessing SQL Server and Azure SQL databases with EF Core for more information and examples.

Constructors

SqlServerMigrationsSqlGenerator(MigrationsSqlGeneratorDependencies, ICommandBatchPreparer)

Creates a new SqlServerMigrationsSqlGenerator instance.

Properties

Annotations	(Inherited from MigrationsSqlGenerator)
Dependencies	Relational provider-specific dependencies for this service. (Inherited from MigrationsSqlGenerator)
Options	Gets or sets the options to use when generating commands. (Inherited from MigrationsSqlGenerator)
SqlGenerationHelper	(Inherited from MigrationsSqlGenerator)
SqlGenerator	The IUpdateSqlGenerator. (Inherited from MigrationsSqlGenerator)
TypeMapper	(Inherited from MigrationsSqlGenerator)
VersionComparer	Gets a comparer that can be used to compare two product versions. (Inherited from MigrationsSqlGenerator)

Methods

AddDescription(MigrationCommandListBuilder, String, String, String, String, Boolean)	Generates add commands for descriptions on tables and columns.
CheckConstraint(AddCheckConstraintOperation, IModel, MigrationCommandListBuilder)	Generates a SQL fragment for a check constraint of an AddCheckConstraintOperation. (Inherited from MigrationsSqlGenerator)
CheckConstraint(CreateCheckConstraintOperation, IModel, MigrationCommandListBuilder)	Generates a SQL fragment for a check constraint of an CreateCheckConstraintOperation. (Inherited from MigrationsSqlGenerator)
ColumnDefinition(AddColumnOperation, IModel, MigrationCommandListBuilder)	Generates a SQL fragment for a column definition in an AddColumnOperation. (Inherited from MigrationsSqlGenerator)
ColumnDefinition(String, String, String, ColumnOperation, IModel, MigrationCommandListBuilder)	Generates a SQL fragment for a column definition for the given column metadata.
ColumnDefinition(String, String, String, Type, String, Nullable<Boolean>, Nullable<Int32>, Boolean, Boolean, Object, String, String, IAnnotatable, IModel, MigrationCommandListBuilder)	Generates a SQL fragment for a column definition for the given column metadata. (Inherited from MigrationsSqlGenerator)
ColumnDefinition(String, String, String, Type, String, Nullable<Boolean>, Nullable<Int32>, Nullable<Boolean>, Boolean, Boolean, Object, String, String, IAnnotatable, IModel, MigrationCommandListBuilder)	Generates a SQL fragment for a column definition for the given column metadata. (Inherited from MigrationsSqlGenerator)
ColumnList(String[])	Concatenates the given column names into a DelimitIdentifier(String) separated list. (Inherited from MigrationsSqlGenerator)
ComputedColumnDefinition(String, String, String, ColumnOperation, IModel, MigrationCommandListBuilder)	Generates a SQL fragment for a computed column definition for the given column metadata.
CreateIndexes(IEnumerable<ITableIndex>, MigrationCommandListBuilder)	Generates SQL to create the given indexes.
CreateTableCheckConstraints(CreateTableOperation, IModel, MigrationCommandListBuilder)	Generates a SQL fragment for the check constraints of a CreateTableOperation. (Inherited from MigrationsSqlGenerator)
CreateTableColumns(CreateTableOperation, IModel, MigrationCommandListBuilder)	Generates a SQL fragment for the column definitions in a CreateTableOperation. (Inherited from MigrationsSqlGenerator)
CreateTableConstraints(CreateTableOperation, IModel, MigrationCommandListBuilder)	Generates a SQL fragment for the constraints of a CreateTableOperation. (Inherited from MigrationsSqlGenerator)
CreateTableForeignKeys(CreateTableOperation, IModel, MigrationCommandListBuilder)	Generates a SQL fragment for the foreign key constraints of a CreateTableOperation. (Inherited from MigrationsSqlGenerator)
CreateTablePrimaryKeyConstraint(CreateTableOperation, IModel, MigrationCommandListBuilder)	Generates a SQL fragment for the primary key constraint of a CreateTableOperation. (Inherited from MigrationsSqlGenerator)
CreateTableUniqueConstraints(CreateTableOperation, IModel, MigrationCommandListBuilder)	Generates a SQL fragment for the unique constraints of a CreateTableOperation. (Inherited from MigrationsSqlGenerator)
DefaultValue(Object, String, MigrationCommandListBuilder)	Generates a SQL fragment for the default constraint of a column. (Inherited from MigrationsSqlGenerator)
DefaultValue(Object, String, String, MigrationCommandListBuilder)	Generates a SQL fragment for the default constraint of a column. (Inherited from MigrationsSqlGenerator)
DropDefaultConstraint(String, String, String, MigrationCommandListBuilder)	Generates a SQL fragment to drop default constraints for a column.
DropDescription(MigrationCommandListBuilder, String, String, String, Boolean)	Generates drop commands for descriptions on tables and columns.
DropIndexes(IEnumerable<ITableIndex>, MigrationCommandListBuilder)	Generates SQL to drop the given indexes.
EndStatement(MigrationCommandListBuilder, Boolean)	Generates a SQL fragment to terminate the SQL command. (Inherited from MigrationsSqlGenerator)
FindEntityTypes(IModel, String, String)	Finds all IEntityTypes that are mapped to the given table. (Inherited from MigrationsSqlGenerator)
FindProperty(IModel, String, String, String)	Finds some IProperty mapped to the given column. If multiple properties map to the same column, then the property returned is one chosen arbitrarily. The model validator ensures that all properties mapped to a given column have consistent configuration. (Inherited from MigrationsSqlGenerator)
ForeignKeyAction(ReferentialAction, MigrationCommandListBuilder)	Generates a SQL fragment for the given referential action.
ForeignKeyConstraint(AddForeignKeyOperation, IModel, MigrationCommandListBuilder)	Generates a SQL fragment for a foreign key constraint of an AddForeignKeyOperation. (Inherited from MigrationsSqlGenerator)
Generate(AddCheckConstraintOperation, IModel, MigrationCommandListBuilder)	Builds commands for the given AddCheckConstraintOperation by making calls on the given MigrationCommandListBuilder, and then terminates the final command.
Generate(AddColumnOperation, IModel, MigrationCommandListBuilder, Boolean)	Builds commands for the given AddColumnOperation by making calls on the given MigrationCommandListBuilder.
Generate(AddColumnOperation, IModel, MigrationCommandListBuilder)	Builds commands for the given AddColumnOperation by making calls on the given MigrationCommandListBuilder, and then terminates the final command. (Inherited from MigrationsSqlGenerator)
Generate(AddForeignKeyOperation, IModel, MigrationCommandListBuilder, Boolean)	Builds commands for the given AddForeignKeyOperation by making calls on the given MigrationCommandListBuilder.
Generate(AddForeignKeyOperation, IModel, MigrationCommandListBuilder)	Builds commands for the given AddForeignKeyOperation by making calls on the given MigrationCommandListBuilder, and then terminates the final command. (Inherited from MigrationsSqlGenerator)
Generate(AddPrimaryKeyOperation, IModel, MigrationCommandListBuilder, Boolean)	Builds commands for the given AddPrimaryKeyOperation by making calls on the given MigrationCommandListBuilder.
Generate(AddPrimaryKeyOperation, IModel, MigrationCommandListBuilder)	Builds commands for the given AddPrimaryKeyOperation by making calls on the given MigrationCommandListBuilder, and then terminates the final command. (Inherited from MigrationsSqlGenerator)
Generate(AddUniqueConstraintOperation, IModel, MigrationCommandListBuilder)	Builds commands for the given AddUniqueConstraintOperation by making calls on the given MigrationCommandListBuilder, and then terminates the final command. (Inherited from MigrationsSqlGenerator)
Generate(AlterColumnOperation, IModel, MigrationCommandListBuilder)	Builds commands for the given AlterColumnOperation by making calls on the given MigrationCommandListBuilder.
Generate(AlterDatabaseOperation, IModel, MigrationCommandListBuilder)	Builds commands for the given AlterDatabaseOperation by making calls on the given MigrationCommandListBuilder.
Generate(AlterSequenceOperation, IModel, MigrationCommandListBuilder)	Builds commands for the given AlterSequenceOperation by making calls on the given MigrationCommandListBuilder, and then terminates the final command. (Inherited from MigrationsSqlGenerator)
Generate(AlterTableOperation, IModel, MigrationCommandListBuilder)	Builds commands for the given AlterTableOperation by making calls on the given MigrationCommandListBuilder.
Generate(CreateCheckConstraintOperation, IModel, MigrationCommandListBuilder)	Builds commands for the given CreateCheckConstraintOperation by making calls on the given MigrationCommandListBuilder, and then terminates the final command. (Inherited from MigrationsSqlGenerator)
Generate(CreateIndexOperation, IModel, MigrationCommandListBuilder, Boolean)	Builds commands for the given CreateIndexOperation by making calls on the given MigrationCommandListBuilder.
Generate(CreateIndexOperation, IModel, MigrationCommandListBuilder)	Builds commands for the given CreateIndexOperation by making calls on the given MigrationCommandListBuilder, and then terminates the final command. (Inherited from MigrationsSqlGenerator)
Generate(CreateSequenceOperation, IModel, MigrationCommandListBuilder)	Builds commands for the given CreateSequenceOperation by making calls on the given MigrationCommandListBuilder, and then terminates the final command.
Generate(CreateTableOperation, IModel, MigrationCommandListBuilder, Boolean)	Builds commands for the given CreateTableOperation by making calls on the given MigrationCommandListBuilder.
Generate(CreateTableOperation, IModel, MigrationCommandListBuilder)	Builds commands for the given CreateTableOperation by making calls on the given MigrationCommandListBuilder, and then terminates the final command. (Inherited from MigrationsSqlGenerator)
Generate(DeleteDataOperation, IModel, MigrationCommandListBuilder)	Builds commands for the given DeleteDataOperation by making calls on the given MigrationCommandListBuilder, and then terminates the final command.
Generate(DropCheckConstraintOperation, IModel, MigrationCommandListBuilder)	Builds commands for the given DropCheckConstraintOperation by making calls on the given MigrationCommandListBuilder, and then terminates the final command. (Inherited from MigrationsSqlGenerator)
Generate(DropColumnOperation, IModel, MigrationCommandListBuilder, Boolean)	Builds commands for the given DropColumnOperation by making calls on the given MigrationCommandListBuilder.
Generate(DropColumnOperation, IModel, MigrationCommandListBuilder)	Builds commands for the given DropColumnOperation by making calls on the given MigrationCommandListBuilder, and then terminates the final command. (Inherited from MigrationsSqlGenerator)
Generate(DropForeignKeyOperation, IModel, MigrationCommandListBuilder, Boolean)	Builds commands for the given DropForeignKeyOperation by making calls on the given MigrationCommandListBuilder.
Generate(DropForeignKeyOperation, IModel, MigrationCommandListBuilder)	Builds commands for the given DropForeignKeyOperation by making calls on the given MigrationCommandListBuilder, and then terminates the final command. (Inherited from MigrationsSqlGenerator)
Generate(DropIndexOperation, IModel, MigrationCommandListBuilder, Boolean)	Builds commands for the given DropIndexOperation by making calls on the given MigrationCommandListBuilder.
Generate(DropIndexOperation, IModel, MigrationCommandListBuilder)	Can be overridden by database providers to build commands for the given DropIndexOperation by making calls on the given MigrationCommandListBuilder. Note that the default implementation of this method throws NotImplementedException. Providers must override if they are to support this kind of operation. (Inherited from MigrationsSqlGenerator)
Generate(DropPrimaryKeyOperation, IModel, MigrationCommandListBuilder, Boolean)	Builds commands for the given DropPrimaryKeyOperation by making calls on the given MigrationCommandListBuilder.
Generate(DropPrimaryKeyOperation, IModel, MigrationCommandListBuilder)	Builds commands for the given DropPrimaryKeyOperation by making calls on the given MigrationCommandListBuilder, and then terminates the final command. (Inherited from MigrationsSqlGenerator)
Generate(DropSchemaOperation, IModel, MigrationCommandListBuilder)	Builds commands for the given DropSchemaOperation by making calls on the given MigrationCommandListBuilder, and then terminates the final command. (Inherited from MigrationsSqlGenerator)
Generate(DropSequenceOperation, IModel, MigrationCommandListBuilder)	Builds commands for the given DropSequenceOperation by making calls on the given MigrationCommandListBuilder, and then terminates the final command. (Inherited from MigrationsSqlGenerator)
Generate(DropTableOperation, IModel, MigrationCommandListBuilder, Boolean)	Builds commands for the given DropTableOperation by making calls on the given MigrationCommandListBuilder.
Generate(DropTableOperation, IModel, MigrationCommandListBuilder)	Builds commands for the given DropTableOperation by making calls on the given MigrationCommandListBuilder, and then terminates the final command. (Inherited from MigrationsSqlGenerator)
Generate(DropUniqueConstraintOperation, IModel, MigrationCommandListBuilder)	Builds commands for the given DropUniqueConstraintOperation by making calls on the given MigrationCommandListBuilder, and then terminates the final command. (Inherited from MigrationsSqlGenerator)
Generate(EnsureSchemaOperation, IModel, MigrationCommandListBuilder)	Builds commands for the given EnsureSchemaOperation by making calls on the given MigrationCommandListBuilder.
Generate(InsertDataOperation, IModel, MigrationCommandListBuilder, Boolean)	Builds commands for the given InsertDataOperation by making calls on the given MigrationCommandListBuilder.
Generate(InsertDataOperation, IModel, MigrationCommandListBuilder)	Builds commands for the given InsertDataOperation by making calls on the given MigrationCommandListBuilder, and then terminates the final command. (Inherited from MigrationsSqlGenerator)
Generate(IReadOnlyList<MigrationOperation>, IModel, MigrationsSqlGenerationOptions)	Generates commands from a list of operations.
Generate(IReadOnlyList<MigrationOperation>, IModel)	Generates commands from a list of operations. (Inherited from MigrationsSqlGenerator)
Generate(MigrationOperation, IModel, MigrationCommandListBuilder)	Builds commands for the given MigrationOperation by making calls on the given MigrationCommandListBuilder.
Generate(RenameColumnOperation, IModel, MigrationCommandListBuilder)	Builds commands for the given RenameColumnOperation by making calls on the given MigrationCommandListBuilder.
Generate(RenameIndexOperation, IModel, MigrationCommandListBuilder)	Builds commands for the given RenameIndexOperation by making calls on the given MigrationCommandListBuilder.
Generate(RenameSequenceOperation, IModel, MigrationCommandListBuilder)	Builds commands for the given RenameSequenceOperation by making calls on the given MigrationCommandListBuilder.
Generate(RenameTableOperation, IModel, MigrationCommandListBuilder)	Builds commands for the given RenameTableOperation by making calls on the given MigrationCommandListBuilder.
Generate(RestartSequenceOperation, IModel, MigrationCommandListBuilder)	Builds commands for the given RestartSequenceOperation by making calls on the given MigrationCommandListBuilder, and then terminates the final command.
Generate(SqlOperation, IModel, MigrationCommandListBuilder)	Builds commands for the given SqlOperation by making calls on the given MigrationCommandListBuilder, and then terminates the final command.
Generate(SqlServerCreateDatabaseOperation, IModel, MigrationCommandListBuilder)	Builds commands for the given SqlServerCreateDatabaseOperation by making calls on the given MigrationCommandListBuilder.
Generate(SqlServerDropDatabaseOperation, IModel, MigrationCommandListBuilder)	Builds commands for the given SqlServerDropDatabaseOperation by making calls on the given MigrationCommandListBuilder.
Generate(UpdateDataOperation, IModel, MigrationCommandListBuilder)	Builds commands for the given UpdateDataOperation by making calls on the given MigrationCommandListBuilder, and then terminates the final command.
GenerateIndexColumnList(CreateIndexOperation, IModel, MigrationCommandListBuilder)	Returns a SQL fragment for the column list of an index from a CreateIndexOperation. (Inherited from MigrationsSqlGenerator)
GenerateModificationCommands(DeleteDataOperation, IModel)	Generates the commands that correspond to the given operation. (Inherited from MigrationsSqlGenerator)
GenerateModificationCommands(InsertDataOperation, IModel)	Generates the commands that correspond to the given operation. (Inherited from MigrationsSqlGenerator)
GenerateModificationCommands(UpdateDataOperation, IModel)	Generates the commands that correspond to the given operation. (Inherited from MigrationsSqlGenerator)
GetColumnType(String, String, String, ColumnOperation, IModel)	Gets the store/database type of a column given the provided metadata. (Inherited from MigrationsSqlGenerator)
GetColumnType(String, String, String, Type, Nullable<Boolean>, Nullable<Int32>, Boolean, IModel)	Gets the store/database type of a column given the provided metadata. (Inherited from MigrationsSqlGenerator)
GetColumnType(String, String, String, Type, Nullable<Boolean>, Nullable<Int32>, Nullable<Boolean>, Boolean, IModel)	Gets the store/database type of a column given the provided metadata. (Inherited from MigrationsSqlGenerator)
GetIndexesToRebuild(IColumn, MigrationOperation)	Gets the list of indexes that need to be rebuilt when the given column is changing.
HasLegacyRenameOperations(IModel)	Checks whether or not RenameTableOperation and RenameSequenceOperation use the legacy behavior of setting the new name and schema to null when unchanged. (Inherited from MigrationsSqlGenerator)
IndexOptions(CreateIndexOperation, IModel, MigrationCommandListBuilder)	Generates a SQL fragment for extras (filter, included columns, options) of an index from a CreateIndexOperation.
IndexTraits(MigrationOperation, IModel, MigrationCommandListBuilder)	Generates a SQL fragment for traits of an index from a CreateIndexOperation, AddPrimaryKeyOperation, or AddUniqueConstraintOperation.
IsOldColumnSupported(IModel)	Checks whether or not AddColumnOperation supports the passing in the old column, which was only added in EF Core 1.1. (Inherited from MigrationsSqlGenerator)
PrimaryKeyConstraint(AddPrimaryKeyOperation, IModel, MigrationCommandListBuilder)	Generates a SQL fragment for a primary key constraint of an AddPrimaryKeyOperation. (Inherited from MigrationsSqlGenerator)
Rename(String, String, MigrationCommandListBuilder)	Generates a rename.
Rename(String, String, String, MigrationCommandListBuilder)	Generates a rename.
SequenceOptions(AlterSequenceOperation, IModel, MigrationCommandListBuilder)	Generates a SQL fragment configuring a sequence in a AlterSequenceOperation. (Inherited from MigrationsSqlGenerator)
SequenceOptions(CreateSequenceOperation, IModel, MigrationCommandListBuilder)	Generates a SQL fragment configuring a sequence in a CreateSequenceOperation. (Inherited from MigrationsSqlGenerator)
SequenceOptions(String, String, Int32, Nullable<Int64>, Nullable<Int64>, Boolean, IModel, MigrationCommandListBuilder)	Generates a SQL fragment configuring a sequence with the given options. (Inherited from MigrationsSqlGenerator)
SequenceOptions(String, String, SequenceOperation, IModel, MigrationCommandListBuilder)	Generates a SQL fragment configuring a sequence with the given options.
Transfer(String, String, String, MigrationCommandListBuilder)	Generates a transfer from one schema to another..
TryGetVersion(IModel, String)	Gets the product version used to generate the current migration. Providers can use this to preserve compatibility with migrations generated using previous versions. (Inherited from MigrationsSqlGenerator)
UniqueConstraint(AddUniqueConstraintOperation, IModel, MigrationCommandListBuilder)	Generates a SQL fragment for a unique constraint of an AddUniqueConstraintOperation. (Inherited from MigrationsSqlGenerator)
UseLegacyIndexFilters(CreateIndexOperation, IModel)	Checks whether or not CreateIndexOperation should have a filter generated for it by Migrations.