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:

pg
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.

Newsletter Anmeldung
Diese Artikel könnten Sie interessieren
Database Access with Sessions
.NET
KP-round

Data Access in .NET Native AOT with Sessions

.NET 8 brings Native AOT to ASP.NET Core, but many frameworks and libraries rely on unbound reflection internally and thus cannot support this scenario yet. This is true for ORMs, too: EF Core and Dapper will only bring full support for Native AOT in later releases. In this post, we will implement a database access layer with Sessions using the Humble Object pattern to get a similar developer experience. We will use Npgsql as a plain ADO.NET provider targeting PostgreSQL.
15.11.2023
Old computer with native code
.NET
KP-round

Native AOT with ASP.NET Core – Overview

Originally introduced in .NET 7, Native AOT can be used with ASP.NET Core in the upcoming .NET 8 release. In this post, we look at the benefits and drawbacks from a general perspective and perform measurements to quantify the improvements on different platforms.
02.11.2023
.NET
KP-round

Optimize ASP.NET Core memory with DATAS

.NET 8 introduces a new Garbage Collector feature called DATAS for Server GC mode - let's make some benchmarks and check how it fits into the big picture.
09.10.2023
.NET CORE
pg

Incremental Roslyn Source Generators: High-Level API – ForAttributeWithMetadataName – Part 8

With the version 4.3.1 of Microsoft.CodeAnalysis.* Roslyn provides a new high-level API - the method "ForAttributeWithMetadataName". Although it is just 1 method, still, it addresses one of the biggest performance issue with Source Generators.
16.05.2023
AI
favicon

Integrating AI Power into Your .NET Applications with the Semantic Kernel Toolkit – an Early View

With the rise of powerful AI models and services, questions come up on how to integrate those into our applications and make reasonable use of them. While other languages like Python already have popular and feature-rich libraries like LangChain, we are missing these in .NET and C#. But there is a new kid on the block that might change this situation. Welcome Semantic Kernel by Microsoft!
03.05.2023
.NET
sg

.NET 7 Performance: Regular Expressions – Part 2

There is this popular quote by Jamie Zawinski: Some people, when confronted with a problem, think "I know, I'll use regular expressions." Now they have two problems."

In this second article of our short performance series, we want to look at the latter one of those problems.
25.04.2023