Benutzerdefinierte Migrationen-VorgängeCustom Migrations Operations

Die MigrationBuilder-API ermöglicht Ihnen, viele verschiedene Arten von Vorgängen während einer Migration durchzuführen, aber zurückgelegt vollständig ist.The MigrationBuilder API allows you to perform many different kinds of operations during a migration, but it's far from exhaustive. Allerdings ist die API erweiterbar gestattet, eigene Vorgänge zu definieren.However, the API is also extensible allowing you to define your own operations. Es gibt zwei Methoden zum Erweitern von der API: Verwenden der Sql() -Methode, oder definieren benutzerdefinierte MigrationOperation Objekte.There are two ways to extend the API: Using the Sql() method, or by defining custom MigrationOperation objects.

Um zu veranschaulichen, sehen wir uns das Implementieren eines Vorgangs, das einen Datenbankbenutzer, der mit jeder Ansatz erstellt.To illustrate, let's look at implementing an operation that creates a database user using each approach. In unserem Migrationen möchten wir ermöglichen, schreiben den folgenden Code:In our migrations, we want to enable writing the following code:

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

Verwenden von MigrationBuilder.Sql()Using MigrationBuilder.Sql()

Die einfachste Möglichkeit, einen Vorgang implementiert wird, um eine Erweiterungsmethode zu definieren, die aufruft MigrationBuilder.Sql().The easiest way to implement a custom operation is to define an extension method that calls MigrationBuilder.Sql(). Hier ist ein Beispiel, das die entsprechende Transact-SQL generiert.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}';");

Wenn Ihre Migrationen mehrere Datenbankanbieter unterstützen müssen, können Sie mithilfe der MigrationBuilder.ActiveProvider Eigenschaft.If your migrations need to support multiple database providers, you can use the MigrationBuilder.ActiveProvider property. Hier ist ein Beispiel für Microsoft SQL Server und PostreSQL unterstützen.Here's an example supporting both Microsoft SQL Server and PostreSQL.

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}';");
    }
}

Dieser Ansatz funktioniert nur, wenn Sie wissen, dass alle Anbieter, in denen Ihre benutzerdefinierte Vorgänge angewendet werden.This approach only works if you know every provider where your custom operation will be applied.

Verwenden eine MigrationOperationUsing a MigrationOperation

Um den benutzerdefinierten Vorgang aus der SQL zu entkoppeln, können Sie definieren eine eigene MigrationOperation für die Darstellung.To decouple the custom operation from the SQL, you can define your own MigrationOperation to represent it. Der Vorgang wird dann an den Anbieter übergeben, sodass er die entsprechende SQL generieren ermitteln kann.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; }
}

Bei diesem Ansatz die Erweiterungsmethode benötigt nur einen dieser Vorgänge zum Hinzufügen 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;
}

Dieser Ansatz erfordert jeder Anbieter wissen, wie zum Generieren von SQL für diesen Vorgang in ihre IMigrationsSqlGenerator Dienst.This approach requires each provider to know how to generate SQL for this operation in their IMigrationsSqlGenerator service. Hier ist ein Beispiel für die SQL Server-Generator zum Verarbeiten der neuen Vorgangs überschreiben.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.TypeMapper.GetMapping(typeof(string));

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

Ersetzen Sie den Standarddienst Migrationen Sql-Generator, mit dem aktualisierten.Replace the default migrations sql generator service with the updated one.

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