Skip to content

Latest commit

 

History

History
62 lines (50 loc) · 3.79 KB

File metadata and controls

62 lines (50 loc) · 3.79 KB

CUSTIS.NetCore.EF.MigrationGenerationExtensions

coverage report Version Downloads

Adds views, synonyms, stored procedures, etc. (so-called SQL objects) to the EF model. Creates migrations, when those objects are changed. SQL objects are defined as raw SQL in C#-code or in embedded resources. They can be even generated at runtime.

All EF Core model-tracking and application features are supported:

  • When SQL-objects change, migrations are generated.
  • SQL-objects are applied on Database.Migrate() or Database.EnsureCreated().
  • Correct script is generated on dotnet ef migrations script.
  • Database is updated on dotnet ef database update.

How to use

Ways to add SqlObjects to the model

protected override void OnModelCreating(ModelBuilder modelBuilder)
{
    //...

    // Add SqlObject directly
    // Order is used to define the order in which objects are created / updated in DB
    const string Sql = "create or replace view migr_ext_tests.v_view_10 as select * from migr_ext_tests.my_table;";
    modelBuilder.AddSqlObjects(new SqlObject(Name: "v_view_10", SqlCode: Sql) { Order = 10 });

    // Add all embedded resources, placed in assembly's "Sql" folder
    // Only *.sql resources are added
    // There is no way to define order for embedded objects
    // Use resources' names if you need to sort objects
    modelBuilder.AddSqlObjects(assembly: typeof(Class1).Assembly, folder: "Sql");
}

Known limitations

Testing

  1. Open TestDataAccessLayer folder in terminal
  2. Set connection string
  • dotnet user-secrets set conn "***"
  1. Install dotnet-ef
  • dotnet tool restore
  1. Use the following commands to add migrations / update DB
  • dotnet dotnet-ef migrations add MyMigr --context TestContext --project TestDataAccessLayer.csproj --startup-project ../TestEntryPoint/TestEntryPoint.csproj
  • dotnet dotnet-ef database update --context TestContext --project TestDataAccessLayer.csproj --startup-project ../TestEntryPoint/TestEntryPoint.csproj
  • dotnet dotnet-ef migrations script TestMigr Meetup1 --context TestContext --project TestDataAccessLayer.csproj --startup-project ../TestEntryPoint/TestEntryPoint.csproj

Breaking changes

When updating from 2.x to 3.x delete lines with AddDbContextServicesExtension and AddDesignTimeServicesExtension (all configuration is done now in UseSqlObjects).