add option to turn off temporal table mapping, add script template me…

…rge, add rowversion options
loresoft · Jan 1, 2024 · 632a023 · 632a023
1 parent d57d802
commit 632a023
Show file tree

Hide file tree

Showing 41 changed files with 347 additions and 131 deletions.
diff --git a/README.md b/README.md
@@ -155,6 +155,13 @@ Entity Framework Core Generator supports generating [Read](https://efg.loresoft.
 
 ## Change Log
 
+### Version 6.0
+
+- upgrade to .net 8
+- add option to turn off temporal table mapping
+- add rowversion options, ByteArray|Long|ULong 
+- add script template merge
+
 ### Version 5.0
 
 - add support for navigation property renames

diff --git a/docs/configuration.md b/docs/configuration.md
@@ -102,6 +102,9 @@ data:
     directory: '{Project.Directory}\Data\Mapping'   # the mapping class output directory
     #include XML documentation
     document: false
+
+    temporal: false                                 # if temporal table mapping is enabled. Default true
+    rowVersion: ByteArray|Long|ULong                # How row versions should be mapped. Default ByteArray
 
   # query extension class file configuration
   query:
@@ -191,6 +194,7 @@ script:
       namespace: '{Project.Namespace}.Domain.Context'  
       baseClass: ContextScriptBase
       overwrite: true                                  # overwrite existing file
+      merge: true                                      # merge regions with existing file
   # collection of script template with current Entity as a variable
   entity:
     - templatePath: '.\templates\entity.csx'           # path to script file
@@ -199,6 +203,7 @@ script:
       namespace: '{Project.Namespace}.Domain.Entity'  
       baseClass: EntityScriptBase
       overwrite: true                                  # overwrite existing file
+      merge: true                                      # merge regions with existing file
   # collection script template with current Model as a variable
   model:
     - templatePath: '.\templates\model.csx'            # path to script file
@@ -207,10 +212,12 @@ script:
       namespace: '{Project.Namespace}.Domain.Models'  
       baseClass: ModelScriptBase
       overwrite: true                                  # overwrite existing file
+      merge: true                                      # merge regions with existing file
     - templatePath: '.\templates\sample.csx'           # path to script file
       fileName: '{Model.Name}Sample.cs'                # filename to save script output
       directory: '{Project.Directory}\Domain\Models'   # directory to save script output
       namespace: '{Project.Namespace}.Domain.Models'  
       baseClass: ModelSampleBase
       overwrite: true                                  # overwrite existing file
+      merge: true                                      # merge regions with existing file
 ```
diff --git a/sample/Tracker/Tracker.Core/Data/Mapping/AuditMap.cs b/sample/Tracker/Tracker.Core/Data/Mapping/AuditMap.cs
@@ -79,6 +79,7 @@ public void Configure(Microsoft.EntityFrameworkCore.Metadata.Builders.EntityType
         builder.Property(t => t.RowVersion)
             .IsRequired()
             .IsRowVersion()
+            .IsConcurrencyToken()
             .HasColumnName("RowVersion")
             .HasColumnType("rowversion")
             .HasMaxLength(8)

diff --git a/sample/Tracker/Tracker.Core/Data/Mapping/PriorityMap.cs b/sample/Tracker/Tracker.Core/Data/Mapping/PriorityMap.cs
@@ -44,13 +44,14 @@ public void Configure(Microsoft.EntityFrameworkCore.Metadata.Builders.EntityType
         builder.Property(t => t.DisplayOrder)
             .IsRequired()
             .HasColumnName("DisplayOrder")
-            .HasColumnType("int");
+            .HasColumnType("int")
+            .HasDefaultValue(0);
 
         builder.Property(t => t.IsActive)
             .IsRequired()
             .HasColumnName("IsActive")
             .HasColumnType("bit")
-            .HasDefaultValueSql("((1))");
+            .HasDefaultValue(true);
 
         builder.Property(t => t.Created)
             .IsRequired()
@@ -77,6 +78,7 @@ public void Configure(Microsoft.EntityFrameworkCore.Metadata.Builders.EntityType
         builder.Property(t => t.RowVersion)
             .IsRequired()
             .IsRowVersion()
+            .IsConcurrencyToken()
             .HasColumnName("RowVersion")
             .HasColumnType("rowversion")
             .HasMaxLength(8)

diff --git a/sample/Tracker/Tracker.Core/Data/Mapping/RoleMap.cs b/sample/Tracker/Tracker.Core/Data/Mapping/RoleMap.cs
@@ -65,6 +65,7 @@ public void Configure(Microsoft.EntityFrameworkCore.Metadata.Builders.EntityType
         builder.Property(t => t.RowVersion)
             .IsRequired()
             .IsRowVersion()
+            .IsConcurrencyToken()
             .HasColumnName("RowVersion")
             .HasColumnType("rowversion")
             .HasMaxLength(8)

diff --git a/sample/Tracker/Tracker.Core/Data/Mapping/StatusMap.cs b/sample/Tracker/Tracker.Core/Data/Mapping/StatusMap.cs
@@ -44,13 +44,14 @@ public void Configure(Microsoft.EntityFrameworkCore.Metadata.Builders.EntityType
         builder.Property(t => t.DisplayOrder)
             .IsRequired()
             .HasColumnName("DisplayOrder")
-            .HasColumnType("int");
+            .HasColumnType("int")
+            .HasDefaultValueSql("((0))");
 
         builder.Property(t => t.IsActive)
             .IsRequired()
             .HasColumnName("IsActive")
             .HasColumnType("bit")
-            .HasDefaultValueSql("((1))");
+            .HasDefaultValue(true);
 
         builder.Property(t => t.Created)
             .IsRequired()
@@ -77,6 +78,7 @@ public void Configure(Microsoft.EntityFrameworkCore.Metadata.Builders.EntityType
         builder.Property(t => t.RowVersion)
             .IsRequired()
             .IsRowVersion()
+            .IsConcurrencyToken()
             .HasColumnName("RowVersion")
             .HasColumnType("rowversion")
             .HasMaxLength(8)

diff --git a/sample/Tracker/Tracker.Core/Data/Mapping/TaskExtendedMap.cs b/sample/Tracker/Tracker.Core/Data/Mapping/TaskExtendedMap.cs
@@ -68,6 +68,7 @@ public void Configure(Microsoft.EntityFrameworkCore.Metadata.Builders.EntityType
         builder.Property(t => t.RowVersion)
             .IsRequired()
             .IsRowVersion()
+            .IsConcurrencyToken()
             .HasColumnName("RowVersion")
             .HasColumnType("rowversion")
             .HasMaxLength(8)

diff --git a/sample/Tracker/Tracker.Core/Data/Mapping/TaskMap.cs b/sample/Tracker/Tracker.Core/Data/Mapping/TaskMap.cs
@@ -108,6 +108,7 @@ public void Configure(Microsoft.EntityFrameworkCore.Metadata.Builders.EntityType
         builder.Property(t => t.RowVersion)
             .IsRequired()
             .IsRowVersion()
+            .IsConcurrencyToken()
             .HasColumnName("RowVersion")
             .HasColumnType("rowversion")
             .HasMaxLength(8)

diff --git a/sample/Tracker/Tracker.Core/Data/Mapping/TenantMap.cs b/sample/Tracker/Tracker.Core/Data/Mapping/TenantMap.cs
@@ -44,7 +44,7 @@ public void Configure(Microsoft.EntityFrameworkCore.Metadata.Builders.EntityType
             .IsRequired()
             .HasColumnName("IsActive")
             .HasColumnType("bit")
-            .HasDefaultValueSql("((1))");
+            .HasDefaultValue(true);
 
         builder.Property(t => t.Created)
             .IsRequired()
@@ -71,6 +71,7 @@ public void Configure(Microsoft.EntityFrameworkCore.Metadata.Builders.EntityType
         builder.Property(t => t.RowVersion)
             .IsRequired()
             .IsRowVersion()
+            .IsConcurrencyToken()
             .HasColumnName("RowVersion")
             .HasColumnType("rowversion")
             .HasMaxLength(8)

diff --git a/sample/Tracker/Tracker.Core/Data/Mapping/UserLoginMap.cs b/sample/Tracker/Tracker.Core/Data/Mapping/UserLoginMap.cs
@@ -77,7 +77,8 @@ public void Configure(Microsoft.EntityFrameworkCore.Metadata.Builders.EntityType
         builder.Property(t => t.IsSuccessful)
             .IsRequired()
             .HasColumnName("IsSuccessful")
-            .HasColumnType("bit");
+            .HasColumnType("bit")
+            .HasDefaultValue(false);
 
         builder.Property(t => t.FailureMessage)
             .HasColumnName("FailureMessage")
@@ -109,6 +110,7 @@ public void Configure(Microsoft.EntityFrameworkCore.Metadata.Builders.EntityType
         builder.Property(t => t.RowVersion)
             .IsRequired()
             .IsRowVersion()
+            .IsConcurrencyToken()
             .HasColumnName("RowVersion")
             .HasColumnType("rowversion")
             .HasMaxLength(8)

diff --git a/sample/Tracker/Tracker.Core/Data/Mapping/UserMap.cs b/sample/Tracker/Tracker.Core/Data/Mapping/UserMap.cs
@@ -39,7 +39,8 @@ public void Configure(Microsoft.EntityFrameworkCore.Metadata.Builders.EntityType
         builder.Property(t => t.IsEmailAddressConfirmed)
             .IsRequired()
             .HasColumnName("IsEmailAddressConfirmed")
-            .HasColumnType("bit");
+            .HasColumnType("bit")
+            .HasDefaultValue(false);
 
         builder.Property(t => t.DisplayName)
             .IsRequired()
@@ -62,12 +63,14 @@ public void Configure(Microsoft.EntityFrameworkCore.Metadata.Builders.EntityType
         builder.Property(t => t.AccessFailedCount)
             .IsRequired()
             .HasColumnName("AccessFailedCount")
-            .HasColumnType("int");
+            .HasColumnType("int")
+            .HasDefaultValueSql("((0))");
 
         builder.Property(t => t.LockoutEnabled)
             .IsRequired()
             .HasColumnName("LockoutEnabled")
-            .HasColumnType("bit");
+            .HasColumnType("bit")
+            .HasDefaultValue(false);
 
         builder.Property(t => t.LockoutEnd)
             .HasColumnName("LockoutEnd")
@@ -80,7 +83,8 @@ public void Configure(Microsoft.EntityFrameworkCore.Metadata.Builders.EntityType
         builder.Property(t => t.IsDeleted)
             .IsRequired()
             .HasColumnName("IsDeleted")
-            .HasColumnType("bit");
+            .HasColumnType("bit")
+            .HasDefaultValue(false);
 
         builder.Property(t => t.Created)
             .IsRequired()
@@ -107,6 +111,7 @@ public void Configure(Microsoft.EntityFrameworkCore.Metadata.Builders.EntityType
         builder.Property(t => t.RowVersion)
             .IsRequired()
             .IsRowVersion()
+            .IsConcurrencyToken()
             .HasColumnName("RowVersion")
             .HasColumnType("rowversion")
             .HasMaxLength(8)

diff --git a/sample/Tracker/Tracker.Core/Tracker.Core.csproj b/sample/Tracker/Tracker.Core/Tracker.Core.csproj
@@ -8,7 +8,7 @@
 
   <ItemGroup>
     <PackageReference Include="AutoMapper" Version="12.0.1" />
-    <PackageReference Include="FluentValidation" Version="11.8.1" />
+    <PackageReference Include="FluentValidation" Version="11.9.0" />
     <PackageReference Include="Microsoft.EntityFrameworkCore.SqlServer" Version="8.0.0" />
   </ItemGroup>
 

diff --git a/sample/Tracker/Tracker.Scaffold/Priority.cs b/sample/Tracker/Tracker.Scaffold/Priority.cs
@@ -13,7 +13,7 @@ public partial class Priority
 
     public int DisplayOrder { get; set; }
 
-    public bool? IsActive { get; set; }
+    public bool IsActive { get; set; }
 
     public DateTimeOffset Created { get; set; }
 

diff --git a/sample/Tracker/Tracker.Scaffold/Status.cs b/sample/Tracker/Tracker.Scaffold/Status.cs
@@ -13,7 +13,7 @@ public partial class Status
 
     public int DisplayOrder { get; set; }
 
-    public bool? IsActive { get; set; }
+    public bool IsActive { get; set; }
 
     public DateTimeOffset Created { get; set; }
 

diff --git a/sample/Tracker/Tracker.Scaffold/Tenant.cs b/sample/Tracker/Tracker.Scaffold/Tenant.cs
@@ -11,7 +11,7 @@ public partial class Tenant
 
     public string? Description { get; set; }
 
-    public bool? IsActive { get; set; }
+    public bool IsActive { get; set; }
 
     public DateTimeOffset Created { get; set; }
 

diff --git a/sample/Tracker/Tracker.Scaffold/Tracker.Scaffold.csproj b/sample/Tracker/Tracker.Scaffold/Tracker.Scaffold.csproj
@@ -8,7 +8,7 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.EntityFrameworkCore.Design" Version="7.0.10">
+    <PackageReference Include="Microsoft.EntityFrameworkCore.Design" Version="8.0.0">
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageReference>

diff --git a/sample/Tracker/Tracker.Scaffold/TrackerContext.cs b/sample/Tracker/Tracker.Scaffold/TrackerContext.cs
@@ -1,4 +1,4 @@
-using System;
+using System;
 using System.Collections.Generic;
 using Microsoft.EntityFrameworkCore;
 
@@ -36,7 +36,8 @@ public TrackerContext(DbContextOptions<TrackerContext> options)
     public virtual DbSet<UserLogin> UserLogins { get; set; }
 
     protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
-        => optionsBuilder.UseSqlServer("Data Source=(local)\\sql2022;Initial Catalog=Tracker;Integrated Security=True;TrustServerCertificate=True");
+#warning To protect potentially sensitive information in your connection string, you should move it out of source code. You can avoid scaffolding the connection string by using the Name= syntax to read it from configuration - see https://go.microsoft.com/fwlink/?linkid=2131148. For more guidance on storing connection strings, see https://go.microsoft.com/fwlink/?LinkId=723263.
+        => optionsBuilder.UseSqlServer("Data Source=(local);Initial Catalog=Tracker;Integrated Security=True;TrustServerCertificate=True");
 
     protected override void OnModelCreating(ModelBuilder modelBuilder)
     {
@@ -64,9 +65,7 @@ protected override void OnModelCreating(ModelBuilder modelBuilder)
             entity.Property(e => e.Created).HasDefaultValueSql("(sysutcdatetime())");
             entity.Property(e => e.CreatedBy).HasMaxLength(100);
             entity.Property(e => e.Description).HasMaxLength(255);
-            entity.Property(e => e.IsActive)
-                .IsRequired()
-                .HasDefaultValueSql("((1))");
+            entity.Property(e => e.IsActive).HasDefaultValue(true);
             entity.Property(e => e.Name).HasMaxLength(100);
             entity.Property(e => e.RowVersion)
                 .IsRowVersion()
@@ -108,9 +107,7 @@ protected override void OnModelCreating(ModelBuilder modelBuilder)
             entity.Property(e => e.Created).HasDefaultValueSql("(sysutcdatetime())");
             entity.Property(e => e.CreatedBy).HasMaxLength(100);
             entity.Property(e => e.Description).HasMaxLength(255);
-            entity.Property(e => e.IsActive)
-                .IsRequired()
-                .HasDefaultValueSql("((1))");
+            entity.Property(e => e.IsActive).HasDefaultValue(true);
             entity.Property(e => e.Name).HasMaxLength(100);
             entity.Property(e => e.RowVersion)
                 .IsRowVersion()
@@ -152,8 +149,6 @@ protected override void OnModelCreating(ModelBuilder modelBuilder)
             entity.Property(e => e.Updated).HasDefaultValueSql("(sysutcdatetime())");
             entity.Property(e => e.UpdatedBy).HasMaxLength(100);
 
-
-
             entity.HasOne(d => d.Assigned).WithMany(p => p.Tasks).HasForeignKey(d => d.AssignedId);
 
             entity.HasOne(d => d.Priority).WithMany(p => p.Tasks).HasForeignKey(d => d.PriorityId);
@@ -196,9 +191,7 @@ protected override void OnModelCreating(ModelBuilder modelBuilder)
             entity.Property(e => e.Id).HasDefaultValueSql("(newsequentialid())");
             entity.Property(e => e.Created).HasDefaultValueSql("(sysutcdatetime())");
             entity.Property(e => e.CreatedBy).HasMaxLength(100);
-            entity.Property(e => e.IsActive)
-                .IsRequired()
-                .HasDefaultValueSql("((1))");
+            entity.Property(e => e.IsActive).HasDefaultValue(true);
             entity.Property(e => e.Name).HasMaxLength(256);
             entity.Property(e => e.RowVersion)
                 .IsRowVersion()

diff --git a/sample/Tracker/Tracker.Scaffold/scaffold.cmd b/sample/Tracker/Tracker.Scaffold/scaffold.cmd
@@ -0,0 +1 @@
+dotnet ef dbcontext scaffold "Data Source=(local);Initial Catalog=Tracker;Integrated Security=True;TrustServerCertificate=True" Microsoft.EntityFrameworkCore.SqlServer --force
diff --git a/src/Directory.Build.props b/src/Directory.Build.props
@@ -34,7 +34,7 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="AssemblyMetadata.Generators" Version="1.1.0" PrivateAssets="All" />
+    <PackageReference Include="AssemblyMetadata.Generators" Version="2.0.0" PrivateAssets="All" />
     <PackageReference Include="Microsoft.SourceLink.GitHub" Version="8.0.0" PrivateAssets="All" />
     <PackageReference Include="MinVer" Version="4.3.0" PrivateAssets="All" />
   </ItemGroup>

diff --git a/src/EntityFrameworkCore.Generator.Core/EntityFrameworkCore.Generator.Core.csproj b/src/EntityFrameworkCore.Generator.Core/EntityFrameworkCore.Generator.Core.csproj
@@ -1,32 +1,21 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
-    <TargetFrameworks>net6.0;net8.0</TargetFrameworks>
+    <TargetFramework>net8.0</TargetFramework>
     <RootNamespace>EntityFrameworkCore.Generator</RootNamespace>
     <NoWarn>1591,EF1001</NoWarn>
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.CodeAnalysis.CSharp.Scripting" Version="4.8.0" />
+    <PackageReference Include="Microsoft.CodeAnalysis.CSharp.Scripting" Version="4.5.0" />
     <PackageReference Include="Microsoft.Extensions.Configuration.UserSecrets" Version="8.0.0" />
-    <PackageReference Include="YamlDotNet" Version="13.7.1" />
-  </ItemGroup>
-
-  <ItemGroup Condition=" '$(TargetFramework)' == 'net6.0' ">
-    <PackageReference Include="Microsoft.EntityFrameworkCore.Design" Version="7.0.14" />
-    <PackageReference Include="Microsoft.EntityFrameworkCore.Sqlite" Version="7.0.14" />
-    <PackageReference Include="Microsoft.EntityFrameworkCore.SqlServer" Version="7.0.14" />
-    <PackageReference Include="Npgsql.EntityFrameworkCore.PostgreSQL" Version="7.0.11" />
-    <PackageReference Include="Oracle.EntityFrameworkCore" Version="7.21.12" />
-    <PackageReference Include="Pomelo.EntityFrameworkCore.MySql" Version="7.0.0" />
-  </ItemGroup>
-
-  <ItemGroup Condition=" '$(TargetFramework)' == 'net8.0' ">
     <PackageReference Include="Microsoft.EntityFrameworkCore.Design" Version="8.0.0" />
+    <PackageReference Include="Microsoft.EntityFrameworkCore.Relational" Version="8.0.0" />
     <PackageReference Include="Microsoft.EntityFrameworkCore.SqlServer" Version="8.0.0" />
     <PackageReference Include="Microsoft.EntityFrameworkCore.Sqlite" Version="8.0.0" />
     <PackageReference Include="Npgsql.EntityFrameworkCore.PostgreSQL" Version="8.0.0" />
-    <PackageReference Include="Oracle.EntityFrameworkCore" Version="7.21.12" />
+    <PackageReference Include="Oracle.EntityFrameworkCore" Version="8.21.121" />
     <PackageReference Include="Pomelo.EntityFrameworkCore.MySql" Version="7.0.0" />
+    <PackageReference Include="YamlDotNet" Version="13.7.1" />
   </ItemGroup>
 
 </Project>
diff --git a/src/EntityFrameworkCore.Generator.Core/Metadata/Generation/Property.cs b/src/EntityFrameworkCore.Generator.Core/Metadata/Generation/Property.cs
@@ -1,4 +1,4 @@
-using System;
+using System;
 using System.Data;
 using System.Diagnostics;
 using Microsoft.EntityFrameworkCore.Metadata;
@@ -36,6 +36,8 @@ public class Property : ModelBase
 
     public bool? IsRowVersion { get; set; }
 
+    public bool? IsConcurrencyToken { get; set; }
+
     public bool? IsUnique { get; set; }
 
     [Obsolete("Value no longer used, will be deleted")]
@@ -49,7 +51,9 @@ public class Property : ModelBase
     [Obsolete("Value no longer used, will be deleted")]
     public int? Scale { get; set; }
 
+    public object DefaultValue { get; set; }
+
     public string Default { get; set; }
 
     public ValueGenerated? ValueGenerated { get; set; }
-}
+}
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		dotnet ef dbcontext scaffold "Data Source=(local);Initial Catalog=Tracker;Integrated Security=True;TrustServerCertificate=True" Microsoft.EntityFrameworkCore.SqlServer --force