带有 FieldPath.DocumentId 的 Firestore WhereIn 查询引发异常

Question

尝试根据 DocumentID 列表从集合中获取少量文档，但无法使用 WhereIn 和 FieldPath 进行以下操作。 Nuget 版本 Google.Cloud.Firestore v1.1.0

public async Task<IEnumerable<T>> GetByDocumentIdWhereIn(IEnumerable<string> documentIds)
{
    CollectionReference ref= FirestoreDb.Collection(_collectionName);
    Query query = ref.WhereIn(FieldPath.DocumentId, documentIds);
    QuerySnapshot querySnapshot = await query.GetSnapshotAsync();
    ...
}

当使用几个 documentIds 执行时，我收到以下错误。

RpcException: Status(StatusCode=InvalidArgument, Detail="__key__ filter value must be a Key")
System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw()
System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task)
Grpc.Core.Internal.ClientResponseStream+<MoveNext>d__5.MoveNext() in ClientResponseStream.cs
System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw()
System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task)
System.Linq.AsyncEnumerable+<ForEachAsync_>d__174.MoveNext() in ForEach.cs
System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw()
System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task)
Google.Cloud.Firestore.Query+<GetSnapshotAsync>d__54.MoveNext() in Query.cs
System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw()
System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task)
System.Runtime.CompilerServices.TaskAwaiter.GetResult()

有什么想法吗？

Answer 1

注意：此答案是在 Google.Cloud.Firestore 2.1.0 发布之前编写的。从 2.1.0 开始，原始代码应该可以工作。

---

这是服务器生成的异常，但可以在客户端转换查询以使其正常工作。如果提供的值是 DocumentReference 值而不是字符串，则查询有效。

这意味着你现在可以像这样修复你的代码：

CollectionReference coll = FirestoreDb.Collection(_collectionName);
var docRefs = documentIds.Select(id => coll.Document(id)).ToList();
Query query = coll.WhereIn(FieldPath.DocumentId, docRefs);
QuerySnapshot querySnapshot = await query.GetSnapshotAsync();

未来我们希望自动为您执行此操作；这方面的进展将在this GitHub issue 上进行跟踪。

请注意，如果您只是想要获取文档快照的集合，并且您拥有（或可以创建）DocumentReference 值序列，则另一种方法是使用 FirestoreDb.GetAllSnapshotsAsync。