SqlServerMigrationsSqlGenerator.AddDescription Method

  • Reference

Definition

Namespace:
Microsoft.EntityFrameworkCore.Migrations
Assembly:
Microsoft.EntityFrameworkCore.SqlServer.dll
Package:
Microsoft.EntityFrameworkCore.SqlServer v3.0.0
Package:
Microsoft.EntityFrameworkCore.SqlServer v3.1.0
Package:
Microsoft.EntityFrameworkCore.SqlServer v5.0.0
Package:
Microsoft.EntityFrameworkCore.SqlServer v6.0.0
Package:
Microsoft.EntityFrameworkCore.SqlServer v7.0.0
Package:
Microsoft.EntityFrameworkCore.SqlServer v8.0.0

Generates add commands for descriptions on tables and columns.

protected virtual void AddDescription (Microsoft.EntityFrameworkCore.Migrations.MigrationCommandListBuilder builder, string description, string schema, string table, string column = default, bool omitSchemaVariable = false);
protected virtual void AddDescription (Microsoft.EntityFrameworkCore.Migrations.MigrationCommandListBuilder builder, string description, string schema, string table, string column = default, bool omitVariableDeclarations = false);
protected virtual void AddDescription (Microsoft.EntityFrameworkCore.Migrations.MigrationCommandListBuilder builder, string description, string? schema, string table, string? column = default, bool omitVariableDeclarations = false);
abstract member AddDescription : Microsoft.EntityFrameworkCore.Migrations.MigrationCommandListBuilder * string * string * string * string * bool -> unit
override this.AddDescription : Microsoft.EntityFrameworkCore.Migrations.MigrationCommandListBuilder * string * string * string * string * bool -> unit
abstract member AddDescription : Microsoft.EntityFrameworkCore.Migrations.MigrationCommandListBuilder * string * string * string * string * bool -> unit
override this.AddDescription : Microsoft.EntityFrameworkCore.Migrations.MigrationCommandListBuilder * string * string * string * string * bool -> unit
Protected Overridable Sub AddDescription (builder As MigrationCommandListBuilder, description As String, schema As String, table As String, Optional column As String = Nothing, Optional omitSchemaVariable As Boolean = false)
Protected Overridable Sub AddDescription (builder As MigrationCommandListBuilder, description As String, schema As String, table As String, Optional column As String = Nothing, Optional omitVariableDeclarations As Boolean = false)

Parameters

builder
MigrationCommandListBuilder

The command builder to use to build the commands.

description
String

The new description to be applied.

schema
String

The schema of the table.

table
String

The name of the table.

column
String

The name of the column.

omitSchemaVariableomitVariableDeclarations
Boolean

Indicates whether the @defaultSchema variable declaraion should be omitted.

Applies to