MigrationBuilder.RenameTable(String, String, String, String) Method

  • Reference

Definition

Namespace:
Microsoft.EntityFrameworkCore.Migrations
Assembly:
Microsoft.EntityFrameworkCore.Relational.dll
Package:
Microsoft.EntityFrameworkCore.Relational v1.0.6
Package:
Microsoft.EntityFrameworkCore.Relational v1.1.6
Package:
Microsoft.EntityFrameworkCore.Relational v2.0.3
Package:
Microsoft.EntityFrameworkCore.Relational v2.1.11
Package:
Microsoft.EntityFrameworkCore.Relational v2.2.6
Package:
Microsoft.EntityFrameworkCore.Relational v3.0.0
Package:
Microsoft.EntityFrameworkCore.Relational v3.1.0
Package:
Microsoft.EntityFrameworkCore.Relational v5.0.0
Package:
Microsoft.EntityFrameworkCore.Relational v6.0.0
Package:
Microsoft.EntityFrameworkCore.Relational v7.0.0
Package:
Microsoft.EntityFrameworkCore.Relational v8.0.0

Builds a RenameTableOperation to rename an existing table.

public virtual Microsoft.EntityFrameworkCore.Migrations.Operations.Builders.OperationBuilder<Microsoft.EntityFrameworkCore.Migrations.Operations.RenameTableOperation> RenameTable (string name, string schema = default, string newName = default, string newSchema = default);
public virtual Microsoft.EntityFrameworkCore.Migrations.Operations.Builders.OperationBuilder<Microsoft.EntityFrameworkCore.Migrations.Operations.RenameTableOperation> RenameTable (string name, string? schema = default, string? newName = default, string? newSchema = default);
abstract member RenameTable : string * string * string * string -> Microsoft.EntityFrameworkCore.Migrations.Operations.Builders.OperationBuilder<Microsoft.EntityFrameworkCore.Migrations.Operations.RenameTableOperation>
override this.RenameTable : string * string * string * string -> Microsoft.EntityFrameworkCore.Migrations.Operations.Builders.OperationBuilder<Microsoft.EntityFrameworkCore.Migrations.Operations.RenameTableOperation>
Public Overridable Function RenameTable (name As String, Optional schema As String = Nothing, Optional newName As String = Nothing, Optional newSchema As String = Nothing) As OperationBuilder(Of RenameTableOperation)

Parameters

name
String

The name of the table to be renamed.

schema
String

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

newName
String

The new table name or null if only the schema has changed.

newSchema
String

The new schema name, or null to use the default schema.

Returns

OperationBuilder<RenameTableOperation>

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

Remarks

See Database migrations for more information and examples.

Applies to