add support for temporal tables

Author: pwelter34

sample/Tracker/Tracker.Core/Data/Mapping/TaskMap.cs

@@ -18,6 +18,21 @@ public void Configure(Microsoft.EntityFrameworkCore.Metadata.Builders.EntityType
         // table
         builder.ToTable("Task", "dbo");
 
+        builder
+            .ToTable(tableBuilder => tableBuilder
+                .IsTemporal(temporalBuilder =>
+                {
+                    temporalBuilder
+                        .UseHistoryTable("Task", "History");
+                    temporalBuilder
+                        .HasPeriodStart("PeriodStart")
+                        .HasColumnName("PeriodStart");
+                    temporalBuilder
+                        .HasPeriodEnd("PeriodEnd")
+                        .HasColumnName("PeriodEnd");
+                })
+            );
+
         // key
         builder.HasKey(t => t.Id);
 

src/EntityFrameworkCore.Generator.Core/Metadata/Generation/Entity.cs

@@ -1,4 +1,4 @@
-using System.Diagnostics;
+using System.Diagnostics;
 
 namespace EntityFrameworkCore.Generator.Metadata.Generation;
 
@@ -162,6 +162,55 @@ public Entity()
     /// </value>
     public bool IsView { get; set; }
 
+
+    /// <summary>
+    /// Gets or sets the name of the temporal table.
+    /// </summary>
+    /// <value>
+    /// The name of the temporal table.
+    /// </value>
+    public string TemporalTableName { get; set; }
+
+    /// <summary>
+    /// Gets or sets the temporal table schema.
+    /// </summary>
+    /// <value>
+    /// The temporal table schema.
+    /// </value>
+    public string TemporalTableSchema { get; set; }
+
+    /// <summary>
+    /// Gets or sets the temporal start property.
+    /// </summary>
+    /// <value>
+    /// The temporal start property.
+    /// </value>
+    public string TemporalStartProperty { get; set; }
+
+    /// <summary>
+    /// Gets or sets the temporal start column.
+    /// </summary>
+    /// <value>
+    /// The temporal start column.
+    /// </value>
+    public string TemporalStartColumn { get; set; }
+
+    /// <summary>
+    /// Gets or sets the temporal end property.
+    /// </summary>
+    /// <value>
+    /// The temporal end property.
+    /// </value>
+    public string TemporalEndProperty { get; set; }
+
+    /// <summary>
+    /// Gets or sets the temporal end column.
+    /// </summary>
+    /// <value>
+    /// The temporal end column.
+    /// </value>
+    public string TemporalEndColumn { get; set; }
+
     void IOptionVariable.Set(VariableDictionary variableDictionary)
     {
         variableDictionary.Set(VariableConstants.TableSchema, TableSchema);
@@ -175,4 +224,4 @@ void IOptionVariable.Remove(VariableDictionary variableDictionary)
         variableDictionary.Remove(VariableConstants.TableName);
         variableDictionary.Remove(VariableConstants.EntityName);
     }
-}
+}

src/EntityFrameworkCore.Generator.Core/ModelGenerator.cs

@@ -1,4 +1,4 @@
-using System;
+using System;
 using System.Collections.Generic;
 using System.Data;
 using System.Linq;
@@ -14,6 +14,7 @@
 using Microsoft.EntityFrameworkCore.Metadata;
 using Microsoft.EntityFrameworkCore.Scaffolding.Metadata;
 using Microsoft.EntityFrameworkCore.Scaffolding.Metadata.Internal;
+using Microsoft.EntityFrameworkCore.SqlServer.Metadata.Internal;
 using Microsoft.EntityFrameworkCore.Storage;
 using Microsoft.Extensions.Logging;
 
@@ -146,6 +147,23 @@ private Entity CreateEntity(EntityContext entityContext, DatabaseTable tableSche
 
         entity.IsView = tableSchema is DatabaseView;
 
+        bool? isTemporal = tableSchema[SqlServerAnnotationNames.IsTemporal] as bool?;
+        if (isTemporal == true)
+        {
+            entity.TemporalTableName = tableSchema[SqlServerAnnotationNames.TemporalHistoryTableName] as string;
+            entity.TemporalTableSchema = tableSchema[SqlServerAnnotationNames.TemporalHistoryTableSchema] as string;
+
+            entity.TemporalStartProperty = tableSchema[SqlServerAnnotationNames.TemporalPeriodStartPropertyName] as string;
+
+            entity.TemporalStartColumn = tableSchema[SqlServerAnnotationNames.TemporalPeriodStartColumnName] as string
+                ?? entity.TemporalStartProperty;
+
+            entity.TemporalEndProperty = tableSchema[SqlServerAnnotationNames.TemporalPeriodEndPropertyName] as string;
+
+            entity.TemporalEndColumn = tableSchema[SqlServerAnnotationNames.TemporalPeriodEndColumnName] as string
+                ?? entity.TemporalEndProperty;
+        }
+
         entityContext.Entities.Add(entity);
 
         return entity;
@@ -679,4 +697,4 @@ private static bool IsIgnored(string name, IEnumerable<MatchOptions> excludeExpr
         return false;
     }
 
-}
+}

src/EntityFrameworkCore.Generator.Core/Templates/MappingClassTemplate.cs

@@ -363,5 +363,45 @@ private void GenerateTableMapping()
             : $"builder.{method}(\"{_entity.TableName}\");");
 
         CodeBuilder.AppendLine();
+
+        if (_entity.TemporalTableName.IsNullOrEmpty())
+            return;
+
+        CodeBuilder.AppendLine("builder");
+        CodeBuilder.IncrementIndent();
+        CodeBuilder.AppendLine(".ToTable(tableBuilder => tableBuilder");
+        CodeBuilder.IncrementIndent();
+        CodeBuilder.AppendLine(".IsTemporal(temporalBuilder =>");
+        CodeBuilder.AppendLine("{");
+        CodeBuilder.IncrementIndent();
+        CodeBuilder.AppendLine("temporalBuilder");
+        CodeBuilder.IncrementIndent();
+
+        CodeBuilder.AppendLine(_entity.TemporalTableSchema.HasValue()
+            ? $".UseHistoryTable(\"{_entity.TemporalTableName}\", \"{_entity.TemporalTableSchema}\");"
+            : $".UseHistoryTable(\"{_entity.TemporalTableName}\");");
+
+        CodeBuilder.DecrementIndent();
+        CodeBuilder.AppendLine("temporalBuilder");
+        CodeBuilder.IncrementIndent();
+        CodeBuilder.AppendLine($".HasPeriodStart(\"{_entity.TemporalStartProperty}\")");
+        CodeBuilder.AppendLine($".HasColumnName(\"{_entity.TemporalStartColumn}\");");
+
+        CodeBuilder.DecrementIndent();
+        CodeBuilder.AppendLine("temporalBuilder");
+        CodeBuilder.IncrementIndent();
+        CodeBuilder.AppendLine($".HasPeriodEnd(\"{_entity.TemporalEndProperty}\")");
+        CodeBuilder.AppendLine($".HasColumnName(\"{_entity.TemporalEndColumn}\");");
+
+        CodeBuilder.DecrementIndent();
+        CodeBuilder.DecrementIndent();
+        CodeBuilder.AppendLine("})");
+
+        CodeBuilder.DecrementIndent();
+        CodeBuilder.AppendLine(");");
+
+        CodeBuilder.DecrementIndent();
+
+        CodeBuilder.AppendLine();
     }
 }