๐Ÿ“‘ Documentation: 20250303183821_UpdateColumnTypeOnPayrollFringe2.Designer.cs

Path:
IrbyImaging.DbContext/Migrations/20250303183821_UpdateColumnTypeOnPayrollFringe2.Designer.cs


๐Ÿ“‹ Table of Contents

  1. Overview & Purpose
  2. Key Functional Areas
  3. Dependencies & Technologies
  4. Data Model Snapshot
    4.1 PayrollFringe Entity
    4.2 DBACodeGrossPay Entity
    4.3 Entity Relationship Diagram
  5. How EF Core Migrations Work
  6. Usage Examples
  7. Best Practices & Recommendations
  8. Troubleshooting & Error Handling
  9. Conclusion

1. Overview & Purpose

This auto-generated Designer file is part of an EF Core Migration named
20250303183821_UpdateColumnTypeOnPayrollFringe2. It represents a snapshot
of your application's data model after applying that schema change.

  • ๐Ÿ”ง Purpose
    • Capture the current shape of all entities, properties, keys, indices,
      relationships, and table mappings.
    • Enable EF Core to calculate Up / Down methods in the companion
      *.cs migration file.
    • Support tooling (e.g., dotnet ef database update) in synchronizing your
      code model with the database schema.

Note: You should never edit Designer files manually. Any changes to
the model should be done via your domain classes or a new migration.


2. Key Functional Areas

Area Description
๐ŸŽฏ Model Snapshot protected override void BuildTargetModel(ModelBuilder modelBuilder) defines the entire EF Core model using the Fluent API.
๐Ÿ› ๏ธ Annotations & Conventions .HasAnnotation(...) and UseIdentityColumns() configure provider-specific conventions (here, SQL Server).
๐Ÿ’ผ Entity Configurations For each DomainClass, properties are mapped to SQL types, keys, indices, table names, and schemas (.ToTable("X", "irby")).
๐Ÿ”„ Relationship Mappings Defines foreign keys & navigation properties (.HasOne(...).WithMany(...)) to enforce referential integrity.
๐Ÿ”ข Column Type Adjustments (Migration) The name suggests a change in column types for the PayrollFringe entityโ€”e.g., adjusting precision of decimal columns, updated in this snapshot.

3. Dependencies & Technologies

  • .NET Version: 9.0.0
  • Entity Framework Core: 9.0.0
  • Provider: Microsoft.EntityFrameworkCore.SqlServer
  • Key Namespaces:
    • Microsoft.EntityFrameworkCore
    • Microsoft.EntityFrameworkCore.Metadata
    • Microsoft.EntityFrameworkCore.Migrations
    • Microsoft.EntityFrameworkCore.Storage.ValueConversion

4. Data Model Snapshot

Below we drill into two core entities impacted by this migration: PayrollFringe
and its child DBACodeGrossPay.

4.1 PayrollFringe Entity

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

    b.Property<decimal>("ActualHrsWorkedForWeek")
     .HasColumnType("decimal(18,2)");

    b.Property<decimal>("TotalGrossPay")
     .HasColumnType("decimal(18,2)");

    // ... many other decimal and string properties ...

    b.Property<Guid>("EmployeeId")
     .HasColumnType("uniqueidentifier");

    b.Property<DateTime>("SelectedDate")
     .HasColumnType("datetime2");

    b.HasKey("Id");
    b.HasIndex("EmployeeId");
    b.ToTable("PayrollFringe", "irby");
});
Property CLR Type SQL Type Notes
Id Guid uniqueidentifier Primary Key, generated on add
ActualHrsWorkedForWeek decimal decimal(18,2) Precision set explicitly
TotalGrossPay decimal decimal(18,2) Precision set explicitly
EmployeeId Guid uniqueidentifier Foreign Key to Employee
SelectedDate DateTime datetime2 Date of the payroll snapshot

๐Ÿ”— Relationship

b.HasOne("IrbyImaging.DomainClasses.Employee", "PayrollEmployee")
 .WithMany()
 .HasForeignKey("EmployeeId")
 .OnDelete(DeleteBehavior.Cascade);

4.2 DBACodeGrossPay Entity

modelBuilder.Entity("IrbyImaging.DomainClasses.DBACodeGrossPay", b =>
{
    b.Property<int>("Id")
     .ValueGeneratedOnAdd()
     .HasColumnType("int");               // Identity column

    b.Property<string>("DBACode")
     .HasColumnType("nvarchar(max)");

    b.Property<decimal>("GrossPayAmount")
     .HasColumnType("decimal(18,2)");

    b.Property<Guid?>("PayrollFringeId")
     .HasColumnType("uniqueidentifier");

    b.HasKey("Id");
    b.HasIndex("PayrollFringeId");
    b.ToTable("DBACodeGrossPay");
});
Property CLR Type SQL Type Notes
Id int int Primary Key, identity
DBACode string nvarchar(max) Union DBA code
GrossPayAmount decimal decimal(18,2) Precision set explicitly
PayrollFringeId Guid? uniqueidentifier FK to PayrollFringe

๐Ÿ”— Relationship

b.HasOne("IrbyImaging.DomainClasses.PayrollFringe", null)
 .WithMany("DBACodeGrossPays")
 .HasForeignKey("PayrollFringeId");

4.3 Entity Relationship Diagram

erDiagram
    PayrollFringe ||--o{ DBACodeGrossPay : Contains
    PayrollFringe {
      Guid    Id PK
      decimal ActualHrsWorkedForWeek
      ...
      Guid    EmployeeId FK
    }
    DBACodeGrossPay {
      int     Id PK
      string  DBACode
      decimal GrossPayAmount
      Guid?   PayrollFringeId FK
    }

5. How EF Core Migrations Work

  1. Design-Time Model Snapshot (Designer File)

    • Captures the entire model at a given migration point.
    • EF Core compares snapshots to compute the ฮ” (Up/Down).
  2. Migration Class (.cs)

    • Contains Up() and Down() methods to apply or revert schema changes.
  3. Applying a Migration

    dotnet ef database update 20250303183821_UpdateColumnTypeOnPayrollFringe2
    
  4. Adding a New Migration

    dotnet ef migrations add YourNewMigrationName
    

6. Usage Examples

  • Update Database to This Migration

    dotnet ef database update
    
  • Rollback Last Migration

    dotnet ef database update LastGoodMigrationName
    
  • Re-scaffold Model Snapshot
    If you edit domain classes, add a new migration to refresh the snapshot:

    dotnet ef migrations add RefreshModelSnapshot
    

7. Best Practices & Recommendations

  • โญ Do Not Edit Designer files manuallyโ€”they are regenerated on every migration.
  • โญ Name migrations clearly (UpdateColumnTypeOnPayrollFringe2 tells the story).
  • โญ Review Up() / Down() methods in the primary migration file, not the Designer.
  • โญ Keep your domain classes in sync with DB mappings (Data Annotations or Fluent API).

8. Troubleshooting & Error Handling

Symptom Likely Cause Remedy
Conflicting columns after update Manual edits to Designer or migration classes Revert manual changes; re-scaffold by deleting and re-adding migration
Model snapshot out of sync Domain classes changed, no new migration Run dotnet ef migrations add and database update
Foreign key issues Relationship mismatch in domain classes vs. snapshot Ensure navigation/annotation matches expected FK configuration

9. Conclusion

This Designer file is a blueprint of your EF Core model at the
20250303183821_UpdateColumnTypeOnPayrollFringe2 migration point. It serves
as a vital reference for EF Core to track schema changes and keep your code
and database in harmony.

๐Ÿš€ Tip: Always generate new migrations through the EF CLI and keep
your snapshots cleanโ€”this ensures smooth deployments and reliable schema
evolution.

Happy coding! ๐ŸŽ‰