文档（输入阶段）

文档（输入阶段）

说明

通过查找一组固定的预定义文档来返回文档。

该阶段必须将一个或多个文档作为输入，并且不能包含具有重复路径的文档。如果引用的文档不存在，则不会为相应文档路径生成任何结果。

此阶段的行为与 Firestore 的 batchGet 类似，可直接对结果进行过滤，而无需在批处理操作后执行后过滤步骤。

示例

Web

const results = await execute(db.pipeline()
  .documents([
    doc(db, "cities", "SF"),
    doc(db, "cities", "DC"),
    doc(db, "cities", "NY")
  ])
);
test.firestore.js

Swift

let results = try await db.pipeline()
  .documents([
    db.collection("cities").document("SF"),
    db.collection("cities").document("DC"),
    db.collection("cities").document("NY")
  ]).execute()
PipelineSnippets.swift

Kotlin
Android

val results = db.pipeline()
    .documents(
        db.collection("cities").document("SF"),
        db.collection("cities").document("DC"),
        db.collection("cities").document("NY")
    ).execute()
DocSnippets.kt

Java
Android

      Task<Pipeline.Snapshot> results = db.pipeline()
    .documents(
        db.collection("cities").document("SF"),
        db.collection("cities").document("DC"),
        db.collection("cities").document("NY")
    ).execute();
DocSnippets.java
    

Python

results = (
    client.pipeline()
    .documents(
        client.collection("cities").document("SF"),
        client.collection("cities").document("DC"),
        client.collection("cities").document("NY"),
    )
    .execute()
)
firestore_pipelines.py

Java

Pipeline.Snapshot results =
    firestore
        .pipeline()
        .documents(
            firestore.collection("cities").document("SF"),
            firestore.collection("cities").document("DC"),
            firestore.collection("cities").document("NY"))
        .execute()
        .get();
PipelineSnippets.java

Go

snapshot := client.Pipeline().
	Documents([]*firestore.DocumentRef{
		client.Collection("cities").Doc("SF"),
		client.Collection("cities").Doc("DC"),
		client.Collection("cities").Doc("NY"),
	}).
	Execute(ctx)
pipeline_snippets_general.go

行为

如需使用 documents(...) 阶段，它必须作为流水线中的第一个阶段出现。

从 documents(...) 阶段返回的文档顺序不稳定，不应依赖。可使用后续的 sort(...) 阶段来获得确定性的顺序。

例如，对于以下文档：

Node.js

await db.collection("cities").doc("SF").set({name: "San Francsico", state: "California"});
await db.collection("cities").doc("NYC").set({name: "New York City", state: "New York"});
await db.collection("cities").doc("CHI").set({name: "Chicago", state: "Illinois"});

documents(...) 阶段可用于仅检索 SF 和 NYC 文档，然后按名称升序对它们进行排序。

Node.js

const results = await db.pipeline()
  .documents(
    db.collection("cities").doc("SF"),
    db.collection("cities").doc("NYC"))
  .sort(field("name").ascending())
  .execute();

此查询会生成以下文档：

  { name: "New York City", state: "New York" }
  { name: "San Francsico", state: "California" }