MigrationBuilder.CreateIndex Method

Definition

Namespace:

Microsoft.EntityFrameworkCore.Migrations

Assembly:

Microsoft.EntityFrameworkCore.Relational.dll

Package:

Microsoft.EntityFrameworkCore.Relational v8.0.0

Overloads

CreateIndex(String, String, String[], String, Boolean, String, Boolean[])	Builds a CreateIndexOperation to create a new composite (multi-column) index.
CreateIndex(String, String, String, String, Boolean, String, Boolean[])	Builds a CreateIndexOperation to create a new index.

CreateIndex(String, String, String[], String, Boolean, String, Boolean[])

Builds a CreateIndexOperation to create a new composite (multi-column) index.

public virtual Microsoft.EntityFrameworkCore.Migrations.Operations.Builders.OperationBuilder<Microsoft.EntityFrameworkCore.Migrations.Operations.CreateIndexOperation> CreateIndex (string name, string table, string[] columns, string? schema = default, bool unique = false, string? filter = default, bool[]? descending = default);

abstract member CreateIndex : string * string * string[] * string * bool * string * bool[] -> Microsoft.EntityFrameworkCore.Migrations.Operations.Builders.OperationBuilder<Microsoft.EntityFrameworkCore.Migrations.Operations.CreateIndexOperation>
override this.CreateIndex : string * string * string[] * string * bool * string * bool[] -> Microsoft.EntityFrameworkCore.Migrations.Operations.Builders.OperationBuilder<Microsoft.EntityFrameworkCore.Migrations.Operations.CreateIndexOperation>

Public Overridable Function CreateIndex (name As String, table As String, columns As String(), Optional schema As String = Nothing, Optional unique As Boolean = false, Optional filter As String = Nothing, Optional descending As Boolean() = Nothing) As OperationBuilder(Of CreateIndexOperation)

Parameters

name

String

The index name.

table

String

The table that contains the index.

columns

String[]

The ordered list of columns that are indexed.

schema

String

The schema that contains the table, or null to use the default schema.

unique

Boolean

Indicates whether or not the index enforces uniqueness.

filter

String

The filter to apply to the index, or null for no filter.

descending

Boolean[]

A set of values indicating whether each corresponding index column has descending sort order. If null, all columns will have ascending order.

Returns

OperationBuilder<CreateIndexOperation>

A builder to allow annotations to be added to the operation.

Remarks

See Database migrations for more information and examples.

CreateIndex(String, String, String, String, Boolean, String, Boolean[])

Builds a CreateIndexOperation to create a new index.

public virtual Microsoft.EntityFrameworkCore.Migrations.Operations.Builders.OperationBuilder<Microsoft.EntityFrameworkCore.Migrations.Operations.CreateIndexOperation> CreateIndex (string name, string table, string column, string? schema = default, bool unique = false, string? filter = default, bool[]? descending = default);

abstract member CreateIndex : string * string * string * string * bool * string * bool[] -> Microsoft.EntityFrameworkCore.Migrations.Operations.Builders.OperationBuilder<Microsoft.EntityFrameworkCore.Migrations.Operations.CreateIndexOperation>
override this.CreateIndex : string * string * string * string * bool * string * bool[] -> Microsoft.EntityFrameworkCore.Migrations.Operations.Builders.OperationBuilder<Microsoft.EntityFrameworkCore.Migrations.Operations.CreateIndexOperation>

Public Overridable Function CreateIndex (name As String, table As String, column As String, Optional schema As String = Nothing, Optional unique As Boolean = false, Optional filter As String = Nothing, Optional descending As Boolean() = Nothing) As OperationBuilder(Of CreateIndexOperation)

Parameters

name

String

The index name.

table

String

The table that contains the index.

column

String

The column that is indexed.

schema

String

The schema that contains the table, or null to use the default schema.

unique

Boolean

Indicates whether or not the index enforces uniqueness.

filter

String

The filter to apply to the index, or null for no filter.

descending

Boolean[]

A set of values indicating whether each corresponding index column has descending sort order. If null, all columns will have ascending order. If an empty array, all columns will have descending order.

Returns

OperationBuilder<CreateIndexOperation>

A builder to allow annotations to be added to the operation.

Remarks

See Database migrations for more information and examples.