RazorPages

DotNet Razor Pages Entity Framework Core - Code First Fluent API Approach Sample

In this approach, we model our entities and database context along with Entity Type Configuration. Then either using Migrations or DB Initializer, we create the database.

Razor Pages can make coding page-focused scenarios easier and more productive than using controllers and views.

Language : C#
.Net Version : >=6.0

Dependency NuGet Packages

• Microsoft.AspNetCore.App>=6.0
• Microsoft.NETCore.App>=6.0
• Microsoft.EntityFrameworkCore.Tools>=6.0
• Microsoft.EntityFrameworkCore.SqlServer>=6.0
• Microsoft.VisualStudio.Web.CodeGeneration.Design>=6.0

Pre-Requisites

• Visual Studio IDE
• Microsoft SQL Server
• Azure Data Studio / SQL Server Management Studio (SSMS) / SSDT for Visual Studio

Execution Steps

1. Have SQL Server ready with either existing or no database and get/make connection string.
2. Update SQL Connection String in appsettings.json.
   • Integrated Security = True for Windows Authentication.
   • User Id={Username}; Password={Password} for Standard Security.

   "ConnectionStrings": {
       "DefaultConnection": "Server={ServerName};Database={DatabaseName};Integrated Security=True"
   }

3. Run DotNet.EFCore.CodeFirstFluentApi.RazorApp project. Check CRUD (Create-Read-Update-Delete) operations against database using Entity Framework Core.

Implementation Steps

1. Skeleton Code Structure as per requirements.

2. Add dependent NuGet Packages.

   • Microsoft.EntityFrameworkCore.Tools
   • Microsoft.EntityFrameworkCore.SqlServer

3. Have SQL Server ready with either existing or no database and get/make connection string.

4. Update SQL Connection String in appsettings.json.

   • Integrated Security = True for Windows Authentication.
   • User Id={Username}; Password={Password} for Standard Security.

   "ConnectionStrings": {
       "DefaultConnection": "{SQL Connection String}"
   }

5. Create Models, Entity Type Configuration and Database Context.

   • Update OnConfiguring method in DbContext for getting connection string from JSON config file or some secure vault like Azure Key Vault etc.

     optionsBuilder.UseSqlServer(connectionString, options => options.EnableRetryOnFailure());

   • Update OnModelCreating method in DbContext for adding/applying Entity Type Configuration on ModelBuilder.

     // Default Schema
      modelBuilder.HasDefaultSchema("dbo");
     
     // Apply entity type configuration
      modelBuilder.ApplyConfiguration(new EmployeeConfiguration());

6. Launch Package Manager Console. Choose project with EF NuGet Packages Installed (E.g., DotNet.EFCore.CodeFirstFluentApi.RazorApp) as Default and Startup Project.

   Visual Studio IDE --> Tools --> NuGet Package Manager --> Package Manager Console

7. Create Database and Tables using Entity Framework Core or Entity Framework.

   • Automated Migration
     • DB Initializer - C# code to ensure database creation and its data.
     • Enable Migration with Automatic MigrationsEnabled (Entity Framework).
   • Code Migration
     • Migration commands to migrate database to latest version. (E.g., Add-Migration, Update-Database etc.)

8. Create DB Initializer with a method injected with DB Context. Then add required entities and data to the context and save changes.

   public static class MyDbInitializer
   {
        public static void Initialize(MyDbContext context)
        {
            // Ensuring Database context exists when Database exists or newly created.
            context.Database.EnsureCreated();
   
            if (context.Employees.Any())
                return; // Db has been seeded
   
            // Employees Sample Data
            var employees = new Employee[]
            {
               Name = "Arjun", Email = "arjun@abc.com", Phone = 9876543210, IsActive = true }
            };
            
            // Adding Entities sample data to Context
            context.Employees.AddRange(employees);
   
            // Saving Changes to DB Context
            context.SaveChanges();
        }
    }

9. [OPTIONAL] Entity Framework Option - Enable Automatic Migrations using below command. Once executed, it will create an internal sealed Configuration class derived from DbMigrationConfiguration in the Migrations folder.

   Enable-Migrations –EnableAutomaticMigration:$true

   Set the database initializer in the context class to

   MigrateDatabaseToLatestVersion.
   Database.SetInitializer(new MigrateDatabaseToLatestVersion<{DBContext Name}, EF6Console.Migrations.Configuration>());

10. Commands for Code Migration (either 8 or this step).

    Entity Framework Commands

    Enable-Migrations
    Add-Migration {MigrationName}
    Update-Database -Verbose

    Entity Framework Core Commands

    EntityFrameworkCore\Enable-Migrations
    EntityFrameworkCore\Add-Migration {MigrationName}
    EntityFrameworkCore\Update-Database -Verbose

11. Run DotNet.EFCore.CodeFirstFluentApi.RazorApp project. Check CRUD (Create-Read-Update-Delete) operations against database using Entity Framework Core.

12. Register DbContext and DB Initializer in Application Builder Services Collection before performing Application Build either in Program.cs or Startup.cs.

    builder.Services.AddDbContext<{DB Context Name}>();
    MyDbInitializer.Initialize(new {DB Context Name}());

13. Now DbContext can be injected in Page .cs file (page.cshml.cs) and can be used to access database.

14. Create Razor Page under Pages with Folder Organization with either Razor Page with Entity Framework Core (CRUD) or Razor Page Empty.

15. [OPTIONAL] Implement either Repository/Unit of Work(UoW)/Factory Pattern etc., to separte operations based on entity using injected DbContext.

16. Pass transactional data to Pages using Models.

References

EntityFrameworkCore
.Net Core Razor Pages
EF Core - Razor Pages
EFCore - Get Started
EF Core - Fluent API
EF Core - Modeling

🔥 Happy Coding