AspNet.Module.Migrator 3.0.0

.NET 10.0 This package targets .NET 10.0. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package AspNet.Module.Migrator --version 3.0.0
                    


                    

                
NuGet\Install-Package AspNet.Module.Migrator -Version 3.0.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="AspNet.Module.Migrator" Version="3.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="AspNet.Module.Migrator" Version="3.0.0" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="AspNet.Module.Migrator" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add AspNet.Module.Migrator --version 3.0.0
                    


                    

                
#r "nuget: AspNet.Module.Migrator, 3.0.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#:package AspNet.Module.Migrator@3.0.0
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=AspNet.Module.Migrator&version=3.0.0
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=AspNet.Module.Migrator&version=3.0.0
                    


                            Install as a Cake Tool

Модуль миграции БД

Модуль позволяет применять миграции и последющий Seed (пополнение БД данными)

Шаги использования

1. Создать БД контекст от исходного

Шаг позволит создать папку с миграциями в проекте Migrator

public class MigrationDbContext : AppDbContext
{

}

2. Добавить пакет Microsoft.EntityFrameworkCore.Design

Добавляет возможность вызывать cli методы для создания миграций dotnet ef migrations add.

В файле csproj появится блок

<ItemGroup>
    <PackageReference Include="AspNet.Module.Migrator" Version="1.0.0" />
    <PackageReference Include="Microsoft.EntityFrameworkCore.Design" Version="8.0.0">
        <PrivateAssets>all</PrivateAssets>
        <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
    </PackageReference>
</ItemGroup>

3. Создать MigrationDbContextFactory с интерфейсом IDesignTimeDbContextFactory<MigrationDbContext>

Также необходим для вызова cli методов dotnet ef .... Фабрика позволяет создать БД контекст с указанной строкой подключения.

MigrationDbContextFactory.cs

// BaseDesignTimeDbContextFactory - реализует интерфейс IDesignTimeDbContextFactory
public class MigrationDbContextFactory : BaseDesignTimeDbContextFactory<MigrationDbContext>
{

}

4. Вызвать методы cli для генерации миграций

Переходи в папку проекта в термиале и вызываем dotnet ef migrations add Название миграции. При этом нужно заранее установить dotnet cli

# Создание миграции с названием Init
dotnet ef migrations add Init

# Удаление последней миграции
dotnet ef migrations remove

5. Модифицировать Program

Инициализация и конфигурация мигратора и последующий запуск

Program.cs

var migrator = new AspNetMigrator<MigrationDbContext>(new AspNetMigratorOptions(args)
{
    Configuration = c =>
    {
    // используем User Secrets только в сборке Debug
#if DEBUG
        c.AddUserSecrets(Assembly.GetEntryAssembly());
#endif
    }
});

// добавляем сиды
migrator.Seeds.Add<Seed1>();
migrator.Seeds.Add<Seed2>();

await migrator.RunAsync();

6. Конфигурация Docker образа для добавления мигратора

Обычно Docker образ состоит из двух частей:

  • FROM Build - собирает приложение
  • FROM Run - запускает приложение

Dockerfile

FROM mcr.microsoft.com/dotnet/sdk:8.0 AS build
# Host --->
# build host project
# Host <---

# Migrator ---> 
WORKDIR /app
RUN dotnet restore src/Some.Migrator/*.csproj
WORKDIR /app/src/Some.Migrator
RUN dotnet publish -o out -c Release --no-restore
WORKDIR /app
# Migrator <---

FROM mcr.microsoft.com/dotnet/aspnet:8.0 AS runtime
# Host --->
# COPY Some.Host/out

# Migrator ---> 
COPY --from=build /app/src/Some.Migrator/out ./migrate/

Добавление сидов

Добавление данных после применения миграции.

1. Создать сид с интерфейсом ISeedDatabaseExecutor<MigrationDbContext>

SomeSeed.cs

internal class SomeSeed : ISeedDatabaseExecutor<MigrationDbContext>
{
    // сортировка сидов по возрастанию
    public int Order => 1;

    // название сида
    public string Name => nameof(SomeSeed);

    // можно запустить сид в зависимости от окружения
    public bool Enabled => true;
    
    public Task Execute(MigrationDbContext dbContext, CancellationToken ct)
    {
        // манипуляции с данными. Не вызываем SaveChanges, тк менеджер сидов запускает после применения всех сидов
        dbContext.SomeEntity.Add(...)
        return Task.CompletedTask;
    }
}

2. Зарегистрировать сид

Регистрация сида в миграторе.

var migrator = new AspNetMigrator<MigrationDbContext>(new ConsoleMigratorConfig(...));
var migrator = new AspNetMigrator<MigrationDbContext>(new WebMigratorConfig(...));

// добавление сида
migrator.Seeds.Add<SomeSeed>();

await migrator.RunAsync();
Product Compatible and additional computed target framework versions.
.NET net10.0 is compatible.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
3.0.1 39 4/19/2026
3.0.0 41 4/19/2026