Grupa kolekcji

Opis

Zwraca wszystkie dokumenty z dowolnej kolekcji o podanym identyfikatorze, niezależnie od elementu nadrzędnego.

Przykłady

Web

const results = await execute(db.pipeline()
  .collectionGroup("games")
  .sort(field("name").ascending())
  );
Swift
let results = try await db.pipeline()
  .collectionGroup("games")
  .sort([Field("name").ascending()])
  .execute()

Kotlin

val results = db.pipeline()
    .collectionGroup("games")
    .sort(field("name").ascending())
    .execute()

Java

      Task<Pipeline.Snapshot> results = db.pipeline()
    .collectionGroup("games")
    .sort(field("name").ascending())
    .execute();
Python
from google.cloud.firestore_v1.pipeline_expressions import Field

results = (
    client.pipeline()
    .collection_group("games")
    .sort(Field.of("name").ascending())
    .execute()
)
Java
Pipeline.Snapshot results =
    firestore
        .pipeline()
        .collectionGroup("games")
        .sort(ascending(field("name")))
        .execute()
        .get();
Go
snapshot := client.Pipeline().
	CollectionGroup("games").
	Sort(firestore.Orders(firestore.Ascending(firestore.FieldOf("name")))).
	Execute(ctx)

Zachowanie

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

Kolejność dokumentów zwracanych z etapu collection_group(...) jest niestabilna i nie można na niej polegać. Cloud Firestore będzie próbować wykonać zapytanie w najbardziej efektywny sposób, co może zmienić kolejność w zależności od schematu lub konfiguracji indeksu. Aby uzyskać deterministyczne uporządkowanie, można użyć kolejnego etapu sort(...).

Na przykład w przypadku tych dokumentów:

Node.js

await db.collection("cities/SF/departments").doc("building").set({name: "SF Building Deparment", employees: 750});
await db.collection("cities/NY/departments").doc("building").set({name: "NY Building Deparment", employees: 1000});
await db.collection("cities/CHI/departments").doc("building").set({name: "CHI Building Deparment", employees: 900});
await db.collection("cities/NY/departments").doc("finance").set({name: "NY Finance Deparment", employees: 1200});

Etap collection_group(...) może służyć do zwracania dokumentów z każdej kolekcji departments we wszystkich kolekcjach nadrzędnych w bazie danych.

Node.js

const results = await db.pipeline()
  .collectionGroup("departments")
  .sort(field("employees").ascending())
  .execute();

To zapytanie zwraca te dokumenty:

  { name: "SF Building Deparment", employees: 750 }
  { name: "CHI Building Deparment", employees: 900 }
  { name: "NY Building Deparment", employees: 1000 }
  { name: "NY Finance Deparment", employees: 1200 }