文件

說明

透過查詢一組預先定義的文件，傳回文件。

階段必須將一或多份文件做為輸入內容，且不得包含路徑重複的文件。如果參照的文件不存在，系統不會為該文件路徑產生任何結果。

這個階段的行為與 Cloud Firestore 的 batchGet 類似，可直接對結果進行篩選，不必在批次作業後執行後續篩選步驟。

範例

Web

const results = await execute(db.pipeline()
  .documents([
    doc(db, "cities", "SF"),
    doc(db, "cities", "DC"),
    doc(db, "cities", "NY")
  ])
);
Swift
let results = try await db.pipeline()
  .documents([
    db.collection("cities").document("SF"),
    db.collection("cities").document("DC"),
    db.collection("cities").document("NY")
  ]).execute()

Kotlin

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

Java

      Task<Pipeline.Snapshot> results = db.pipeline()
    .documents(
        db.collection("cities").document("SF"),
        db.collection("cities").document("DC"),
        db.collection("cities").document("NY")
    ).execute();
Python
results = (
    client.pipeline()
    .documents(
        client.collection("cities").document("SF"),
        client.collection("cities").document("DC"),
        client.collection("cities").document("NY"),
    )
    .execute()
)
Java
Pipeline.Snapshot results =
    firestore
        .pipeline()
        .documents(
            firestore.collection("cities").document("SF"),
            firestore.collection("cities").document("DC"),
            firestore.collection("cities").document("NY"))
        .execute()
        .get();
Go
snapshot := client.Pipeline().
	Documents([]*firestore.DocumentRef{
		client.Collection("cities").Doc("SF"),
		client.Collection("cities").Doc("DC"),
		client.Collection("cities").Doc("NY"),
	}).
	Execute(ctx)

行為

如要使用 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" }