ASP.NET Core中使用分区键查询CosmosDB时出现报错

容器详情 #

• ContainerName: ScenariosTable
• 分区键: /_partitionKey
• 类型: 非分层

相关代码 #

[HttpGet("GetScenario/{scenarioId}")]
public async Task<string> GetScenarioAsync(string scenarioId, [FromQuery] string version = "")
{
    Scenario result;
    if (string.IsNullOrEmpty(version) || string.Equals(version, "undefined"))
    {
        result = await repository.GetItemByQueryAsync(s => s.Id == scenarioId).ConfigureAwait(false);
    }
    else
    {
        result = await historyRepository.GetItemByQueryAsync(s => s.Id == scenarioId).ConfigureAwait(false);
    }

    if (result != null)
    {
        return JsonConvert.SerializeObject(result);
    }
    else
    {
        throw new ApplicationException($"Could not retrieve scenario definition");
    }
}

public async Task<T> GetItemByQueryAsync(Expression<Func<T, bool>> predicate)
{
    var result = await GetDocumentsCollectionAsync(predicate).ConfigureAwait(false);
    return result.FirstOrDefault();
}

private async Task<IEnumerable<T>> GetDocumentsCollectionAsync(Expression<Func<T, bool>> predicate)
{
    IDocumentQuery<T> query = client.CreateDocumentQuery<T>(
        this.documentCollectionUri,
        new FeedOptions { MaxItemCount = -1, EnableCrossPartitionQuery = true, PartitionKey = new PartitionKey("_partitionKey") })
        .Where(predicate)
        .AsDocumentQuery();

    List<T> results = new List<T>();
    while (query.HasMoreResults)
    {
        results.AddRange(await query.ExecuteNextAsync<T>().ConfigureAwait(false));
    }

    return results;
}

错误信息 #

Microsoft.Azure.Documents.DocumentClientException: Cross partition query is required but disabled. Please set x-ms-documentdb-query-enablecrosspartition to true, specify x-ms-documentdb-partitionkey, or revise your query to avoid this exception.
ActivityId: 9ce56a2c-d5ec-45d8-ad39-a78ef6f5ffa2, Microsoft.Azure.Documents.Common/2.14.0, Windows/10.0.20348 documentdb-netcore-sdk/2.11.6
   at Microsoft.Azure.Documents.GatewayStoreClient.ParseResponseAsync(HttpResponseMessage responseMessage, JsonSerializerSettings serializerSettings, DocumentServiceRequest request)
   at Microsoft.Azure.Documents.GatewayStoreClient.InvokeAsync(DocumentServiceRequest request, ResourceType resourceType, Uri physicalAddress, CancellationToken cancellationToken)
   at Microsoft.Azure.Documents.GatewayStoreModel.ProcessMessageAsync(DocumentServiceRequest request, CancellationToken cancellationToken)
   at Microsoft.Azure.Documents.Client.DocumentClient.ProcessRequestAsync(DocumentServiceRequest request, IDocumentClientRetryPolicy retryPolicyInstance, CancellationToken cancellationToken)
   at Microsoft.Azure.Documents.Client.DocumentClient.ProcessRequestAsync(String verb, DocumentServiceRequest request, IDocumentClientRetryPolicy retryPolicyInstance, CancellationToken cancellationToken, String testAuthorization)
   at Microsoft.Azure.Documents.Query.DocumentQueryExecutionContextBase.ExecuteQueryRequestInternalAsync(DocumentServiceRequest request, IDocumentClientRetryPolicy retryPolicyInstance, CancellationToken cancellationToken)
   at Microsoft.Azure.Documents.Query.DocumentQueryExecutionContextBase.ExecuteQueryRequestAsync(DocumentServiceRequest request, IDocumentClientRetryPolicy retryPolicyInstance, CancellationToken cancellationToken)
   at Microsoft.Azure.Documents.Query.DefaultDocumentQueryExecutionContext.ExecuteOnceAsync(IDocumentClientRetryPolicy retryPolicyInstance, CancellationToken cancellationToken)
   at Microsoft.Azure.Documents.Query.DefaultDocumentQueryExecutionContext.<>c__DisplayClass8_0.<ExecuteInternalAsync>b__0d.MoveNext()
--- End of stack trace from previous location ---
   at Microsoft.Azure.Documents.BackoffRetryUtility`1.ExecuteRetryAsync(Func`1 callbackMethod, 

已尝试操作 #

已在FeedOptions中设置EnableCrossPartitionQuery = true，但问题仍未解决。

解决方案 #

1. 修正PartitionKey参数错误 #

代码中PartitionKey = new PartitionKey("_partitionKey")是核心错误：这里需要传入文档实际的分区键值，而非分区键的字段名。如果无法提前获取目标文档的分区键值，直接移除该参数即可（已开启跨分区查询）：

private async Task<IEnumerable<T>> GetDocumentsCollectionAsync(Expression<Func<T, bool>> predicate)
{
    IDocumentQuery<T> query = client.CreateDocumentQuery<T>(
        this.documentCollectionUri,
        new FeedOptions { MaxItemCount = -1, EnableCrossPartitionQuery = true })
        .Where(predicate)
        .AsDocumentQuery();

    List<T> results = new List<T>();
    while (query.HasMoreResults)
    {
        results.AddRange(await query.ExecuteNextAsync<T>().ConfigureAwait(false));
    }

    return results;
}

2. 优化查询性能（推荐） #

CosmosDB中Id仅在分区内唯一，若要精准查询单条文档，最好同时指定Id和分区键值，避免跨分区查询的性能损耗。如果业务上能获取到目标文档的分区键值，可以修改为直接读取文档：

// 示例：假设Scenario实体包含PartitionKey属性
public async Task<Scenario> GetScenarioByIdAndPartitionKeyAsync(string scenarioId, string partitionKey)
{
    var uri = UriFactory.CreateDocumentUri(databaseId, "ScenariosTable", scenarioId);
    return await client.ReadDocumentAsync<Scenario>(uri, new RequestOptions { PartitionKey = new PartitionKey(partitionKey) });
}

3. 升级CosmosDB SDK版本 #

你使用的documentdb-netcore-sdk/2.11.6版本较旧，建议升级到最新的Microsoft.Azure.Cosmos（v3.x）包。v3版本API更简洁，跨分区查询默认行为更合理，能减少此类配置问题。

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