Grupo de coleções (etapa de entrada)

Grupo de coleções (etapa de entrada)

Descrição

Retorna todos os documentos de qualquer coleção com o ID especificado, independente do pai.

Exemplos

Web

const results = await execute(db.pipeline()
  .collectionGroup("games")
  .sort(field("name").ascending())
  );
test.firestore.js

Swift

let results = try await db.pipeline()
  .collectionGroup("games")
  .sort([Field("name").ascending()])
  .execute()
PipelineSnippets.swift

Kotlin
Android

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

Java
Android

      Task<Pipeline.Snapshot> results = db.pipeline()
    .collectionGroup("games")
    .sort(field("name").ascending())
    .execute();
DocSnippets.java
    

Python

from google.cloud.firestore_v1.pipeline_expressions import Field

results = (
    client.pipeline()
    .collection_group("games")
    .sort(Field.of("name").ascending())
    .execute()
)
firestore_pipelines.py

Java

Pipeline.Snapshot results =
    firestore
        .pipeline()
        .collectionGroup("games")
        .sort(ascending(field("name")))
        .execute()
        .get();
PipelineSnippets.java

Go

snapshot := client.Pipeline().
	CollectionGroup("games").
	Sort(firestore.Orders(firestore.Ascending(firestore.FieldOf("name")))).
	Execute(ctx)
pipeline_snippets_general.go

Comportamento

Para usar a etapa collection_group(...), ela precisa aparecer como a primeira etapa no pipeline.

A ordem dos documentos retornados da etapa collection_group(...) é instável e não pode ser usada como referência. O Firestore tenta executar a consulta da maneira mais eficiente possível, o que pode mudar a ordem dependendo do esquema ou da configuração do índice. Uma etapa subsequente sort(...) pode ser usada para obter uma ordenação determinística.

Por exemplo, para os seguintes documentos:

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

A etapa collection_group(...) pode ser usada para retornar documentos de todas as coleções de departamentos em todas as coleções principais do banco de dados.

Node.js

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

Esta consulta produz os seguintes documentos:

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