Entity Framework Core – Changing DB Migration Schema At Runtime

In the first part of this short blog post series we looked at how to change the database schema of a DbContext, now it is all about changing the schema of the EF Core Migrations at runtime. The samples are on Github: PawelGerr/EntityFrameworkCore-Demos

In diesem Artikel:

Entity Framework Core – Changing DB Migration Schema At Runtime
Pawel Gerr ist Architekt und Consultant bei Thinktecture. Er hat sich auf .NET Core Backends spezialisiert und kennt Entity Framework von vorne bis hinten.
Given is a DemoDbContext implementing our interface IDbContextSchema from the first part of this series.
				
					public interface IDbContextSchema
{
  string Schema { get; }
}

public class DemoDbContext : DbContext, IDbContextSchema
{
 public string Schema { get; }

 public DbSet<Product> Products { get; set; }

 ...
}
				
			

At first we create a migration the usual way: dotnet ef migrations add Initial_Migration

And we get the following:

				
					public partial class Initial_Migration : Migration
{
  protected override void Up(MigrationBuilder migrationBuilder)
  {
    migrationBuilder.CreateTable("Products",
                        table => new { Id = table.Column<Guid>() },
                        constraints: table => table.PrimaryKey("PK_Products", x => x.Id));
  }

  protected override void Down(MigrationBuilder migrationBuilder)
  {
    migrationBuilder.DropTable("Products");
  }
}
				
			

Next, we add a constructor to provide the migration with IDbContextSchema and pass the schema to CreateTable and DropTable.

				
					public partial class Initial_Migration : Migration
{
  private readonly IDbContextSchema _schema;

  public Initial_Migration(IDbContextSchema schema)
  {
    _schema = schema ?? throw new ArgumentNullException(nameof(schema));
  }

  protected override void Up(MigrationBuilder migrationBuilder)
  {
    migrationBuilder.CreateTable("Products",
                        table => new { Id = table.Column<Guid>() },
                        constraints: table => table.PrimaryKey("PK_Products", x => x.Id),
                        schema: _schema.Schema);
  }

  protected override void Down(MigrationBuilder migrationBuilder)
  {
    migrationBuilder.DropTable("Products", _schema.Schema);
  }
}
				
			

If we try to run the migration then we get a MissingMethodException: No parameterless constructor defined for this object. because EF Core needs a parameterless constructor to be able to create an instance of the migration. Luckily, we can adjust the part that is responsible for the creation of new instances. For that we derive from MigrationsAssembly and override the method CreateMigration. In CreateMigration we check if the migration requires an instance of IDbContextSchema and whether the current DbContext is implementing this interface. If so, then we create new instance of the migration by ourselves and return this instance to the caller, otherwise we pass the call to the default implementation.

				
					public class DbSchemaAwareMigrationAssembly : MigrationsAssembly
{
  private readonly DbContext _context;

  public DbSchemaAwareMigrationAssembly(ICurrentDbContext currentContext, 
        IDbContextOptions options, IMigrationsIdGenerator idGenerator, 
        IDiagnosticsLogger<DbLoggerCategory.Migrations> logger)
    : base(currentContext, options, idGenerator, logger)
  {
    _context = currentContext.Context;
  }

  public override Migration CreateMigration(TypeInfo migrationClass, 
        string activeProvider)
  {
    if (activeProvider == null)
      throw new ArgumentNullException(nameof(activeProvider));

    var hasCtorWithSchema = migrationClass
            .GetConstructor(new[] { typeof(IDbContextSchema) }) != null;

    if (hasCtorWithSchema && _context is IDbContextSchema schema)
    {
      var instance = (Migration)Activator.CreateInstance(migrationClass.AsType(), schema);
      instance.ActiveProvider = activeProvider;
      return instance;
    }

    return base.CreateMigration(migrationClass, activeProvider);
  }
}
				
			

The last step is to register the DbSchemaAwareMigrationAssembly with the dependency injection of EF Core.

Remarks: to change the schema (or the table name) of the migration history table you have to use the method MigrationsHistoryTable

				
					var optionsBuilder = new DbContextOptionsBuilder<DemoDbContext>()
              .UseSqlServer("..."
                      // optional
                      //, b => b.MigrationsHistoryTable("__EFMigrationsHistory", schema)
                            )
              .ReplaceService<IModelCacheKeyFactory, DbSchemaAwareModelCacheKeyFactory>()
              .ReplaceService<IMigrationsAssembly, DbSchemaAwareMigrationAssembly>();
				
			

That’s all!

Kostenloser
Newsletter

Aktuelle Artikel, Screencasts, Webinare und Interviews unserer Experten für Sie

Verpassen Sie keine Inhalte zu Angular, .NET Core, Blazor, Azure und Kubernetes und melden Sie sich zu unserem kostenlosen monatlichen Dev-Newsletter an.

Diese Artikel könnten Sie interessieren
.NET
Incremental Roslyn Source Generators in .NET 6: Adapt Code Generation Based on Project Dependencies – Part 5

Incremental Roslyn Source Generators in .NET 6: Adapt Code Generation Based on Project Dependencies – Part 5

The Roslyn Source Generator, implemented in the previous articles of the series, emits some C# code without looking at the dependencies of the current .NET (Core) project. In this article our DemoSourceGenerator should implement a JsonConverter, but only if the corresponding library (e.g. Newtonsoft.Json) is referenced by the project.
08.07.2022
Unterschiede
.NET
Blazor WebAssembly vs. Blazor Server – Welche Unterschiede gibt es und wann wähle ich was?

Blazor WebAssembly vs. Blazor Server – Welche Unterschiede gibt es und wann wähle ich was?

Das Blazor Framework von Microsoft gibt es inzwischen in drei "Geschmacksrichtungen". Die erste ist Blazor WebAssembly, die zweite Blazor Server, und zu guter Letzt gibt es noch Blazor Hybrid. In diesem Artikel wollen wir uns die zwei "echten", also Browser-basierten, Web-Anwendungs-Szenarien WebAssembly und Server anschauen.
04.07.2022
Three different textured walls
.NET
Dependency Injection Scopes in Blazor

Dependency Injection Scopes in Blazor

The dependency injection system is a big part of how modern ASP.NET Core works internally: It provides a flexible solution for developers to structure their projects, decouple their dependencies, and control the lifetimes of the components within an application. In Blazor - a new part of ASP.NET Core - however, the DI system feels a bit odd, and things seem to work a bit differently than expected. This article will explain why this is not only a feeling but indeed the case in the first place and how to handle the differences in order to not run into problems later on.
31.05.2022
.NET
Asynchrone Operationen: Blazor WebAssembly für Angular-Entwickler – Teil 5 [Screencast]

Asynchrone Operationen: Blazor WebAssembly für Angular-Entwickler – Teil 5 [Screencast]

Eine Webanwendung will natürlich auch mit Daten gefüttert werden. Doch diese müssen irgendwo her kommen. Nichts liegt näher als diese von einer Web API zu laden. Dieser Screencast zeigt, wie asynchrone Operationen in Blazor funktionieren und welche gravierenden Unterschiede es zu Angular gibt.
26.05.2022
.NET
Typings: Blazor WebAssembly für Angular-Entwickler – Teil 4 [Screencast]

Typings: Blazor WebAssembly für Angular-Entwickler – Teil 4 [Screencast]

C# und TypeScript entstammen der Feder der selben Person. Doch sind sie deshalb auch gleich? In diesem Teil der Screencast-Serie erfahren Sie, wie mit Typen in den beiden Programmiersprachen verfahren wird und welche Unterschiede es gibt.
19.05.2022
.NET
Bindings: Blazor WebAssembly für Angular-Entwickler – Teil 3 [Screencast]

Bindings: Blazor WebAssembly für Angular-Entwickler – Teil 3 [Screencast]

Wer Komponenten einsetzt, steht früher oder später vor der Fragestellung, wie man Daten an die Komponente übergibt oder auf Ereignisse einer Komponente reagiert. In diesem Screencast wird gezeigt wie Bindings bei Komponenten funktionieren, also wie eine Komponente Daten von außerhalb benutzen und Rückmeldung bei Aktionen geben kann.
12.05.2022