如何修改Azure Cosmos DB文档中的单个值？求最优方案

我刚接手一个使用Azure Cosmos DB的工作项目，对这个数据库完全陌生。数据库里存储了大量用户偏好设置，我发现其中一处拼写错误需要修正，但不清楚怎么修改对应的值：

目前我找到查询资源管理器，想执行以下查询：

Update c set c.Setting = REPLACE(c.Setting, 'N*m', 'N-m')

但查询资源管理器仅支持SELECT语句，不支持UPDATE操作。

我尝试用Azure Storage Explorer访问文档，但只弹出提示框显示Hold on! We are still working on this.。

我现在考虑两种方案：一是上传存储过程执行修改，但不知道从何入手；二是编写小型C#程序逐个遍历用户文档并更新，示例代码如下：

currId = 0; 
databaseId = ...; 
collectionId = ...; 
collectionLink = ...; 
while (currId < maxUserId) { 
    var response = await client.ReadDocumentAsync(UriFactory.CreateDocumentUri(databaseId, collectionId, currId.ToString())); 
    if (response.Resource != null) { 
        var upserted = response.Resource; 
        upserted.SetPropertyValue("Setting", "N-m"); 
        response = await client.UpsertDocumentAsync(collectionLink, upserted); 
    } 
    currId++; 
}

但感觉这种方法不够高效，想咨询修改Azure Cosmos DB文档中单个值的最佳方法。

最佳解决方案推荐 #

作为经常和Cosmos DB打交道的开发者，结合你的场景，按效率从高到低给你推荐这几种方法：

1. 用批量执行器（Bulk Executor）做批量更新

这是官方专门为大规模批量操作设计的工具，能把多次请求合并，大幅减少网络往返开销，效率比逐个遍历高很多，也最适合你的场景。

优化后的C#代码示例：

using Microsoft.Azure.Cosmos;
using Microsoft.Azure.Cosmos.BulkExecutor;
using System.Collections.Generic;
using System.Threading.Tasks;

public async Task BulkUpdateSettings()
{
    var cosmosClient = new CosmosClient("你的连接字符串");
    var database = cosmosClient.GetDatabase("你的数据库ID");
    var container = database.GetContainer("你的容器ID");

    // 初始化批量执行器
    var bulkExecutor = await BulkExecutor.CreateAsync(container, new BulkExecutorOptions());
    await bulkExecutor.InitializeAsync();

    // 只查询需要修改的文档，还能指定只返回必要字段，减少数据传输
    var query = new QueryDefinition("SELECT c.id, c.Setting FROM c WHERE c.Setting LIKE '%N*m%'");
    var feedIterator = container.GetItemQueryIterator<dynamic>(query);

    var documentsToUpdate = new List<dynamic>();

    while (feedIterator.HasMoreResults)
    {
        var response = await feedIterator.ReadNextAsync();
        foreach (var doc in response)
        {
            // 替换拼写错误
            doc.Setting = doc.Setting.Replace("N*m", "N-m");
            documentsToUpdate.Add(doc);
        }
    }

    // 执行批量更新，只更新指定字段，不用全量替换文档
    var bulkResponse = await bulkExecutor.BulkUpdateAsync(
        documentsToUpdate,
        new List<string> { "Setting" },
        enableUpsert: false);

    // 输出结果统计
    Console.WriteLine($"成功更新 {bulkResponse.SuccessfulDocumentsCount} 条文档");
    Console.WriteLine($"更新失败 {bulkResponse.FailedDocumentsCount} 条文档");
}

2. 用存储过程（Stored Procedure）在服务器端修改

存储过程是在Cosmos DB服务器本地运行的脚本，完全避免了客户端和服务器之间的多次请求往返，适合超大规模的数据修改场景。

步骤1：写存储过程的JavaScript代码

function updateSetting() {
    var collection = getContext().getCollection();
    var query = 'SELECT * FROM c WHERE c.Setting LIKE "%N*m%"';
    var response = getContext().getResponse();

    var updatedCount = 0;

    // 启动查询迭代器
    var queryIterator = collection.queryDocuments(collection.getSelfLink(), query);
    
    function processNextDoc() {
        queryIterator.nextItem(function(err, doc) {
            if (err) throw err;
            if (!doc) {
                // 所有文档处理完毕，返回结果
                response.setBody(`成功更新 ${updatedCount} 条文档`);
                return;
            }

            // 修正拼写错误
            doc.Setting = doc.Setting.replace("N*m", "N-m");
            
            // 更新当前文档
            collection.replaceDocument(doc._self, doc, function(err) {
                if (err) throw err;
                updatedCount++;
                processNextDoc(); // 处理下一个文档
            });
        });
    }

    processNextDoc();
}

步骤2：上传并执行存储过程

通过Azure门户就能操作：

• 进入你的Cosmos DB账户，打开数据资源管理器
• 找到对应的容器，展开存储过程，点击新建存储过程
• 粘贴上面的JS代码，给存储过程起个名字后保存
• 点击存储过程右侧的执行按钮，就能自动运行修改操作了

3. 优化你原来的C#遍历方案

如果你的数据量不大，也可以优化原有代码，避免遍历不存在的ID，只处理需要修改的文档：

public async Task UpdateSettingsOptimized()
{
    var cosmosClient = new CosmosClient("你的连接字符串");
    var container = cosmosClient.GetDatabase("你的数据库ID").GetContainer("你的容器ID");

    // 只查询有拼写错误的文档
    var query = new QueryDefinition("SELECT * FROM c WHERE c.Setting LIKE '%N*m%'");
    var feedIterator = container.GetItemQueryIterator<dynamic>(query);

    while (feedIterator.HasMoreResults)
    {
        var response = await feedIterator.ReadNextAsync();
        foreach (var doc in response)
        {
            doc.Setting = doc.Setting.Replace("N*m", "N-m");
            // 这里要根据你的分区键调整，比如如果分区键是id就用new PartitionKey(doc.id)
            await container.UpsertItemAsync(doc, new PartitionKey(doc.id));
        }
    }
}

这种方法跳过了无效ID的查询，减少了不必要的请求开销。

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