Raccolta

Descrizione

Restituisce tutti i documenti di una determinata raccolta. La raccolta può essere nidificata.

Esempi

Web

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

Kotlin

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

Java

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

results = (
    client.pipeline()
    .collection("users/bob/games")
    .sort(Field.of("name").ascending())
    .execute()
)
Java
Pipeline.Snapshot results =
    firestore
        .pipeline()
        .collection("users/bob/games")
        .sort(ascending(field("name")))
        .execute()
        .get();

Comportamento

Per utilizzare la fase collection(...), questa deve essere la prima fase nella pipeline (o nella sottopipeline).

L'ordine dei documenti restituiti dalla fase collection(...) è instabile e non è affidabile. Firestore tenterà di eseguire la query nel modo più efficiente possibile, il che può modificare l'ordine a seconda della configurazione dello schema o dell'indice. È possibile utilizzare una fase sort(...) successiva per ottenere un ordinamento deterministico.

Ad esempio, per i seguenti documenti:

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 fase collection può essere utilizzata per recuperare tutte le città nella raccolta cities e poi ordinarle in ordine crescente di nome.

Node.js

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

Questa query produce i seguenti documenti:

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

Sottoraccolte

La fase collection(...) può essere utilizzata anche per scegliere come target le raccolte in un elemento padre specifico fornendo il percorso completo alla fase.

Ad esempio, per i seguenti documenti:

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

Per questo esempio, vogliamo solo i dipartimenti della città di New York.

Node.js

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

Verranno restituiti tutti i dipartimenti nel percorso completo cities/NY/departments.

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