Coleta (estágio de entrada)

Coleta (estágio de entrada)

Descrição

Retorna todos os documentos de uma determinada coleção. A coleção pode ser aninhada.

Exemplos

Web

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

Swift

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

Kotlin
Android

val results = db.pipeline()
    .collection("users/bob/games")
    .sort(field("name").ascending())
    .execute()
DocSnippets.kt

Java
Android

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

Python

from google.cloud.firestore_v1.pipeline_expressions import Field

results = (
    client.pipeline()
    .collection("users/bob/games")
    .sort(Field.of("name").ascending())
    .execute()
)
firestore_pipelines.py

Java

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

Go

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

Comportamento

Para usar a etapa collection(...), ela precisa aparecer como a primeira etapa no pipeline (ou subpipeline).

A ordem dos documentos retornados da etapa collection(...) é instável e não deve ser usada como referência. O Firestore vai tentar 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 sort(...) subsequente pode ser usada para conseguir uma ordenação determinística.

Por exemplo, para os seguintes documentos:

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"});
await db.collection("states").doc("CA").set({name: "California"});

A etapa collection pode ser usada para recuperar todas as cidades na coleção cities e classificá-las em ordem crescente de nome.

Node.js

const results = await db.pipeline()
  .collection("/cities")
  .sort(field("name").ascending())
  .execute();

Esta consulta produz os seguintes documentos:

  { name: "Chicago", state: "Illinois" }
  { name: "New York City", state: "New York" }
  { name: "San Francisco", state: "California" }

Subcoleções

A etapa collection(...) também pode ser usada para segmentar coleções em um parent específico, fornecendo o caminho completo para a etapa.

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

Neste exemplo, queremos apenas os departamentos da cidade de Nova York.

Node.js

const results = await db.pipeline()
  .collection("/cities/NY/departments")
  .sort(field("employees").ascending())
  .execute();

Isso vai retornar todos os departamentos no caminho completo cities/NY/departments.

  { name: "NY Building Deparment", employees: 1000 }
  { name: "NY Finance Deparment", employees: 1200 }