Feature/add period columns to queries

.editorconfig

@@ -0,0 +1,110 @@
+# Rules in this file were initially inferred by Visual Studio IntelliCode from the C:\Users\B406\source\repos\Sandbox\EntityFrameworkCore.TemporalTables codebase based on best match to current usage at 02/01/2021
+# You can modify the rules from these initially generated values to suit your own policies
+# You can learn more about editorconfig here: https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-code-style-settings-reference
+[*.cs]
+
+
+#Core editorconfig formatting - indentation
+
+#use soft tabs (spaces) for indentation
+indent_style = space
+indent_size = 4
+
+#Formatting - new line options
+
+#place else statements on a new line
+csharp_new_line_before_else = true
+#require members of anonymous types to be on separate lines
+csharp_new_line_before_members_in_anonymous_types = true
+#require members of object initializers to be on the same line
+csharp_new_line_before_members_in_object_initializers = false
+#require braces to be on a new line for methods, lambdas, types, and control_blocks (also known as "Allman" style)
+csharp_new_line_before_open_brace = methods, lambdas, types, control_blocks
+
+#Formatting - organize using options
+
+#do not place System.* using directives before other using directives
+dotnet_sort_system_directives_first = false
+
+#Formatting - spacing options
+
+#require a space before the colon for bases or interfaces in a type declaration
+csharp_space_after_colon_in_inheritance_clause = true
+#require a space after a keyword in a control flow statement such as a for loop
+csharp_space_after_keywords_in_control_flow_statements = true
+#require a space before the colon for bases or interfaces in a type declaration
+csharp_space_before_colon_in_inheritance_clause = true
+#remove space within empty argument list parentheses
+csharp_space_between_method_call_empty_parameter_list_parentheses = false
+#remove space between method call name and opening parenthesis
+csharp_space_between_method_call_name_and_opening_parenthesis = false
+#do not place space characters after the opening parenthesis and before the closing parenthesis of a method call
+csharp_space_between_method_call_parameter_list_parentheses = false
+#remove space within empty parameter list parentheses for a method declaration
+csharp_space_between_method_declaration_empty_parameter_list_parentheses = false
+#place a space character after the opening parenthesis and before the closing parenthesis of a method declaration parameter list.
+csharp_space_between_method_declaration_parameter_list_parentheses = false
+
+#Formatting - wrapping options
+
+#leave code block on single line
+csharp_preserve_single_line_blocks = true
+
+#Style - Code block preferences
+
+#prefer curly braces even for one line of code
+csharp_prefer_braces = true:suggestion
+
+#Style - expression bodied member options
+
+#prefer block bodies for constructors
+csharp_style_expression_bodied_constructors = false:suggestion
+#prefer block bodies for methods
+csharp_style_expression_bodied_methods = false:suggestion
+
+#Style - expression level options
+
+#prefer out variables to be declared inline in the argument list of a method call when possible
+csharp_style_inlined_variable_declaration = true:suggestion
+#prefer the language keyword for member access expressions, instead of the type name, for types that have a keyword to represent them
+dotnet_style_predefined_type_for_member_access = true:suggestion
+
+#Style - Expression-level  preferences
+
+#prefer default over default(T)
+csharp_prefer_simple_default_expression = true:suggestion
+#prefer inferred anonymous type member names
+dotnet_style_prefer_inferred_anonymous_type_member_names = false:suggestion
+
+#Style - implicit and explicit types
+
+#prefer var over explicit type in all cases, unless overridden by another code style rule
+csharp_style_var_elsewhere = true:suggestion
+#prefer explicit type over var to declare variables with built-in system types such as int
+csharp_style_var_for_built_in_types = false:suggestion
+#prefer explicit type over var when the type is already mentioned on the right-hand side of a declaration
+csharp_style_var_when_type_is_apparent = false:suggestion
+
+#Style - language keyword and framework type options
+
+#prefer the language keyword for local variables, method parameters, and class members, instead of the type name, for types that have a keyword to represent them
+dotnet_style_predefined_type_for_locals_parameters_members = true:suggestion
+
+#Style - modifier options
+
+#prefer accessibility modifiers to be declared except for public interface members. This will currently not differ from always and will act as future proofing for if C# adds default interface methods.
+dotnet_style_require_accessibility_modifiers = for_non_interface_members:suggestion
+
+#Style - Modifier preferences
+
+#when this rule is set to a list of modifiers, prefer the specified ordering.
+csharp_preferred_modifier_order = public,private,protected,internal,static,readonly,override,abstract,async:suggestion
+
+#Style - qualification options
+
+#prefer fields not to be prefaced with this. or Me. in Visual Basic
+dotnet_style_qualification_for_field = false:suggestion
+#prefer methods not to be prefaced with this. or Me. in Visual Basic
+dotnet_style_qualification_for_method = false:suggestion
+#prefer properties not to be prefaced with this. or Me. in Visual Basic
+dotnet_style_qualification_for_property = false:suggestion

EntityFrameworkCore.TemporalTables/Extensions/DbSetExtensions.cs

@@ -1,4 +1,5 @@
 using System;
+using System.Collections.Generic;
 using System.Linq;
 using EntityFrameworkCore.TemporalTables.Cache;
 using Microsoft.EntityFrameworkCore;
@@ -20,8 +21,10 @@ public static IQueryable<TEntity> AsOf<TEntity>(this DbSet<TEntity> dbSet, DateT
             where TEntity : class
         {
             ValidateDbSet(dbSet);
+            var PropertyNames = dbSet.GetMappedPropertiesWithPeriodProperties();
+            var propertyNamesClause = string.Join(", ", PropertyNames);
 
-            var sql = FormattableString.Invariant($"SELECT * FROM [{GetTableName(dbSet)}] FOR SYSTEM_TIME AS OF {{0}}");
+            var sql = FormattableString.Invariant($"SELECT {propertyNamesClause} FROM [{GetTableName(dbSet)}] FOR SYSTEM_TIME AS OF {{0}}");
             return dbSet.FromSqlRaw(sql, date).AsNoTracking();
         }
 
@@ -36,8 +39,10 @@ public static IQueryable<TEntity> AsOf<TEntity>(this DbSet<TEntity> dbSet, DateT
             where TEntity : class
         {
             ValidateDbSet(dbSet);
+            var PropertyNames = dbSet.GetMappedPropertiesWithPeriodProperties();
+            var propertyNamesClause = string.Join(", ", PropertyNames);
 
-            var sql = FormattableString.Invariant($"SELECT * FROM [{GetTableName(dbSet)}] FOR SYSTEM_TIME AS OF {{0}}");
+            var sql = FormattableString.Invariant($"SELECT {propertyNamesClause} FROM [{GetTableName(dbSet)}] FOR SYSTEM_TIME AS OF {{0}}");
             return dbSet.FromSqlRaw(sql, dateTimeOffset).AsNoTracking();
         }
 
@@ -55,8 +60,10 @@ public static IQueryable<TEntity> Between<TEntity>(this DbSet<TEntity> dbSet, Da
             where TEntity : class
         {
             ValidateDbSet(dbSet);
+            var PropertyNames = dbSet.GetMappedPropertiesWithPeriodProperties();
+            var propertyNamesClause = string.Join(", ", PropertyNames);
 
-            var sql = FormattableString.Invariant($"SELECT * FROM [{GetTableName(dbSet)}] FOR SYSTEM_TIME BETWEEN {{0}} AND {{1}}");
+            var sql = FormattableString.Invariant($"SELECT {propertyNamesClause} FROM [{GetTableName(dbSet)}] FOR SYSTEM_TIME BETWEEN {{0}} AND {{1}}");
             return dbSet.FromSqlRaw(sql, startDate, endDate).AsNoTracking();
         }
 
@@ -74,11 +81,72 @@ public static IQueryable<TEntity> Between<TEntity>(this DbSet<TEntity> dbSet, Da
             where TEntity : class
         {
             ValidateDbSet(dbSet);
+            var PropertyNames = dbSet.GetMappedPropertiesWithPeriodProperties();
+            var propertyNamesClause = string.Join(", ", PropertyNames);
 
-            var sql = FormattableString.Invariant($"SELECT * FROM [{GetTableName(dbSet)}] FOR SYSTEM_TIME BETWEEN {{0}} AND {{1}}");
+            var sql = FormattableString.Invariant($"SELECT {propertyNamesClause} FROM [{GetTableName(dbSet)}] FOR SYSTEM_TIME BETWEEN {{0}} AND {{1}}");
             return dbSet.FromSqlRaw(sql, startDateOffset, endDateOffset).AsNoTracking();
         }
 
+        /// <summary>
+        /// Filters the DbSet with entities between the provided dates.
+        /// </summary>
+        /// <typeparam name="TEntity">The type of the entity.</typeparam>
+        /// <param name="dbSet">The database set.</param>
+        /// <param name="startDate">The start date.</param>
+        /// <param name="endDate">The end date.</param>
+        /// <returns>The entities found between the provided dates.</returns>
+        /// <remarks>The same entity might be returned more than once if it was modified
+        /// during that time frame.</remarks>
+        public static IQueryable<TEntity> ContainedIn<TEntity>(this DbSet<TEntity> dbSet, DateTime startDate, DateTime endDate)
+            where TEntity : class
+        {
+            ValidateDbSet(dbSet);
+            var PropertyNames = dbSet.GetMappedPropertiesWithPeriodProperties();
+            var propertyNamesClause = string.Join(", ", PropertyNames);
+
+            var sql = FormattableString.Invariant($"SELECT {propertyNamesClause} FROM [{GetTableName(dbSet)}] FOR SYSTEM_TIME CONTAINED IN ({{0}}, {{1}})");
+            return dbSet.FromSqlRaw(sql, startDate, endDate).AsNoTracking();
+        }
+
+        /// <summary>
+        /// Filters the DbSet with entities between the provided dates.
+        /// </summary>
+        /// <typeparam name="TEntity">The type of the entity.</typeparam>
+        /// <param name="dbSet">The database set.</param>
+        /// <param name="startDateOffset">The start date time offset.</param>
+        /// <param name="endDateOffset">The end date time offset.</param>
+        /// <returns>The entities found between the provided dates.</returns>
+        /// <remarks>The same entity might be returned more than once if it was modified
+        /// during that time frame.</remarks>
+        public static IQueryable<TEntity> ContainedIn<TEntity>(this DbSet<TEntity> dbSet, DateTimeOffset startDateOffset, DateTimeOffset endDateOffset)
+            where TEntity : class
+        {
+            ValidateDbSet(dbSet);
+            var PropertyNames = dbSet.GetMappedPropertiesWithPeriodProperties();
+            var propertyNamesClause = string.Join(", ", PropertyNames);
+
+            var sql = FormattableString.Invariant($"SELECT {propertyNamesClause} FROM [{GetTableName(dbSet)}] FOR SYSTEM_TIME CONTAINED IN ({{0}}, {{1}})");
+            return dbSet.FromSqlRaw(sql, startDateOffset, endDateOffset).AsNoTracking();
+        }
+
+        /// <summary>
+        /// Selects the entities for all time periods
+        /// </summary>
+        /// <typeparam name="TEntity">The type of the entity.</typeparam>
+        /// <param name="dbSet">The database set.</param>
+        /// <returns>All of the for all time-periods</returns>
+        public static IQueryable<TEntity> ForAll<TEntity>(this DbSet<TEntity> dbSet)
+            where TEntity : class
+        {
+            ValidateDbSet(dbSet);
+            var PropertyNames = dbSet.GetMappedPropertiesWithPeriodProperties();
+            var propertyNamesClause = string.Join(", ", PropertyNames);
+
+            var sql = FormattableString.Invariant($"SELECT {propertyNamesClause} FROM [{GetTableName(dbSet)}] FOR SYSTEM_TIME ALL");
+            return dbSet.FromSqlRaw(sql).AsNoTracking();
+        }
+
         /// <summary>
         /// Validates that temporal tables are enabled on the provided data set.
         /// </summary>
@@ -139,5 +207,43 @@ private static DbContext GetDbContext<TEntity>(DbSet<TEntity> dbSet)
             var currentDbContext = serviceProvider.GetService(typeof(ICurrentDbContext)) as ICurrentDbContext;
             return currentDbContext.Context;
         }
+
+        private static IEnumerable<string> GetMappedPropertiesWithPeriodProperties<TEntity>(this DbSet<TEntity> dbSet)
+            where TEntity : class
+        {
+            //TODO: these columns should be customizable, and should only be added if the period columns are not already mapped from the existing EF configuration
+            string SysStartTime = "[SysStartTime]";
+            string SysEndTime = "[SysEndTime]";
+
+            IEnumerable<string> propertyNames = null;
+
+            var entityType = dbSet
+                .GetService<ICurrentDbContext>()
+                .Context.Model.FindEntityType(typeof(TEntity));
+
+            //TODO: I'm not sure how this will work with Owned entities or TPT/TPH
+            StoreObjectIdentifier? so = StoreObjectIdentifier.Create(entityType, StoreObjectType.Table);
+
+            if (so.HasValue)
+            {
+                propertyNames = entityType
+                    .GetProperties()
+                    .Where(s => !string.IsNullOrWhiteSpace(s.GetColumnName(so.Value)))
+                    .Select(p => $"[{p.GetColumnName(so.Value)}]");
+
+                var isOwned = dbSet
+                    .GetService<ICurrentDbContext>()
+                    .Context.Model.FindEntityType(typeof(TEntity))
+                    .IsOwned();
+
+                //Don't add columns if 
+                if (!isOwned)
+                {
+                    propertyNames = propertyNames.Union(new string[] { SysStartTime, SysEndTime }).Distinct();
+                }
+            }
+
+            return propertyNames;
+        }
     }
 }