Dokumenty

Opis

Zwraca dokumenty, wyszukując stały zestaw predefiniowanych dokumentów.

Etap musi przyjmować co najmniej 1 dokument jako dane wejściowe i nie może zawierać dokumentów o zduplikowanych ścieżkach. Jeśli dokument, do którego się odwołujesz, nie istnieje, dla tej ścieżki dokumentu nie zostaną wygenerowane żadne wyniki.

Ten etap działa podobnie jak Cloud Firestore's batchGet i umożliwia filtrowanie wyników bezpośrednio, zamiast wykonywania kroków filtrowania po operacji wsadowej.

Przykłady

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)

Zachowanie

Aby można było używać etapu documents(...), musi on być pierwszym etapem w potoku.

Kolejność dokumentów zwracanych przez etap documents(...) jest niestabilna i nie można na niej polegać. Aby uzyskać deterministyczną kolejność, możesz użyć kolejnego etapu sort(...).

Na przykład w przypadku tych dokumentów:

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"});

Etap documents(...) może służyć do pobierania tylko dokumentów SF i NYC, a następnie sortowania ich w kolejności rosnącej według nazwy.

Node.js

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

To zapytanie generuje te dokumenty:

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