使用Entity Framework从Cosmos DB查询数据返回Null，求排查方向

问题场景 #

我的Cosmos DB容器中存在如下数据：

{
    "id": "fd81aacb-64eb-452b-a0bd-c0395aa8afb6",
    "thePartitionKey": "test"
}

但使用Entity Framework Core查询时始终返回空列表。相关代码如下：

DbContext 代码 #

protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
{
   ..... // 部分配置代码
   optionsBuilder.UseCosmos(endpoint, accountKey, dbName);
}
protected override void OnModelCreating(ModelBuilder modelBuilder)
{
   modelBuilder.Entity<Test>()
                .ToContainer("theContainerID")
                .HasPartitionKey(e => e.thePartitionKey);
   public DbSet<Test>? Tests { get; set; }
}

实体模型代码 #

public class Test
{
   public string id { get; set; }
   public string thePartitionKey { get; set; }
}

查询代码 #

public List<Test> GetDataTest(){
   var qry = context.Tests.ToList();
   return qry;
}

对照教程未发现明显差异，请问问题出在哪？

问题排查与解决 #

1. DbSet 定义位置错误 #

你的DbSet<Test>? Tests { get; set; }被错误写在了OnModelCreating方法内部，这是语法错误，编译器会直接报错。必须将其移到DbContext类的成员级别位置：

public class YourDbContext : DbContext
{
    // 将DbSet移至类成员位置
    public DbSet<Test>? Tests { get; set; }

    protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
    {
       ..... // 配置代码
       optionsBuilder.UseCosmos(endpoint, accountKey, dbName);
    }

    protected override void OnModelCreating(ModelBuilder modelBuilder)
    {
       modelBuilder.Entity<Test>()
                    .ToContainer("theContainerID")
                    .HasPartitionKey(e => e.thePartitionKey);
    }
}

2. 实体属性映射验证 #

Cosmos DB中的字段为小写格式，虽然你的实体属性也是小写，但建议显式指定字段映射避免默认约定冲突：

protected override void OnModelCreating(ModelBuilder modelBuilder)
{
   modelBuilder.Entity<Test>()
                .ToContainer("theContainerID")
                .HasPartitionKey(e => e.thePartitionKey)
                .Property(e => e.id)
                .HasColumnName("id")
                .Property(e => e.thePartitionKey)
                .HasColumnName("thePartitionKey");
}

3. 容器与数据库名称验证 #

确认UseCosmos中的dbName与实际Cosmos数据库名称完全一致，ToContainer("theContainerID")中的容器名称与实际容器ID匹配（Cosmos容器名称大小写敏感）。

4. 跨分区查询配置 #

EF Core默认关闭跨分区查询，如果你的查询未指定分区键，需要手动开启：

optionsBuilder.UseCosmos(endpoint, accountKey, dbName, options =>
{
    options.AllowQueryingMultiplePartitionKeys();
});

或者指定分区键进行精准查询（性能更优）：

public List<Test> GetDataTest(){
   var qry = context.Tests.Where(t => t.thePartitionKey == "test").ToList();
   return qry;
}

5. 连接权限验证 #

检查endpoint和accountKey是否正确，确保该密钥拥有Cosmos DB的读取权限。

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