📝 Documentation: 20250227173147_UpdateFieldTimesheetCrew.Designer.cs

Path: IrbyImaging.DbContext/Migrations/20250227173147_UpdateFieldTimesheetCrew.Designer.cs
Generated by: Entity Framework Core 9.0.0
Purpose: Model snapshot for the UpdateFieldTimesheetCrew migration


📑 Table of Contents

  1. 🔍 Overview & Purpose
  2. ⚙️ EF Core Migrations & .Designer.cs Files
  3. 🏗️ BuildTargetModel Method
  4. 📊 Key Functional Areas & Affected Entities
  5. 🗺️ UML Diagram
  6. 🚀 Usage & EF CLI Commands
  7. 🎯 Conclusion & Best Practices

🔍 Overview & Purpose

This auto-generated .Designer.cs file is part of the Entity Framework Core Migrations pipeline. It captures a snapshot of the EF Core model after applying the UpdateFieldTimesheetCrew migration.

  • It does not contain the actual database-altering code (Up/Down methods)—that resides in the paired 20250227173147_UpdateFieldTimesheetCrew.cs.
  • Instead, it reconstructs the full model schema so EF Core can diff between migrations and generate accurate SQL scripts.

Why this matters

  • Ensures your C# domain classes and your database schema stay in sync.
  • Serves as a “model snapshot” for future migrations.

⚙️ EF Core Migrations & .Designer.cs Files

File Name Role
20250227173147_UpdateFieldTimesheetCrew.cs Defines Up() / Down() migration steps (DDL changes).
20250227173147_UpdateFieldTimesheetCrew.Designer.cs Rebuilds the full EF model at this migration point via BuildTargetModel(ModelBuilder).

🔒 Note:

  • Do not manually edit .Designer.cs files—they are regenerated whenever you scaffold a new migration.
  • Your source control should include both the .cs and .Designer.cs for every migration.

🏗️ BuildTargetModel Method

At the heart of this file is the BuildTargetModel method. It instructs EF Core how to configure the in-memory ModelBuilder so it matches your domain classes and Fluent‑API / Data‑Annotations settings.

[DbContext(typeof(IrbyContext))]
[Migration("20250227173147_UpdateFieldTimesheetCrew")]
partial class UpdateFieldTimesheetCrew
{
    protected override void BuildTargetModel(ModelBuilder modelBuilder)
    {
        // Product version & identity column config
        modelBuilder
            .HasAnnotation("ProductVersion", "9.0.0")
            .HasAnnotation("Relational:MaxIdentifierLength", 128);
        SqlServerModelBuilderExtensions.UseIdentityColumns(modelBuilder);

        // ——— Entity Registrations ———
        modelBuilder.Entity("IrbyImaging.DomainClasses.FieldTimesheet", b =>
        {
            b.Property<Guid>("TimesheetId")
             .ValueGeneratedOnAdd()
             .HasColumnType("uniqueidentifier");

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

            // ... other properties ...

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

            b.HasKey("TimesheetId");
            b.ToTable("FieldTimesheet", "irby");
        });

        // ... thousands of other entities (AccountBalances, Job, Employee, etc.) ...

        // ——— Relationships ———
        modelBuilder.Entity("IrbyImaging.DomainClasses.EmployeeTimesheet", b =>
        {
            b.HasOne("IrbyImaging.DomainClasses.FieldTimesheet", "Timesheet")
             .WithMany("EmployeeTimesheets")
             .HasForeignKey("TimesheetId")
             .OnDelete(DeleteBehavior.Cascade);
        });
        // ... more relationship mappings ...
    }
}

Key Points

  • Annotations (HasAnnotation) record EF version and conventions.
  • UseIdentityColumns activates SQL Server identity (auto‑increment) support.
  • Entity registrations list every domain class, its properties, column types, keys, indexes, and table mapping.
  • Relationship mappings (HasOne/WithMany) wire up navigation properties and foreign keys.

📊 Key Functional Areas & Affected Entities

While this model snapshot covers all entities in the IrbyContext, the UpdateFieldTimesheetCrew migration specifically targets changes around the FieldTimesheet ↔️ Crew relationship.

FieldTimesheet

Represents a daily timesheet for a crew in the field.

Property Type Description
TimesheetId Guid (PK) Unique identifier
ApprovedBy string Who approved the timesheet
ApprovedDate DateTime Approval timestamp
Comments string Foreman or office comments
CreatedDate DateTime When the sheet was created
CrewId Guid FK to Crew.CrewId
ForemanSignature string Digital signature of the foreman
ReviewedBy string Who reviewed the sheet
ReviewedDate DateTime Review timestamp
Status int Approval workflow status enum
SubmittedBy string Who submitted the sheet
SubmittedDate DateTime Submission timestamp

🔍 After migration:

  • The snapshot shows the CrewId column is still present.
  • However, you may notice no navigation mapping (HasOne(...).WithMany(...)) to Crew.
  • This hints that the migration removed the navigation property or foreign key constraint in the domain model.

Crew

Groups employees under a job assignment.

Property Type Description
CrewId Guid (PK) Unique identifier
CrewName string Friendly name
JobId Guid FK to Job.JobId

No direct relationship to FieldTimesheet is shown in the snapshot—see migration effects!

EmployeeTimesheet & EquipmentTimesheet

These join entities connect an individual employee or equipment entry to a FieldTimesheet.

// EmployeeTimesheet (links FieldTimesheet ↔ Employee)
b.HasOne("FieldTimesheet","Timesheet")
 .WithMany("EmployeeTimesheets")
 .HasForeignKey("TimesheetId")
 .OnDelete(DeleteBehavior.Cascade);

// EquipmentTimesheet (links FieldTimesheet ↔ Equipment)
b.HasOne("FieldTimesheet","Timesheet")
 .WithMany("EquipmentTimesheets")
 .HasForeignKey("TimesheetId")
 .OnDelete(DeleteBehavior.Cascade);

🗺️ UML Diagram

Below is a simplified UML representation highlighting FieldTimesheet, Crew, and their neighbors.

@startuml
class FieldTimesheet {
  +Guid TimesheetId
  +string ApprovedBy
  +DateTime ApprovedDate
  +string Comments
  +Guid CrewId
  +DateTime CreatedDate
  +string ForemanSignature
  +bool IsDeleted
  +string ReviewedBy
  +DateTime ReviewedDate
  +int Status
  +string SubmittedBy
  +DateTime SubmittedDate
}
class Crew {
  +Guid CrewId
  +string CrewName
  +Guid JobId
}
class EmployeeTimesheet { +Guid EmployeeTimesheetId }
class EquipmentTimesheet { +Guid EquipmentTimesheetId }

FieldTimesheet "1" -- "0..*" EmployeeTimesheet : contains
FieldTimesheet "1" -- "0..*" EquipmentTimesheet : contains
' Potential FK (removed or added by migration):
' FieldTimesheet --> Crew : CrewId
@enduml

🚀 Usage & EF CLI Commands

  1. Add a new migration
    dotnet ef migrations add UpdateFieldTimesheetCrew
    
  2. Apply migrations to the database
    dotnet ef database update
    
  3. Generate a SQL script for review
    dotnet ef migrations script \
      20250227173146_PreviousMigration \
      20250227173147_UpdateFieldTimesheetCrew \
      --output UpdateFieldTimesheetCrew.sql
    

💡 Tip: Always review the generated SQL file before applying to production databases.


🎯 Conclusion & Best Practices

  • Snapshot Integrity: The .Designer.cs file is your “ground truth” of the EF Core model at this migration point.
  • Review Changes: Inspect both the main migration file (.cs) and the snapshot (.Designer.cs) to understand schema evolutions.
  • Source Control: Commit both files so your team can track and apply identical migrations.
  • Never Edit Auto‑Generated Code: If you need custom behavior, update your domain classes or Fluent API and scaffold a new migration.

🚀 Now you’re armed with a detailed understanding of how the UpdateFieldTimesheetCrew migration’s .Designer.cs snapshot works. Enjoy maintaining a reliable code-first schema evolution process!