📝 Documentation: AddKeyToODSAssettable.Designer.cs


📑 Table of Contents

  1. Overview & Purpose
  2. EF Core Migrations Basics
  3. Migration Class Structure
  4. BuildTargetModel Method
  5. Key Change: ODSAsset Table 🔑
  6. Dependencies & Technologies
  7. Sample Code Snippets & Usage 🚀
  8. UML Diagram of ODSAsset 📊
  9. Conclusion 🎯

1. Overview & Purpose

This file is an auto-generated snapshot of your Entity Framework Core model after applying the 20240229185845_AddKeyToODSAssettable migration. It lives alongside the main migration file and is used by EF Core to:

  • Track model state between migrations
  • Compare the current model with the database schema
  • Generate subsequent migrations accurately

Note: You should not edit this file manually. Any changes to the model (e.g., adding/changing entities, keys, properties) should be done in your DbContext or domain classes, then captured via dotnet ef migrations add.


2. EF Core Migrations Basics

Concept Description
Migration A class with Up()/Down() methods to update schema.
Designer Snapshot This .Designer.cs file containing BuildTargetModel.
ModelBuilder Fluent API used to configure tables, relationships.
DbContext Represents your database session—IrbyContext.
Commands dotnet ef migrations add, dotnet ef database update

3. Migration Class Structure

[DbContext(typeof(IrbyContext))]
[Migration("20240229185845_AddKeyToODSAssettable")]
partial class AddKeyToODSAssettable
{
    /// <inheritdoc />
    protected override void BuildTargetModel(ModelBuilder modelBuilder)
    {
        // … auto-generated entity mapping …
    }
}
  • [DbContext] attribute ties this migration to IrbyContext.
  • [Migration("…")] attribute gives it a unique timestamped identifier.
  • BuildTargetModel defines the full model snapshot.

4. BuildTargetModel Method

The heart of this file is the BuildTargetModel(ModelBuilder) method. Its responsibilities:

  1. Global Annotations

    modelBuilder
      .HasAnnotation("ProductVersion", "7.0.7")
      .HasAnnotation("Relational:MaxIdentifierLength", 128);
    
    SqlServerModelBuilderExtensions.UseIdentityColumns(modelBuilder);
    
  2. Entity Configuration
    For each domain class—​from Asset to TimeSheetEntry—​this method:

    • Defines properties and types (HasColumnType)
    • Marks keys (HasKey)
    • Sets up indexes (HasIndex)
    • Declares table names and schemas (ToTable("…", "irby"))
    • Configures discriminators for inheritance (TPH)
  3. Relationships & Navigation
    At the bottom, EF’s Fluent API links entities:

    modelBuilder.Entity("IrbyImaging.DomainClasses.Asset", b => {
        b.HasOne("IrbyImaging.DomainClasses.FieldOffice", "FieldOffice")
          .WithMany("Assets")
          .HasForeignKey("FieldOfficeId");
        // …
    });
    

5. Key Change: ODSAsset Table 🔑

This migration’s purpose was to add a primary key to the ODSAsset entity—​which maps to the ODSAssets table. Below is the relevant snippet:

modelBuilder.Entity("IrbyImaging.DomainClasses.ODSAsset", b => {
    b.Property<Guid>("EquipmentId")
      .ValueGeneratedOnAdd()
      .HasColumnType("uniqueidentifier");

    // … other properties …

    b.HasKey("EquipmentId");                  // ← Primary Key added
    b.ToTable("ODSAssets");                   // ← Table name
});
Before Migration After Migration
No key defined EquipmentId marked as PK (HasKey)
Potential duplication issues Enforces unique identity per row

Why? Tables without a proper primary key cannot participate in entity tracking, updating, or EF Core relationships reliably.


6. Dependencies & Technologies 🛠️

  • .NET 7.0
  • Entity Framework Core 7.0.7
  • C# 10
  • SQL Server provider (Microsoft.EntityFrameworkCore.SqlServer)
  • EF CLI Tools: Microsoft.EntityFrameworkCore.Design

7. Sample Code Snippets & Usage 🚀

Applying the Migration

# Add the migration (already done here)
dotnet ef migrations add AddKeyToODSAssettable

# Update your database to reflect the change
dotnet ef database update

Checking the Designer Snapshot

When you open 20240229185845_AddKeyToODSAssettable.Designer.cs, you’ll see:

protected override void BuildTargetModel(ModelBuilder modelBuilder)
{
    // … many entities …
    modelBuilder.Entity("IrbyImaging.DomainClasses.ODSAsset", b => {
        b.Property<Guid>("EquipmentId")
          .ValueGeneratedOnAdd()
          .HasColumnType("uniqueidentifier");
        b.HasKey("EquipmentId");
        b.ToTable("ODSAssets");
    });
    // … relationships …
}

Rolling Back

# Revert to the previous migration
dotnet ef database update 20240229123456_PreviousMigrationId

8. UML Diagram of ODSAsset 📊

@startuml
entity "ODSAsset" as ODSAsset {
  +Guid EquipmentId <<PK>>
  +string AccountingClass
  +string AssetManufacturer
  +string AssetNumber
  +... (other properties)
}

entity "IrbyContext" {
  +DbSet<ODSAsset> ODSAssets
  ... other DbSets ...
}

IrbyContext ||--o{ ODSAsset : manages
@enduml

Legend:

  • <<PK>> denotes Primary Key
  • IrbyContext holds a DbSet<ODSAsset> named ODSAssets

9. Conclusion 🎯

  • Purpose: Ensure that every record in ODSAssets has a unique, database-enforced key.
  • Impact: Improves data integrity and enables EF Core tracking/relationships.
  • Next Steps:
    1. Verify new schema in SQL Server.
    2. Confirm application operations (CRUD) on ODSAssets work as expected.
    3. Continue normal development—​further model changes will be captured in new migrations.

Happy coding! 🖥️✨


End of Documentation