Share via

IMigrator.GenerateScript Method

  • Reference

Definition

Namespace:
Microsoft.EntityFrameworkCore.Migrations
Assembly:
Microsoft.EntityFrameworkCore.Relational.dll
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
Package:
Microsoft.EntityFrameworkCore.Relational v9.0.0
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

Overloads

GenerateScript(String, String, MigrationsSqlGenerationOptions)

Generates a SQL script to migrate a database either in its entirety, or starting and ending at specified migrations.
GenerateScript(String, String, Boolean)

Generates a SQL script to migrate a database either in its entirety, or starting and ending at specified migrations.

GenerateScript(String, String, MigrationsSqlGenerationOptions)

Source:
IMigrator.cs
Source:
IMigrator.cs
Source:
IMigrator.cs

Generates a SQL script to migrate a database either in its entirety, or starting and ending at specified migrations.

public string GenerateScript (string fromMigration = default, string toMigration = default, Microsoft.EntityFrameworkCore.Migrations.MigrationsSqlGenerationOptions options = Microsoft.EntityFrameworkCore.Migrations.MigrationsSqlGenerationOptions.Default);
public string GenerateScript (string? fromMigration = default, string? toMigration = default, Microsoft.EntityFrameworkCore.Migrations.MigrationsSqlGenerationOptions options = Microsoft.EntityFrameworkCore.Migrations.MigrationsSqlGenerationOptions.Default);
[System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Migration generation currently isn't compatible with trimming")]
public string GenerateScript (string? fromMigration = default, string? toMigration = default, Microsoft.EntityFrameworkCore.Migrations.MigrationsSqlGenerationOptions options = Microsoft.EntityFrameworkCore.Migrations.MigrationsSqlGenerationOptions.Default);
[System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Migration generation currently isn't compatible with trimming")]
[System.Diagnostics.CodeAnalysis.RequiresDynamicCode("Migrations operations are not supported with NativeAOT")]
public string GenerateScript (string? fromMigration = default, string? toMigration = default, Microsoft.EntityFrameworkCore.Migrations.MigrationsSqlGenerationOptions options = Microsoft.EntityFrameworkCore.Migrations.MigrationsSqlGenerationOptions.Default);
abstract member GenerateScript : string * string * Microsoft.EntityFrameworkCore.Migrations.MigrationsSqlGenerationOptions -> string
[<System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Migration generation currently isn't compatible with trimming")>]
abstract member GenerateScript : string * string * Microsoft.EntityFrameworkCore.Migrations.MigrationsSqlGenerationOptions -> string
[<System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Migration generation currently isn't compatible with trimming")>]
[<System.Diagnostics.CodeAnalysis.RequiresDynamicCode("Migrations operations are not supported with NativeAOT")>]
abstract member GenerateScript : string * string * Microsoft.EntityFrameworkCore.Migrations.MigrationsSqlGenerationOptions -> string
Public Function GenerateScript (Optional fromMigration As String = Nothing, Optional toMigration As String = Nothing, Optional options As MigrationsSqlGenerationOptions = Microsoft.EntityFrameworkCore.Migrations.MigrationsSqlGenerationOptions.Default) As String

Parameters

fromMigration
String

The migration to start from, or null to start from the empty database.

toMigration
String

The target migration to migrate the database to, or null to migrate to the latest.

options
MigrationsSqlGenerationOptions

The options to use when generating SQL for migrations.

Returns

String

The generated script.

Attributes
RequiresUnreferencedCodeAttribute RequiresDynamicCodeAttribute

Remarks

See Database migrations for more information and examples.

Applies to

GenerateScript(String, String, Boolean)

Generates a SQL script to migrate a database either in its entirety, or starting and ending at specified migrations.

public string GenerateScript (string fromMigration = default, string toMigration = default, bool idempotent = false);
abstract member GenerateScript : string * string * bool -> string
Public Function GenerateScript (Optional fromMigration As String = Nothing, Optional toMigration As String = Nothing, Optional idempotent As Boolean = false) As String

Parameters

fromMigration
String

The migration to start from, or null to start from the empty database.

toMigration
String

The target migration to migrate the database to, or null to migrate to the latest.

idempotent
Boolean

If true, then idempotent scripts will be generated, otherwise scripts will be generated that assume none of the migrations in the range specified have already been applied to the database.

Returns

String

The generated script.

Applies to