Коллекция

Описание

Возвращает все документы из заданной коллекции. Коллекция может быть вложенной.

Примеры

Web 

const results = await execute(db.pipeline()
  .collection("users/bob/games")
  .sort(field("name").ascending())
  );
Быстрый 
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();
Идти 
snapshot := client.Pipeline().
	Collection("users/bob/games").
	Sort(firestore.Orders(firestore.Ascending(firestore.FieldOf("name")))).
	Execute(ctx)

Поведение

Для использования этапа collection(...) он должен быть первым этапом в конвейере (или подконвейере).

Порядок документов, возвращаемых на этапе collection(...) , нестабилен и на него нельзя полагаться. Firestore попытается выполнить запрос наиболее эффективным способом, что может изменить порядок в зависимости от схемы или конфигурации индекса. Для получения детерминированного порядка можно использовать последующий этап sort(...) .

Например, для следующих документов:

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

Этап collection позволяет получить все города из cities , а затем отсортировать их в порядке возрастания названия.

Node.js 

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

Данный запрос выдает следующие документы: 

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

Подколлекции

Этап collection(...) также можно использовать для выбора коллекций, находящихся под управлением определенного родительского элемента, указав полный путь к этапу.

Например, для следующих документов:

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

В этом примере нам нужны только департаменты города Нью-Йорка.

Node.js 

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

В результате будут возвращены все департаменты, указанные в полном пути cities/NY/departments . 

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