📋 Table of Contents
- Overview & Purpose
- EF Core Migrations Background
- BuildTargetModel Method Explained
- Model Snapshot & Entity Configurations
4.1. 🎫 Ticket & Update Entities
4.2. 💻 Asset Inheritance Hierarchy
4.3. 🗃️ Other Key Entities At‐a‐Glance - 🔗 Relationships & Foreign Keys
- 🔑 Indices & Constraints
- 🏷️ Table Mapping & Schemas
- ⚙️ Usage & Best Practices
- 📈 UML Diagrams
- ✅ Conclusion
1. Overview & Purpose
This file, 20220511205338_UpdateTicketTable.Designer.cs, is an auto‐generated Entity Framework Core migration designer. It captures a snapshot of the entire EF Core model after applying the UpdateTicketTable migration.
- 🛠️ Assembly:
IrbyImaging.DbContext - 📝 Author:
kvamshi - 📆 Created/Modified: 05‑17‑2022
- 📂 Namespace:
IrbyImaging.DbContext.Migrations
Why does this matter?
Every EF Core migration comes with two files:
<timestamp>_UpdateTicketTable.cs(containsUp()/Down()schema‐change methods)<timestamp>_UpdateTicketTable.Designer.cs(containsBuildTargetModelsnapshot)
The Designer file ensures EF Core can compare your current model against this snapshot to scaffold future migrations.
2. EF Core Migrations Background
Entity Framework Core migrations manage schema changes over time:
ModelSnapshot: Tracks your database schema in code.BuildTargetModel(): Reconstructs the model state after applying this migration.Up()/Down(): Implements schema changes (not shown here).
This snapshot class:
- Defines entity types, properties, keys, indexes, relationships.
- Enables EF to diff your live
DbContextvs. the last snapshot. - Should not be manually edited.
3. BuildTargetModel Method Explained
protected override void BuildTargetModel(ModelBuilder modelBuilder)
{
#pragma warning disable 612, 618
modelBuilder
.HasAnnotation("Relational:MaxIdentifierLength", 128)
.HasAnnotation("ProductVersion", "5.0.12")
.HasAnnotation("SqlServer:ValueGenerationStrategy", SqlServerValueGenerationStrategy.IdentityColumn);
// … hundreds of .Entity(…) calls configure each table
#pragma warning restore 612, 618
}
-
HasAnnotation- Configures global model annotations (identifier length, EF version, SQL Server identity strategy).
-
modelBuilder.Entity("Namespace.Type", b => { … })b.Property<T>("Name"): Defines a column type & nullability.b.HasKey("PK"): Primary key.b.HasIndex(...): Indexes & unique constraints.b.HasOne(…).WithMany(…): Relationship mapping.b.ToTable("TableName", "Schema"): Table & schema.
-
Inheritance
- Uses Table‐Per‐Hierarchy (TPH) via
HasDiscriminator<string>("Discriminator").
- Uses Table‐Per‐Hierarchy (TPH) via
4. Model Snapshot & Entity Configurations
This migration snapshot configures ~30 domain entities. Below we deep‐dive on the most relevant:
4.1. 🎫 Ticket & Update Entities
| Entity | Table | Key | Notable Properties |
|---|---|---|---|
| Ticket | irby.Ticket |
Id (GUID) |
TicketNumber (int), Type (int), Status (int), CreatedOn, ImageContents (varbinary) |
| Update | irby.Update |
Id (GUID) |
TicketId (FK), UpdatedBy, Timestamp, RequestedStatusJson |
Ticket Configuration (Excerpt)
modelBuilder.Entity("IrbyImaging.DomainClasses.Ticket", b => {
b.Property<Guid>("Id")
.ValueGeneratedOnAdd()
.HasColumnType("uniqueidentifier");
b.Property<int>("TicketNumber").HasColumnType("int");
b.Property<int>("Type").HasColumnType("int");
b.Property<int>("Status").HasColumnType("int");
b.Property<DateTime>("CreatedOn").HasColumnType("datetime2");
b.Property<byte[]>("ImageContents").HasColumnType("varbinary(max)");
// … other properties …
b.HasKey("Id");
b.ToTable("Ticket", "irby");
});
Update Configuration (Excerpt)
modelBuilder.Entity("IrbyImaging.DomainClasses.Update", b => {
b.Property<Guid>("Id")
.ValueGeneratedOnAdd()
.HasColumnType("uniqueidentifier");
b.Property<Guid>("TicketId").HasColumnType("uniqueidentifier");
b.Property<DateTime>("Timestamp").HasColumnType("datetime2");
b.Property<string>("UpdatedBy").HasColumnType("nvarchar(max)");
b.Property<string>("RequestedStatusJson").HasColumnType("nvarchar(max)");
b.HasKey("Id");
b.HasIndex("TicketId");
b.ToTable("Update", "irby");
});
4.2. 💻 Asset Inheritance Hierarchy
- Base Type:
Asset(One table:irby.Asset) - Discriminator: Column
Discriminator - Subtypes:
ComputerMobileDeviceDeskPhoneMonitorNetworkEquipmentOfficePrinterPrinterSafetyEquipmentDock
TPH mapping centralizes all asset variants in one table but distinguishes each by
Discriminator.
4.3. 🗃️ Other Key Entities At‐a‐Glance
| Entity | Table | Notes |
|---|---|---|
| AssetHistory | irby.AssetHistory |
Tracks changes per asset. |
| AssetModel | irby.AssetModel |
Model metadata, FK to Manufacturer. |
| Manufacturer | irby.AssetManufacturer |
The “make” of assets. |
| Employee | irby.Employee |
FK to Job, unique JdeNumber. |
| FieldOffice | irby.FieldOffice |
FK to Employee (Manager). |
| Job | irby.Job |
Unique JdeNumber, has many Employees. |
| BillingInvoice | irby.BillingInvoice |
Financial transactions per Carrier + GL. |
| GeneralLedger | irby.GeneralLedger |
Finance codes. |
| CarrierType | irby.CarrierType |
Shipping carriers + details. |
| DocumentImage | irby.DocumentImage |
OCR & binary storage. |
| COVIDTestData | irby.CovidTestData |
Medical test records. |
| ODS_Employee_Staging | irby.ODS_Employee_Staging |
Staging table from an external ODS source. |
| ODS_Jobs_Staging | irby.ODS_Jobs_Staging |
Same for jobs. |
| RequestOption | irby.RequestOption |
Lookup for request items. |
| TempDocumentData | irby.TempDocumentData |
Temporary import table. |
| IPMMigration | irby.IPMMigration |
IPM-specific migration staging. |
| Issue | irby.Issue |
Simple lookup of issues. |
5. 🔗 Relationships & Foreign Keys
Below are some critical FK mappings:
| Principal Entity | Navigation Property | Dependent Entity | FK Column | Cardinality |
|---|---|---|---|---|
| AssetModel | Models |
AssetModelDetail | AssetModelId |
1-to-many |
| Manufacturer | Models |
AssetModel | MakeId |
1-to-many |
| Asset | Owner |
Employee | OwnerId |
many-to-1 |
| Employee | CurrentJob |
Job | CurrentJobId |
many-to-1 |
| FieldOffice | Manager |
Employee | ManagerId |
1-to-many |
| Ticket | Updates |
Update | TicketId |
1-to-many |
| Computer/SafetyEquipment | OperatingSystem |
OperatingSystem | OperatingSystemId |
many-to-1 |
| ODS_Employee_Staging | Job |
ODS_Jobs_Staging | ORG_BU |
many-to-1 |
Navigation Properties are wired up via
.HasOne().WithMany().HasForeignKey()calls.
6. 🔑 Indices & Constraints
- Primary Keys:
.HasKey("Id")or custom naming (e.g.PrimaryKey_CovidTestDataId). - Unique Indexes:
Employee.JdeNumberFieldOffice.JdeNumberJob.JdeNumberMobileDevice.Imei
- Regular Indexes: For FKs and lookup columns to speed up joins.
b.HasIndex("JdeNumber")
.IsUnique()
.HasFilter("[JdeNumber] IS NOT NULL");
7. 🏷️ Table Mapping & Schemas
All tables are mapped with schema "irby" except a few staging tables without explicit schemas:
| Entity | .ToTable(...) |
|---|---|
| Asset & derivatives | "Asset", "irby" |
| Ticket, Update | "Ticket" / "Update", "irby" |
| … | … |
| ODS staging tables | "ODS_Employee_Staging", "irby""ODS_Jobs_Staging", "irby" |
Tip: To change schema globally, modify your
DbContext.OnModelCreatingor override table names in your entity configurations.
8. ⚙️ Usage & Best Practices
-
Applying Migrations
dotnet ef database updateThis reads your Designer snapshot +
Up()code to bring the database up to date. -
Adding Future Migrations
dotnet ef migrations add AddSomeFeature- EF Core diffs your current model vs. the last Designer snapshot.
- Generates a new
<timestamp>_AddSomeFeature.Designer.cs.
-
Avoid Manual Edits
- Do not hand‐edit Designer files; they will be overwritten.
-
Review Snapshots in Code Reviews
- Although auto‐generated, reviewing ensures unintended model changes aren’t committed.
9. 📈 UML Diagrams
classDiagram
Asset <|-- Computer
Asset <|-- MobileDevice
Asset <|-- DeskPhone
Asset <|-- Monitor
Asset <|-- NetworkEquipment
Asset <|-- OfficePrinter
Asset <|-- Printer
Asset <|-- SafetyEquipment
Ticket "1" <-- "0..*" Update : hasUpdates
AssetModel "1" <-- "0..*" AssetModelDetail : details
Manufacturer "1" <-- "0..*" AssetModel : makes
Employee "1" <-- "0..*" Asset : assets
Job "1" <-- "0..*" Employee : employees
- TPH Inheritance: Single
Assettable storing all subtypes with aDiscriminator. - 1‑to‑Many Associations: Visualized above.
10. ✅ Conclusion
The 20220511205338_UpdateTicketTable.Designer.cs file is your EF Core model snapshot at the point of the UpdateTicketTable migration. It:
- Defines every entity, property, key, index, and relationship.
- Enables EF Core to scaffold future migrations accurately.
- Should remain unaltered to maintain migration integrity.
By understanding this snapshot, you gain full visibility into your database schema as modeled in code, ensuring that future changes are safe, predictable, and well‐documented.
Happy coding! 🚀