Colección

Descripción

Devuelve todos los documentos de una colección determinada. La colección se puede anidar.

Sintaxis

Node.js

const results = await db.pipeline()
  .collection('/cities/SF/departments')
  .execute();

Ejemplos de clientes

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

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

Java

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

Comportamiento

Para usar la etapa collection, debe aparecer como la primera etapa de la canalización.

El orden de los documentos que se devuelven desde la etapa collection es inestable y no se debe confiar en él. Se puede usar una etapa de ordenamiento posterior para obtener un ordenamiento determinístico.

Por ejemplo, para los siguientes 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'});

La etapa collection se puede usar para recuperar todas las ciudades de la colección cities y, luego, ordenarlas en orden ascendente por nombre.

Node.js

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

Esta consulta genera los siguientes documentos:

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

Subcolecciones

La etapa collection también se puede usar para segmentar colecciones en una etapa superior específica proporcionando la ruta completa a la etapa.

Por ejemplo, para los siguientes 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});

En este ejemplo, solo queremos los departamentos de la ciudad de Nueva York.

Node.js

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

Esto devolverá todos los departamentos en la ruta de acceso completa cities/NY/departments.

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