add mapping attribute support

loresoft · Jul 9, 2024 · acd2ddc · acd2ddc
1 parent 89e0b4e
commit acd2ddc
Show file tree

Hide file tree

Showing 20 changed files with 213 additions and 12 deletions.
diff --git a/docs/configuration.md b/docs/configuration.md
@@ -82,7 +82,8 @@ data:
     relationshipNaming: Preserve|Plural|Suffix
     #include XML documentation
     document: false
-
+    #include mapping attributes on the entity classes
+    mappingAttributes: true
     # Generate class names with prefixed schema name eg. dbo.MyTable = DboMyTable
     prefixWithSchemaName: false
 

diff --git a/docs/ef/entity.md b/docs/ef/entity.md
@@ -103,6 +103,10 @@ Control if class names should be generated with schema name prefixed eg. dbo.MyT
 
 Include XML documentation for the generated class. Default: `false`
 
+### mappingAttributes
+
+Include mapping attributes on the entity classes. Default: `false`
+
 ### renaming
 
 Rename entities and properties with regular expressions

diff --git a/sample/Tracker/Tracker.Core/Data/Entities/Audit.cs b/sample/Tracker/Tracker.Core/Data/Entities/Audit.cs
@@ -7,6 +7,7 @@ namespace Tracker.Core.Data.Entities;
 /// <summary>
 /// Entity class representing data for table 'Audit'.
 /// </summary>
+[System.ComponentModel.DataAnnotations.Schema.Table("Audit", Schema = "dbo")]
 public partial class Audit : IHaveIdentifier
 {
     /// <summary>
@@ -25,6 +26,8 @@ public Audit()
     /// <value>
     /// The property value representing column 'Id'.
     /// </value>
+    [System.ComponentModel.DataAnnotations.Key()]
+    [System.ComponentModel.DataAnnotations.Schema.Column("Id", TypeName = "uniqueidentifier")]
     public Guid Id { get; set; }
 
     /// <summary>
@@ -33,6 +36,7 @@ public Audit()
     /// <value>
     /// The property value representing column 'Date'.
     /// </value>
+    [System.ComponentModel.DataAnnotations.Schema.Column("Date", TypeName = "datetime")]
     public DateTime Date { get; set; }
 
     /// <summary>
@@ -41,6 +45,7 @@ public Audit()
     /// <value>
     /// The property value representing column 'UserId'.
     /// </value>
+    [System.ComponentModel.DataAnnotations.Schema.Column("UserId", TypeName = "uniqueidentifier")]
     public Guid? UserId { get; set; }
 
     /// <summary>
@@ -49,6 +54,7 @@ public Audit()
     /// <value>
     /// The property value representing column 'TaskId'.
     /// </value>
+    [System.ComponentModel.DataAnnotations.Schema.Column("TaskId", TypeName = "uniqueidentifier")]
     public Guid? TaskId { get; set; }
 
     /// <summary>
@@ -57,6 +63,7 @@ public Audit()
     /// <value>
     /// The property value representing column 'Content'.
     /// </value>
+    [System.ComponentModel.DataAnnotations.Schema.Column("Content", TypeName = "nvarchar(max)")]
     public string Content { get; set; } = null!;
 
     /// <summary>
@@ -65,6 +72,7 @@ public Audit()
     /// <value>
     /// The property value representing column 'Username'.
     /// </value>
+    [System.ComponentModel.DataAnnotations.Schema.Column("Username", TypeName = "nvarchar(50)")]
     public string Username { get; set; } = null!;
 
     /// <summary>
@@ -73,6 +81,7 @@ public Audit()
     /// <value>
     /// The property value representing column 'Created'.
     /// </value>
+    [System.ComponentModel.DataAnnotations.Schema.Column("Created", TypeName = "datetimeoffset")]
     public DateTimeOffset Created { get; set; }
 
     /// <summary>
@@ -81,6 +90,7 @@ public Audit()
     /// <value>
     /// The property value representing column 'CreatedBy'.
     /// </value>
+    [System.ComponentModel.DataAnnotations.Schema.Column("CreatedBy", TypeName = "nvarchar(100)")]
     public string? CreatedBy { get; set; }
 
     /// <summary>
@@ -89,6 +99,7 @@ public Audit()
     /// <value>
     /// The property value representing column 'Updated'.
     /// </value>
+    [System.ComponentModel.DataAnnotations.Schema.Column("Updated", TypeName = "datetimeoffset")]
     public DateTimeOffset Updated { get; set; }
 
     /// <summary>
@@ -97,6 +108,7 @@ public Audit()
     /// <value>
     /// The property value representing column 'UpdatedBy'.
     /// </value>
+    [System.ComponentModel.DataAnnotations.Schema.Column("UpdatedBy", TypeName = "nvarchar(100)")]
     public string? UpdatedBy { get; set; }
 
     /// <summary>
@@ -105,6 +117,9 @@ public Audit()
     /// <value>
     /// The property value representing column 'RowVersion'.
     /// </value>
+    [System.ComponentModel.DataAnnotations.ConcurrencyCheck()]
+    [System.ComponentModel.DataAnnotations.Schema.Column("RowVersion", TypeName = "rowversion")]
+    [System.ComponentModel.DataAnnotations.Schema.DatabaseGenerated(System.ComponentModel.DataAnnotations.Schema.DatabaseGeneratedOption.Computed)]
     public Byte[] RowVersion { get; set; } = null!;
 
     #endregion

diff --git a/sample/Tracker/Tracker.Core/Data/Entities/Priority.cs b/sample/Tracker/Tracker.Core/Data/Entities/Priority.cs
@@ -8,6 +8,7 @@ namespace Tracker.Core.Data.Entities;
 /// <summary>
 /// Entity class representing data for table 'Priority'.
 /// </summary>
+[System.ComponentModel.DataAnnotations.Schema.Table("Priority", Schema = "dbo")]
 public partial class Priority : IHaveIdentifier, ITrackCreated, ITrackUpdated
 {
     /// <summary>
@@ -27,6 +28,8 @@ public Priority()
     /// <value>
     /// The property value representing column 'Id'.
     /// </value>
+    [System.ComponentModel.DataAnnotations.Key()]
+    [System.ComponentModel.DataAnnotations.Schema.Column("Id", TypeName = "uniqueidentifier")]
     public Guid Id { get; set; }
 
     /// <summary>
@@ -35,6 +38,7 @@ public Priority()
     /// <value>
     /// The property value representing column 'Name'.
     /// </value>
+    [System.ComponentModel.DataAnnotations.Schema.Column("Name", TypeName = "nvarchar(100)")]
     public string Name { get; set; } = null!;
 
     /// <summary>
@@ -43,6 +47,7 @@ public Priority()
     /// <value>
     /// The property value representing column 'Description'.
     /// </value>
+    [System.ComponentModel.DataAnnotations.Schema.Column("Description", TypeName = "nvarchar(255)")]
     public string? Description { get; set; }
 
     /// <summary>
@@ -51,6 +56,7 @@ public Priority()
     /// <value>
     /// The property value representing column 'DisplayOrder'.
     /// </value>
+    [System.ComponentModel.DataAnnotations.Schema.Column("DisplayOrder", TypeName = "int")]
     public int DisplayOrder { get; set; }
 
     /// <summary>
@@ -59,6 +65,7 @@ public Priority()
     /// <value>
     /// The property value representing column 'IsActive'.
     /// </value>
+    [System.ComponentModel.DataAnnotations.Schema.Column("IsActive", TypeName = "bit")]
     public bool IsActive { get; set; }
 
     /// <summary>
@@ -67,6 +74,7 @@ public Priority()
     /// <value>
     /// The property value representing column 'Created'.
     /// </value>
+    [System.ComponentModel.DataAnnotations.Schema.Column("Created", TypeName = "datetimeoffset")]
     public DateTimeOffset Created { get; set; }
 
     /// <summary>
@@ -75,6 +83,7 @@ public Priority()
     /// <value>
     /// The property value representing column 'CreatedBy'.
     /// </value>
+    [System.ComponentModel.DataAnnotations.Schema.Column("CreatedBy", TypeName = "nvarchar(100)")]
     public string? CreatedBy { get; set; }
 
     /// <summary>
@@ -83,6 +92,7 @@ public Priority()
     /// <value>
     /// The property value representing column 'Updated'.
     /// </value>
+    [System.ComponentModel.DataAnnotations.Schema.Column("Updated", TypeName = "datetimeoffset")]
     public DateTimeOffset Updated { get; set; }
 
     /// <summary>
@@ -91,6 +101,7 @@ public Priority()
     /// <value>
     /// The property value representing column 'UpdatedBy'.
     /// </value>
+    [System.ComponentModel.DataAnnotations.Schema.Column("UpdatedBy", TypeName = "nvarchar(100)")]
     public string? UpdatedBy { get; set; }
 
     /// <summary>
@@ -99,6 +110,9 @@ public Priority()
     /// <value>
     /// The property value representing column 'RowVersion'.
     /// </value>
+    [System.ComponentModel.DataAnnotations.ConcurrencyCheck()]
+    [System.ComponentModel.DataAnnotations.Schema.Column("RowVersion", TypeName = "rowversion")]
+    [System.ComponentModel.DataAnnotations.Schema.DatabaseGenerated(System.ComponentModel.DataAnnotations.Schema.DatabaseGeneratedOption.Computed)]
     public Byte[] RowVersion { get; set; } = null!;
 
     #endregion

diff --git a/sample/Tracker/Tracker.Core/Data/Entities/Role.cs b/sample/Tracker/Tracker.Core/Data/Entities/Role.cs
@@ -7,6 +7,7 @@ namespace Tracker.Core.Data.Entities;
 /// <summary>
 /// Entity class representing data for table 'Role'.
 /// </summary>
+[System.ComponentModel.DataAnnotations.Schema.Table("Role", Schema = "dbo")]
 public partial class Role : IHaveIdentifier, ITrackCreated, ITrackUpdated
 {
     /// <summary>
@@ -26,6 +27,8 @@ public Role()
     /// <value>
     /// The property value representing column 'Id'.
     /// </value>
+    [System.ComponentModel.DataAnnotations.Key()]
+    [System.ComponentModel.DataAnnotations.Schema.Column("Id", TypeName = "uniqueidentifier")]
     public Guid Id { get; set; }
 
     /// <summary>
@@ -34,6 +37,7 @@ public Role()
     /// <value>
     /// The property value representing column 'Name'.
     /// </value>
+    [System.ComponentModel.DataAnnotations.Schema.Column("Name", TypeName = "nvarchar(256)")]
     public string Name { get; set; } = null!;
 
     /// <summary>
@@ -42,6 +46,7 @@ public Role()
     /// <value>
     /// The property value representing column 'Description'.
     /// </value>
+    [System.ComponentModel.DataAnnotations.Schema.Column("Description", TypeName = "nvarchar(max)")]
     public string? Description { get; set; }
 
     /// <summary>
@@ -50,6 +55,7 @@ public Role()
     /// <value>
     /// The property value representing column 'Created'.
     /// </value>
+    [System.ComponentModel.DataAnnotations.Schema.Column("Created", TypeName = "datetimeoffset")]
     public DateTimeOffset Created { get; set; }
 
     /// <summary>
@@ -58,6 +64,7 @@ public Role()
     /// <value>
     /// The property value representing column 'CreatedBy'.
     /// </value>
+    [System.ComponentModel.DataAnnotations.Schema.Column("CreatedBy", TypeName = "nvarchar(100)")]
     public string? CreatedBy { get; set; }
 
     /// <summary>
@@ -66,6 +73,7 @@ public Role()
     /// <value>
     /// The property value representing column 'Updated'.
     /// </value>
+    [System.ComponentModel.DataAnnotations.Schema.Column("Updated", TypeName = "datetimeoffset")]
     public DateTimeOffset Updated { get; set; }
 
     /// <summary>
@@ -74,6 +82,7 @@ public Role()
     /// <value>
     /// The property value representing column 'UpdatedBy'.
     /// </value>
+    [System.ComponentModel.DataAnnotations.Schema.Column("UpdatedBy", TypeName = "nvarchar(100)")]
     public string? UpdatedBy { get; set; }
 
     /// <summary>
@@ -82,6 +91,9 @@ public Role()
     /// <value>
     /// The property value representing column 'RowVersion'.
     /// </value>
+    [System.ComponentModel.DataAnnotations.ConcurrencyCheck()]
+    [System.ComponentModel.DataAnnotations.Schema.Column("RowVersion", TypeName = "rowversion")]
+    [System.ComponentModel.DataAnnotations.Schema.DatabaseGenerated(System.ComponentModel.DataAnnotations.Schema.DatabaseGeneratedOption.Computed)]
     public Byte[] RowVersion { get; set; } = null!;
 
     #endregion

diff --git a/sample/Tracker/Tracker.Core/Data/Entities/Status.cs b/sample/Tracker/Tracker.Core/Data/Entities/Status.cs
@@ -7,6 +7,7 @@ namespace Tracker.Core.Data.Entities;
 /// <summary>
 /// Entity class representing data for table 'Status'.
 /// </summary>
+[System.ComponentModel.DataAnnotations.Schema.Table("Status", Schema = "dbo")]
 public partial class Status : IHaveIdentifier, ITrackCreated, ITrackUpdated
 {
     /// <summary>
@@ -26,6 +27,8 @@ public Status()
     /// <value>
     /// The property value representing column 'Id'.
     /// </value>
+    [System.ComponentModel.DataAnnotations.Key()]
+    [System.ComponentModel.DataAnnotations.Schema.Column("Id", TypeName = "uniqueidentifier")]
     public Guid Id { get; set; }
 
     /// <summary>
@@ -34,6 +37,7 @@ public Status()
     /// <value>
     /// The property value representing column 'Name'.
     /// </value>
+    [System.ComponentModel.DataAnnotations.Schema.Column("Name", TypeName = "nvarchar(100)")]
     public string Name { get; set; } = null!;
 
     /// <summary>
@@ -42,6 +46,7 @@ public Status()
     /// <value>
     /// The property value representing column 'Description'.
     /// </value>
+    [System.ComponentModel.DataAnnotations.Schema.Column("Description", TypeName = "nvarchar(255)")]
     public string? Description { get; set; }
 
     /// <summary>
@@ -50,6 +55,7 @@ public Status()
     /// <value>
     /// The property value representing column 'DisplayOrder'.
     /// </value>
+    [System.ComponentModel.DataAnnotations.Schema.Column("DisplayOrder", TypeName = "int")]
     public int DisplayOrder { get; set; }
 
     /// <summary>
@@ -58,6 +64,7 @@ public Status()
     /// <value>
     /// The property value representing column 'IsActive'.
     /// </value>
+    [System.ComponentModel.DataAnnotations.Schema.Column("IsActive", TypeName = "bit")]
     public bool IsActive { get; set; }
 
     /// <summary>
@@ -66,6 +73,7 @@ public Status()
     /// <value>
     /// The property value representing column 'Created'.
     /// </value>
+    [System.ComponentModel.DataAnnotations.Schema.Column("Created", TypeName = "datetimeoffset")]
     public DateTimeOffset Created { get; set; }
 
     /// <summary>
@@ -74,6 +82,7 @@ public Status()
     /// <value>
     /// The property value representing column 'CreatedBy'.
     /// </value>
+    [System.ComponentModel.DataAnnotations.Schema.Column("CreatedBy", TypeName = "nvarchar(100)")]
     public string? CreatedBy { get; set; }
 
     /// <summary>
@@ -82,6 +91,7 @@ public Status()
     /// <value>
     /// The property value representing column 'Updated'.
     /// </value>
+    [System.ComponentModel.DataAnnotations.Schema.Column("Updated", TypeName = "datetimeoffset")]
     public DateTimeOffset Updated { get; set; }
 
     /// <summary>
@@ -90,6 +100,7 @@ public Status()
     /// <value>
     /// The property value representing column 'UpdatedBy'.
     /// </value>
+    [System.ComponentModel.DataAnnotations.Schema.Column("UpdatedBy", TypeName = "nvarchar(100)")]
     public string? UpdatedBy { get; set; }
 
     /// <summary>
@@ -98,6 +109,9 @@ public Status()
     /// <value>
     /// The property value representing column 'RowVersion'.
     /// </value>
+    [System.ComponentModel.DataAnnotations.ConcurrencyCheck()]
+    [System.ComponentModel.DataAnnotations.Schema.Column("RowVersion", TypeName = "rowversion")]
+    [System.ComponentModel.DataAnnotations.Schema.DatabaseGenerated(System.ComponentModel.DataAnnotations.Schema.DatabaseGeneratedOption.Computed)]
     public Byte[] RowVersion { get; set; } = null!;
 
     #endregion