如何将System-Versioned Temporal Table与Entity Framework一起使用?

时间:2017-01-06 21:27:44

标签: c# sql entity-framework sql-server-2016 temporal

我可以在SQL Server 2016中使用时态表。遗憾的是,Entity Framework 6还不知道这个功能。是否有可能使用新的查询选项(请参阅msdn)与实体框架6一起使用?

我创建了一个带有员工时态表的简单演示项目:

enter image description here

我使用edmx将表映射到实体(thanks to Matt Ruwe):

enter image description here

使用纯sql语句一切正常:

using (var context = new TemporalEntities())
{
    var employee = context.Employees.Single(e => e.EmployeeID == 2);
    var query = 
      $@"SELECT * FROM [TemporalTest].[dbo].[{nameof(Employee)}]
         FOR SYSTEM_TIME BETWEEN
         '0001-01-01 00:00:00.00' AND '{employee.ValidTo:O}'
         WHERE EmployeeID = 2";
    var historyOfEmployee = context.Employees.SqlQuery(query).ToList();
}    

是否可以在没有纯SQL的情况下将历史记录功能添加到每个实体?我的解决方案作为实体扩展,带有反射来操纵IQuerable的SQL查询并不完美。 是否有现有的扩展或库来执行此操作?

编辑(基于Pawel的评论)

我尝试使用表值函数:

CREATE FUNCTION dbo.GetEmployeeHistory(
    @EmployeeID int, 
    @startTime datetime2, 
    @endTime datetime2)
RETURNS TABLE
AS
RETURN 
(
    SELECT 
        EmployeeID,
        [Name], 
        Position, 
        Department, 
        [Address],
        ValidFrom,
        ValidTo
    FROM dbo.Employee
    FOR SYSTEM_TIME BETWEEN @startTime AND @endTime
    WHERE EmployeeID = @EmployeeID
);
using (var context = new TemporalEntities())
{
    var employee = context.Employees.Single(e => e.EmployeeID == 2);
    var historyOfEmployee =
      context.GetEmployeeHistory(2, DateTime.MinValue, employee.ValidTo).ToList();
} 

我是否必须为每个实体创建一个函数,或者是否存在通用选项?

4 个答案:

答案 0 :(得分:2)

不,恐怕你不能。我在这方面来回Microsoft gurus来回。

这是已知的issue。 我发现的最佳建议是使用here中所述的FromSql

答案 1 :(得分:1)

是的,您可以一点点努力...

在尝试插入或更新生成的Always列时拦截EFF意图,并避免出现类似的错误

"Cannot insert an explicit value into a GENERATED ALWAYS column in table 'xxx.dbo.xxxx'. Use INSERT with a column list to exclude the GENERATED ALWAYS column, or insert a DEFAULT into GENERATED ALWAYS column."

之后,它就像是一种魅力(已在Azure Db上生产)

实施示例基于以下字段的EFF6:(StartTime y EndTime),

entity-framework-not-working-with-temporal-table

insert-record-in-temporal-table-using-c-sharp-entity-framework

dbset-attachentity-vs-dbcontext-entryentity-state-entitystate-modified

谢谢!

using System.Data.Entity.Infrastructure.Interception;
using System.Data.Entity.Core.Common.CommandTrees;
using System.Data.Entity.Core.Metadata.Edm;
using System.Collections.ObjectModel;
using System.Collections.Generic;
using System.Linq;
using System.Data.Entity;

namespace Ubiquité.Clases
{

    /// <summary>
    /// Evita que EFF se haga cargo de ciertos campos que no debe tocar Ej: StartTime y EndTime
    ///     de las tablas versionadas o bien los row_version por ejemplo
    ///     https://stackoverflow.com/questions/40742142/entity-framework-not-working-with-temporal-table
    ///     https://stackoverflow.com/questions/44253965/insert-record-in-temporal-table-using-c-sharp-entity-framework
    ///     https://stackoverflow.com/questions/30987806/dbset-attachentity-vs-dbcontext-entryentity-state-entitystate-modified
    /// </summary>
    /// <remarks>
    /// "Cannot insert an explicit value into a GENERATED ALWAYS column in table 'xxx.dbo.xxxx'.
    /// Use INSERT with a column list to exclude the GENERATED ALWAYS column, or insert a DEFAULT
    /// into GENERATED ALWAYS column."
    /// </remarks>
    internal class TemporalTableCommandTreeInterceptor : IDbCommandTreeInterceptor
    {
        private static readonly List<string> _namesToIgnore = new List<string> { "StartTime", "EndTime" };

        public void TreeCreated(DbCommandTreeInterceptionContext interceptionContext)
        {
            if (interceptionContext.OriginalResult.DataSpace == DataSpace.SSpace)
            {
                var insertCommand = interceptionContext.Result as DbInsertCommandTree;
                if (insertCommand != null)
                {
                    var newSetClauses = GenerateSetClauses(insertCommand.SetClauses);

                    var newCommand = new DbInsertCommandTree(
                        insertCommand.MetadataWorkspace,
                        insertCommand.DataSpace,
                        insertCommand.Target,
                        newSetClauses,
                        insertCommand.Returning);

                    interceptionContext.Result = newCommand;
                }

                var updateCommand = interceptionContext.Result as DbUpdateCommandTree;
                if (updateCommand != null)
                {
                    var newSetClauses = GenerateSetClauses(updateCommand.SetClauses);

                    var newCommand = new DbUpdateCommandTree(
                        updateCommand.MetadataWorkspace,
                        updateCommand.DataSpace,
                        updateCommand.Target,
                        updateCommand.Predicate,
                        newSetClauses,
                        updateCommand.Returning);

                    interceptionContext.Result = newCommand;
                }
            }
        }

        private static ReadOnlyCollection<DbModificationClause> GenerateSetClauses(IList<DbModificationClause> modificationClauses)
        {
            var props = new List<DbModificationClause>(modificationClauses);
            props = props.Where(_ => !_namesToIgnore.Contains((((_ as DbSetClause)?.Property as DbPropertyExpression)?.Property as EdmProperty)?.Name)).ToList();

            var newSetClauses = new ReadOnlyCollection<DbModificationClause>(props);
            return newSetClauses;
        }
    }

    /// <summary>
    /// registra TemporalTableCommandTreeInterceptor con EFF
    /// </summary>
    public class MyDBConfiguration : DbConfiguration
    {
        public MyDBConfiguration()
        {
            DbInterception.Add(new TemporalTableCommandTreeInterceptor());
        }
    }
}

答案 2 :(得分:1)

我只在Entity Framework Core上进行过测试,但我认为类似的解决方案应该可行。

如@StephenWitherden所述,目前存在一个开放的问题来为EF Core提供开箱即用的支持:

https://github.com/dotnet/efcore/issues/4693

我写了一个完整的指南,说明如何使用Entity Framework Core在没有任何第三方库的情况下实现它:

https://stackoverflow.com/a/64244548/3850405

答案 3 :(得分:0)

在此处添加了对临时表的初始支持:e7c0b9d(模型/元数据部分)和此处的 4b25a88(查询部分)并将在下一个预览版(预览版 8)中提供,以及就像当前的每晚一样。

用法:

将实体映射到临时表可以在 OnModelCreating 中完成,如下所示:

modelBuilder.Entity<MyTemporalEntity>().ToTable(tb => tb.IsTemporal());

还支持其他配置 - 历史表名称/模式、期间开始和期间结束列的名称

modelBuilder.Entity<MyTemporalEntity>().ToTable(tb => tb.IsTemporal(ttb =>
{
    ttb.HasPeriodStart("SystemTimeStart");
    ttb.HasPeriodEnd("SystemTimeEnd");
    ttb.WithHistoryTable("MyHistoryTable", "mySchema");
}));

支持迁移,因此可以将现有实体转换为时间实体。

查询:

var myDate = new DateTime(2020, 1, 1);
context.MyTemporalEntities.TemporalAsOf(myDate).Where(e => e.Id < 10);

支持的操作:TemporalAsOfTemporalAllTemporalBetweenTemporalFromToTemporalContainedIn

一些限制和注意事项

  • 使用时间操作的查询总是被标记为“NoTracking”。此类查询可能会返回多个具有相同键的实体,否则 EF 将无法正确解析它们的身份。

  • DbSet 上直接支持临时操作,而不是 IQueryable。在继承的情况下,它们不能应用于 OfType 操作。相反,请使用:

context.Set<MyDerivedEntity>().TemporalAsOf(...);
  • 导航扩展仅支持 AsOf 操作,因为它是唯一保证结果图一致性的时间操作。对于其他时间操作,必须使用 Join 手动创建导航。

  • 扩展导航时,目标实体也必须映射到时态表。临时操作从源传播到目标。不支持从时间实体导航到非时间实体。

context.Customers.TemporalAsOf(new DateTime(2020, 1, 1)).Select(c => c.Orders)

将于 2020 年 1 月 1 日起退回客户及其订单。临时操作会自动应用于客户和订单。

  • 不支持对映射到时态表的参数进行设置操作(例如 Concat、Except)。 (问题在此处跟踪 #25365

引用自 maumar