Kolekcja

Opis

Zwraca wszystkie dokumenty z danej kolekcji. Kolekcję można zagnieżdżać.

Składnia

Node.js

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

Przykłady klientów

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

Zachowanie

Aby korzystać z etapu collection, musi on być pierwszym etapem w ścieżce.

Kolejność dokumentów zwracanych na etapie collection jest niestabilna i nie należy na niej polegać. Aby uzyskać deterministyczne uporządkowanie, można użyć kolejnego etapu sortowania.

Na przykład w przypadku tych dokumentów:

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

Etap collection może służyć do pobierania wszystkich miast z kolekcji cities, a następnie sortowania ich w kolejności rosnącej według nazwy.

Node.js

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

To zapytanie generuje te dokumenty:

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

Podkolekcje

Etap collection można też wykorzystać do kierowania na kolekcje w ramach konkretnego elementu nadrzędnego, podając pełną ścieżkę do etapu.

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

W tym przykładzie chcemy uwzględnić tylko działy w Nowym Jorku.

Node.js

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

Zwróci to wszystkie działy w pełnej ścieżce cities/NY/departments.

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