BreezeJS+EF Core使用表值函数时元数据缺失与查询报错问题

问题复现 #

在数据库部署了名为LoadUserInfo的表值函数（TVF），期望在.NET项目中完成映射，返回结构匹配UserInfo类的数据，初始实现流程如下：

1. 在DbContext中定义IQueryable形式的TVF映射方法

public IQueryable<UserInfo> LoadUserInfo(Guid? userId) 
    => FromExpression(() => LoadUserInfo(userId));

2. 在OnModelCreating生命周期方法中注册数据库函数

modelBuilder.HasDbFunction(typeof(AppDatabase).GetMethod(nameof(LoadUserInfo))!);

3. 在BreezeController中直接调用TVF返回数据

public IEnumerable<ReportInfo> UserInfos() {
    return PersistenceManager.Context.LoadUserInfo(User.GetUserId());
}

初始实现可正常返回接口数据，客户端UserInfo类代码也可正常生成，但存在第一个问题：

API返回的元数据中完全不包含UserInfo的类型信息，该类型被框架直接忽略。

尝试通过补充DbSet声明修复该问题：

public DbSet<UserInfo> UserInfos => Set<UserInfo>();

补充声明后元数据确实正常包含UserInfos相关信息，但触发第二个问题：接口请求时服务器抛出列不存在错误

Invalid column name 'PeriodEnd'.
Invalid column name 'PeriodStart'.

PeriodEnd、PeriodStart是EF Core针对物理表实体自动生成的常规查询列（多为全局开启的时态表默认字段、或基础实体类定义的公共字段），报错根因是：声明DbSet后EF Core默认将UserInfo映射为真实物理表，自动生成包含内置列的查询语句，但UserInfo实际仅绑定TVF，TVF返回结果中不存在这两个列，最终触发查询错误。

正确配置步骤 #

核心目标是同时满足两个要求：Breeze可扫描到UserInfo类型生成完整元数据、EF Core不将UserInfo映射为物理表生成无效列查询，具体操作如下：

• 保留DbContext中的DbSet<UserInfo>声明
  该声明是Breeze扫描实体类型、生成客户端元数据的必要前提，无需删除。
• 在OnModelCreating中针对UserInfo做专属映射配置，阻断默认物理表映射逻辑

  modelBuilder.Entity<UserInfo>(eb =>
  {
      // 标记实体映射到数据库函数而非物理表，关联到目标TVF
      eb.ToFunction("LoadUserInfo");
      
      // 根据TVF返回结果配置键：有唯一标识字段就配置HasKey，无唯一值则用eb.HasNoKey()
      eb.HasKey(u => u.UserId);
      
      // 显式配置实体属性和TVF返回列的映射关系，避免EF Core按约定生成额外列映射
      // 示例：将UserId属性映射到TVF返回的UserId列，其余属性按实际TVF结构依次配置即可
      eb.Property(u => u.UserId).HasColumnName("UserId");
      
      // 关闭针对该实体的时态表自动列生成逻辑，解决PeriodStart/PeriodEnd列无效问题
      eb.IsTemporal(false);
      
      // 如果PeriodStart/PeriodEnd是基础实体类定义的属性、而非时态表自动生成字段，直接配置忽略即可
      // eb.Ignore(u => u.PeriodStart);
      // eb.Ignore(u => u.PeriodEnd);
  });
  

• 补全TVF的注册配置，关联函数映射
  调整原有HasDbFunction配置，明确函数属性：

  modelBuilder.HasDbFunction(typeof(AppDatabase).GetMethod(nameof(LoadUserInfo))!)
      .HasName("LoadUserInfo")
      .IsBuiltIn(false);
  

验证要点 #

• 配置完成后Breeze可正常扫描到UserInfo实体，元数据完整无缺失
• EF Core调用TVF生成的查询语句只会查询显式配置的列，不会自动拼接PeriodStart/PeriodEnd等物理表专属字段，不会触发列不存在错误
• 若后续TVF返回结构调整，只需要同步更新UserInfo类属性和Entity<UserInfo>中的列映射配置即可

内容的提问来源于stack exchange，提问作者Gotts