如何通过dotnet ef migrations script生成带指定目标库的EF迁移脚本？

当使用EF Core生成迁移脚本并希望限制脚本仅在目标数据库执行时，我们需要在脚本开头添加USE [DatabaseName]; GO语句。dotnet ef migrations script命令本身没有直接参数支持这一需求，但可以通过以下两种方式实现：

方法1：生成脚本后手动/脚本拼接（快速方案） #

直接通过命令行工具将USE语句前置到生成的脚本中，无需修改代码：

Windows CMD #

@echo off
echo USE [SomeDatabase]; GO > migration-script.sql
dotnet ef migrations script >> migration-script.sql

PowerShell #

$prefix = "USE [SomeDatabase];`nGO`n`n"
$scriptContent = dotnet ef migrations script
$prefix + $scriptContent | Out-File -FilePath migration-script.sql -Encoding utf8

Linux/macOS Shell #

echo -e "USE [SomeDatabase];\nGO\n\n" > migration-script.sql
dotnet ef migrations script >> migration-script.sql

这种方式简单直接，适合手动生成脚本的场景。

方法2：自定义迁移SQL生成器（自动化方案） #

通过扩展EF Core的迁移SQL生成器，让脚本生成时自动包含USE语句，适合CI/CD等自动化生成流程：

1. 创建自定义SQL生成器类

using Microsoft.EntityFrameworkCore.Migrations;
using Microsoft.EntityFrameworkCore.Migrations.Sql;

public class TargetDbSqlGenerator : SqlServerMigrationsSqlGenerator
{
    private readonly string _targetDbName;

    public TargetDbSqlGenerator(
        MigrationsSqlGeneratorDependencies dependencies,
        IMigrationsAnnotationProvider annotationProvider,
        string targetDbName)
        : base(dependencies, annotationProvider)
    {
        _targetDbName = targetDbName;
    }

    protected override void Generate(MigrationCommandListBuilder builder, Migration migration)
    {
        // 在脚本开头插入USE语句
        builder.AppendLine($"USE [{_targetDbName}];");
        builder.AppendLine("GO");
        builder.AppendLine();

        // 调用基类生成后续迁移内容
        base.Generate(builder, migration);
    }
}

2. 在DbContext配置中注册自定义生成器

using Microsoft.EntityFrameworkCore;
using Microsoft.Extensions.DependencyInjection;

public class AppDbContext : DbContext
{
    protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
    {
        optionsBuilder.UseSqlServer("YourConnectionString");
    }

    // 注册服务时传入目标数据库名
    public static void AddDbContextServices(IServiceCollection services, string targetDbName)
    {
        services.AddDbContext<AppDbContext>(options =>
            options.UseSqlServer("YourConnectionString"));

        services.AddScoped<IMigrationsSqlGenerator>(sp =>
            new TargetDbSqlGenerator(
                sp.GetRequiredService<MigrationsSqlGeneratorDependencies>(),
                sp.GetRequiredService<IMigrationsAnnotationProvider>(),
                targetDbName));
    }
}

之后运行dotnet ef migrations script生成的脚本就会自动包含开头的USE语句。

内容的提问来源于stack exchange，提问作者Detilium