Группа сбора

Описание

Возвращает все документы из любой коллекции с указанным идентификатором коллекции, независимо от ее родительского элемента.

Примеры

Web 

const results = await execute(db.pipeline()
  .collectionGroup("games")
  .sort(field("name").ascending())
  );
Быстрый 
let results = try await db.pipeline()
  .collectionGroup("games")
  .sort([Field("name").ascending()])
  .execute()

Kotlin 

val results = db.pipeline()
    .collectionGroup("games")
    .sort(field("name").ascending())
    .execute()

Java 

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

results = (
    client.pipeline()
    .collection_group("games")
    .sort(Field.of("name").ascending())
    .execute()
)
Java 
Pipeline.Snapshot results =
    firestore
        .pipeline()
        .collectionGroup("games")
        .sort(ascending(field("name")))
        .execute()
        .get();
Идти 
snapshot := client.Pipeline().
	CollectionGroup("games").
	Sort(firestore.Orders(firestore.Ascending(firestore.FieldOf("name")))).
	Execute(ctx)

Поведение

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

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

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

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

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

Node.js 

const results = await db.pipeline()
  .collectionGroup("departments")
  .sort(field("employees").ascending())
  .execute();

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

  { name: "SF Building Deparment", employees: 750 }
  { name: "CHI Building Deparment", employees: 900 }
  { name: "NY Building Deparment", employees: 1000 }
  { name: "NY Finance Deparment", employees: 1200 }