Aicrosoft.DataAccess.DbMigration 8.0.0-beta.260127.1

Aicrosoft.DataAccess.DbMigration

Aicrosoft.DataAccess.DbMigration is a utility library for Entity Framework Core that provides a standardized base for design-time DbContext creation. It simplifies the setup required for EF Core Migration tools by leveraging the standard .NET Generic Host patterns.

Design Goals

1. Standardized Design-Time Factory: Provides the DbContextFactory<TDbContext> base class, which implements IDesignTimeDbContextFactory<TDbContext>.
2. Configuration-Driven: Automatically loads configuration from appsettings.json and environment variables during the migration process, ensuring consistency between runtime and design-time environments.
3. Dependency Injection Support: Utilizes IHostBuilder to allow the use of DI and other framework services during DbContext initialization.
4. Simplified Boilerplate: Encapsulates the logic for building DbContextOptions, allowing developers to focus solely on provider-specific configuration (e.g., SQL Server vs SQLite).
5. Environment Awareness: Supports different configurations for different hosting environments (Development, Staging, Production).

Key Components

• DbContextFactory<TDbContext>: An abstract base class that sets up a full host environment to resolve the DbContext. You only need to implement the UseDbServer method.

Usage

1. Installation

Ensure your migration project has references to:

• Aicrosoft.DataAccess.DbMigration
• Microsoft.EntityFrameworkCore.Design (must match your EF Core version)

2. Implement the Factory

Create a class in your migration project that inherits from DbContextFactory<T>.

using Aicrosoft.DataAccess;
using Microsoft.EntityFrameworkCore;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;

namespace MyProject.Migrations;

public class MyDbContextFactory : DbContextFactory<MyDbContext>
{
    protected override void UseDbServer(HostBuilderContext hostBuilderContext, IServiceCollection services)
    {
        // Get connection string from appsettings.json loaded by the base class
        var connectionString = hostBuilderContext.Configuration.GetConnectionString("DefaultConnection");

        // Set up the DB provider on the internal DbOptionBuilder
        DbOptionBuilder.UseSqlServer(connectionString, b => 
        {
            // Specify the assembly where migrations are located if different from the DbContext assembly
            b.MigrationsAssembly(MigratorAssemblyName); 
        });
    }
}

3. CLI Commands

Navigate to your migration project directory and use standard dotnet ef commands:

# Add a new migration
dotnet ef migrations add InitialCreate --context MyDbContext

# Update the database
dotnet ef database update --context MyDbContext

Notes

• appsettings.json: The factory expects an appsettings.json file in the project root to read connection strings and other settings.
• Sensitive Data: By default, EnableSensitiveDataLogging and EnableDetailedErrors are enabled in the factory for easier debugging during development.