カスタムの移行操作Custom Migrations Operations

MigrationBuilder API では、移行中、さまざまな種類の操作を実行できます。 が網羅したなります。The MigrationBuilder API allows you to perform many different kinds of operations during a migration, but it's far from exhaustive. ただし、API は、独自の操作を定義できる拡張可能なもです。However, the API is also extensible allowing you to define your own operations. API を拡張する 2 つの方法があります: を使用して、Sql()メソッド、またはカスタムを定義してMigrationOperationオブジェクト。There are two ways to extend the API: Using the Sql() method, or by defining custom MigrationOperation objects.

を示すためには、それぞれのアプローチを使用してデータベース ユーザーを作成する操作の実装を見てみましょう。To illustrate, let's look at implementing an operation that creates a database user using each approach. 移行では、次のコードを記述を有効にします。In our migrations, we want to enable writing the following code:

migrationBuilder.CreateUser("SQLUser1", "Password");

MigrationBuilder.Sql() を使用します。Using MigrationBuilder.Sql()

呼び出す拡張メソッドを定義するカスタム操作を実装する最も簡単な方法は、MigrationBuilder.Sql()します。The easiest way to implement a custom operation is to define an extension method that calls MigrationBuilder.Sql(). 適切な Transact SQL を生成する例を示します。Here is an example that generates the appropriate Transact-SQL.

static MigrationBuilder CreateUser(
    this MigrationBuilder migrationBuilder,
    string name,
    string password)
    => migrationBuilder.Sql($"CREATE USER {name} WITH PASSWORD '{password}';");

複数のデータベース プロバイダーをサポートするために、移行する場合は、使用できます、MigrationBuilder.ActiveProviderプロパティ。If your migrations need to support multiple database providers, you can use the MigrationBuilder.ActiveProvider property. Microsoft SQL Server、PostgreSQL の両方をサポートしている例を示します。Here's an example supporting both Microsoft SQL Server and PostgreSQL.

static MigrationBuilder CreateUser(
    this MigrationBuilder migrationBuilder,
    string name,
    string password)
{
    switch (migrationBuilder.ActiveProvider)
    {
        case "Npgsql.EntityFrameworkCore.PostgreSQL":
            return migrationBuilder
                .Sql($"CREATE USER {name} WITH PASSWORD '{password}';");

        case "Microsoft.EntityFrameworkCore.SqlServer":
            return migrationBuilder
                .Sql($"CREATE USER {name} WITH PASSWORD = '{password}';");
    }

    return migrationBuilder;
}

このアプローチのみはすべてのプロバイダーがわかっている場合、カスタム操作が適用されます。This approach only works if you know every provider where your custom operation will be applied.

MigrationOperation を使用します。Using a MigrationOperation

SQL からカスタムの操作を分離するために定義できます独自MigrationOperationそれを表します。To decouple the custom operation from the SQL, you can define your own MigrationOperation to represent it. 生成する適切な SQL を判断できるように、操作がプロバイダーに渡されます。The operation is then passed to the provider so it can determine the appropriate SQL to generate.

class CreateUserOperation : MigrationOperation
{
    public string Name { get; set; }
    public string Password { get; set; }
}

この方法は、だけ、拡張メソッドはいずれかのこれらの操作を追加する必要があります。MigrationBuilder.Operationsします。With this approach, the extension method just needs to add one of these operations to MigrationBuilder.Operations.

static MigrationBuilder CreateUser(
    this MigrationBuilder migrationBuilder,
    string name,
    string password)
{
    migrationBuilder.Operations.Add(
        new CreateUserOperation
        {
            Name = name,
            Password = password
        });

    return migrationBuilder;
}

このアプローチには、この操作で SQL を生成する方法を理解するには、各プロバイダーが必要があります、IMigrationsSqlGeneratorサービス。This approach requires each provider to know how to generate SQL for this operation in their IMigrationsSqlGenerator service. 新しい操作を処理するために、SQL Server のジェネレーターをオーバーライドする例を示します。Here is an example overriding the SQL Server's generator to handle the new operation.

class MyMigrationsSqlGenerator : SqlServerMigrationsSqlGenerator
{
    public MyMigrationsSqlGenerator(
        MigrationsSqlGeneratorDependencies dependencies,
        IMigrationsAnnotationProvider migrationsAnnotations)
        : base(dependencies, migrationsAnnotations)
    {
    }

    protected override void Generate(
        MigrationOperation operation,
        IModel model,
        MigrationCommandListBuilder builder)
    {
        if (operation is CreateUserOperation createUserOperation)
        {
            Generate(createUserOperation, builder);
        }
        else
        {
            base.Generate(operation, model, builder);
        }
    }

    private void Generate(
        CreateUserOperation operation,
        MigrationCommandListBuilder builder)
    {
        var sqlHelper = Dependencies.SqlGenerationHelper;
        var stringMapping = Dependencies.TypeMappingSource.FindMapping(typeof(string));

        builder
            .Append("CREATE USER ")
            .Append(sqlHelper.DelimitIdentifier(operation.Name))
            .Append(" WITH PASSWORD = ")
            .Append(stringMapping.GenerateSqlLiteral(operation.Password))
            .AppendLine(sqlHelper.StatementTerminator)
            .EndCommand();
    }
}

1 つずつ更新では、既定の移行 sql ジェネレーターのサービスを置き換えます。Replace the default migrations sql generator service with the updated one.

protected override void OnConfiguring(DbContextOptionsBuilder options)
    => options
        .UseSqlServer(connectionString)
        .ReplaceService<IMigrationsSqlGenerator, MyMigrationsSqlGenerator>();