EF Core访问Cosmos DB如何判断空容器并初始化种子数据

问题背景 #

通过 EF Core 访问 Cosmos DB 数据库时，已重写OnModelCreating方法校验底层数据库与容器是否存在，但无法直接判断容器内是否存在数据。EF Core 未提供可直接使用的无参数Count类方法校验数据库是否为空，初始实现代码如下：

protected override void OnModelCreating(ModelBuilder modelBuilder)
{
    var client = Database.GetCosmosClient();
    var dbResponse = client.CreateDatabaseIfNotExistsAsync("Db").Result.StatusCode;
    ContainerProperties containerProperties = new ContainerProperties("forms", "/forms");
    var database = client.GetDatabase("Db");
    var containerResponse = database.CreateContainerIfNotExistsAsync(containerProperties).Result.StatusCode;

    // 数据库或容器为刚创建状态，需要写入种子数据
    if (dbResponse == System.Net.HttpStatusCode.Created
        || containerResponse == System.Net.HttpStatusCode.Created)
    {
        Console.WriteLine("Model created but need seeding");
        return;
    }

    var container = database.GetContainer("forms");
    // 待实现：判断容器内是否存在数据          
}

参考第三方方案编写了独立的种子工具方法，代码如下：

using Microsoft.EntityFrameworkCore;
using System.Linq;

namespace FormsRetriever
{
    public static class SeedingTools
    {
        public static void CheckDatabase(DbContext dbContext)
        {
            dbContext.Database.EnsureCreated();
            var client = dbContext.Database.GetCosmosClient();
            SeedData(dbContext);
        }

        private static void SeedData(DbContext dbContext)
        {
            bool hasData = dbContext.Set<Forms>().Any();
        }
    }
}

应用启动阶段调用上述方法时，运行抛出如下错误：

A host error has occurred during startup operation '50913447-b407-41a1-95bd-68918f9d3d4b'.
[2022-07-04T11:04:53.059Z] Microsoft.EntityFrameworkCore: The LINQ expression 'DbSet<Forms>()
[2022-07-04T11:04:53.059Z]     .Any()' could not be translated. Either rewrite the query in a form that can be translated, or switch to client evaluation explicitly by inserting a call to 'AsEnumerable', 'AsAsyncEnumerable', 'ToList', or 'ToListAsync'.

报错原因 #

• EF Core Cosmos DB 提供程序不支持无筛选条件的Any()、Count()查询直接翻译为 Cosmos DB 原生查询，无参数直接调用会抛出 LINQ 表达式无法翻译的错误。
• OnModelCreating方法仅用于配置实体映射规则、模型结构，在该方法内执行数据查询、容器操作会引发上下文初始化阶段的异常，不适合存放数据校验、种子写入逻辑。

可行实现方案 #

以下两种方案均可稳定判断容器是否为空，完成种子数据初始化，逻辑需放在应用启动流程中、DbContext完全初始化后调用，不要写入OnModelCreating方法。

方案1：通过 Cosmos DB SDK 直接读取容器项计数（性能最优） #

直接通过 Cosmos 客户端读取容器元数据中的项计数，不需要拉取实体数据，性能开销最低，适合初始化场景：

/// <summary>
/// 确保数据库、容器存在，空容器时写入种子数据
/// </summary>
public static async Task EnsureSeedDataAsync(YourDbContext dbContext)
{
    // 异步确保数据库和容器创建完成
    await dbContext.Database.EnsureCreatedAsync();
    
    var container = dbContext.Database.GetCosmosClient()
        .GetDatabase("Db")
        .GetContainer("forms");
    
    // 读取容器元数据，获取当前文档计数
    var containerMeta = await container.ReadContainerAsync();
    long currentItemCount = containerMeta.Resource.DocumentCount;
    
    // 计数为0说明容器为空，执行种子写入
    if (currentItemCount == 0)
    {
        // 此处写入种子数据逻辑
        // 例：
        // var seedForms = new List<Forms> { /* 初始化种子数据 */ };
        // await dbContext.Set<Forms>().AddRangeAsync(seedForms);
        // await dbContext.SaveChangesAsync();
    }
}

说明：DocumentCount为 Cosmos DB 定期同步的统计值，非强实时，对于刚创建完成的空容器场景取值完全准确，满足种子初始化需求。

方案2：添加恒真条件让 EF Core 正常翻译 LINQ 查询 #

如果不希望直接依赖 Cosmos SDK 的元数据接口，可以给Any()方法添加始终成立的筛选条件，EF Core Cosmos 提供程序可正常翻译带条件的Any()查询，不会抛出翻译错误：

public static async Task EnsureSeedDataAsync(YourDbContext dbContext)
{
    await dbContext.Database.EnsureCreatedAsync();
    
    // 添加恒真条件（主键不为空），使查询可被EF Core翻译
    bool hasData = await dbContext.Set<Forms>()
        .Where(f => f.Id != null) // Id替换为对应实体的主键字段即可
        .AnyAsync();
    
    if (!hasData)
    {
        // 执行种子数据写入逻辑
    }
}

注意事项 #

• 所有涉及IO的操作统一使用异步API（带Async后缀的方法），不要使用.Result做同步阻塞调用，避免出现线程死锁、上下文状态异常问题。
• 种子逻辑建议加幂等判断，避免重复运行时重复写入数据。

内容的提问来源于stack exchange，提问作者J.Down