Documenti

Descrizione

Restituisce i documenti cercando un insieme fisso di documenti predefiniti.

La fase deve accettare uno o più documenti come input e non può contenere documenti con percorsi duplicati. Se un documento a cui viene fatto riferimento non esiste, non verranno prodotti risultati per il percorso del documento.

Questa fase si comporta in modo simile a Cloud Firestore's batchGet e consente di filtrare i risultati direttamente anziché eseguire passaggi di post-filtraggio dopo l'operazione batch.

Esempi

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();
Vai
snapshot := client.Pipeline().
	Documents([]*firestore.DocumentRef{
		client.Collection("cities").Doc("SF"),
		client.Collection("cities").Doc("DC"),
		client.Collection("cities").Doc("NY"),
	}).
	Execute(ctx)

Comportamento

Per utilizzare la fase documents(...), deve essere la prima nella pipeline.

L'ordine dei documenti restituiti dalla fase documents(...) è instabile e non è affidabile. È possibile utilizzare una fase sort(...) successiva per ottenere un ordinamento deterministico.

Ad esempio, per i seguenti documenti:

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

La fase documents(...) può essere utilizzata per recuperare solo i documenti SF e NYC e poi ordinarli in ordine crescente di nome.

Node.js

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

Questa query produce i seguenti documenti:

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