如何让dotnet ef migrations script生成带状态打印的迁移脚本？

Great question! Out of the box, the dotnet ef migrations script --idempotent command doesn’t include explicit PRINT statements to notify you when a migration is applied or skipped. However, there are two straightforward ways to add this functionality:

Option 1: Add custom PRINT statements directly in your migration files #

You can modify individual migration classes to include PRINT commands before (and after, if needed) the migration logic. This ensures every generated script from these migrations will automatically include the status messages.

For example, open a migration file (located in your project’s Migrations folder) and update the Up method like this:

protected override void Up(MigrationBuilder migrationBuilder)
{
    // Print a message before starting the migration
    migrationBuilder.Sql(@"PRINT 'Applying migration 20240520123456_InitialCreate'");

    // Existing migration logic remains unchanged
    migrationBuilder.CreateTable(
        name: "Users",
        columns: table => new
        {
            Id = table.Column<int>(type: "int", nullable: false)
                .Annotation("SqlServer:Identity", "1, 1"),
            Name = table.Column<string>(type: "nvarchar(max)", nullable: false)
        },
        constraints: table =>
        {
            table.PrimaryKey("PK_Users", x => x.Id);
        });

    // Optional: Print a completion message
    migrationBuilder.Sql(@"PRINT 'Successfully applied migration 20240520123456_InitialCreate'");
}

When you generate the idempotent script, these PRINT statements will be wrapped inside the conditional checks that determine if the migration should run. This means the messages only execute if the migration is actually applied—they won’t trigger if the migration already exists in the __EFMigrationsHistory table.

Option 2: Post-process the generated SQL script #

If you don’t want to modify your migration files, generate the script first, then inject PRINT statements manually or via automation.

The idempotent script uses conditional blocks like this to check for existing migrations:

IF NOT EXISTS(SELECT * FROM [__EFMigrationsHistory] WHERE [MigrationId] = N'20240520123456_InitialCreate')
BEGIN
    -- Migration logic here
END
GO

You can add PRINT statements inside the BEGIN block to track execution:

IF NOT EXISTS(SELECT * FROM [__EFMigrationsHistory] WHERE [MigrationId] = N'20240520123456_InitialCreate')
BEGIN
    PRINT 'Applying migration 20240520123456_InitialCreate'
    -- Migration logic here
    PRINT 'Completed migration 20240520123456_InitialCreate'
END
GO

For larger scripts, you could write a simple PowerShell or Python script to automate this replacement across all migration blocks.

Key Notes #

• Always test modified scripts in a non-production environment first to ensure PRINT statements don’t interfere with migration logic.
• If you use Option 1, the custom PRINT commands become part of your migration history—they’ll run every time the migration is applied, even in future script generations.

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