Документы

Описание

Возвращает документы, осуществляя поиск по фиксированному набору предопределенных документов.

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

Этот этап работает аналогично функции batchGet в Cloud Firestore и позволяет фильтровать результаты напрямую, без выполнения дополнительных шагов фильтрации после пакетной операции.

Примеры

Web 

const results = await execute(db.pipeline()
  .documents([
    doc(db, "cities", "SF"),
    doc(db, "cities", "DC"),
    doc(db, "cities", "NY")
  ])
);
Быстрый 
let results = try await db.pipeline()
  .documents([
    db.collection("cities").document("SF"),
    db.collection("cities").document("DC"),
    db.collection("cities").document("NY")
  ]).execute()

Kotlin 

val results = db.pipeline()
    .documents(
        db.collection("cities").document("SF"),
        db.collection("cities").document("DC"),
        db.collection("cities").document("NY")
    ).execute()

Java 

      Task<Pipeline.Snapshot> results = db.pipeline()
    .documents(
        db.collection("cities").document("SF"),
        db.collection("cities").document("DC"),
        db.collection("cities").document("NY")
    ).execute();
Python 
results = (
    client.pipeline()
    .documents(
        client.collection("cities").document("SF"),
        client.collection("cities").document("DC"),
        client.collection("cities").document("NY"),
    )
    .execute()
)
Java 
Pipeline.Snapshot results =
    firestore
        .pipeline()
        .documents(
            firestore.collection("cities").document("SF"),
            firestore.collection("cities").document("DC"),
            firestore.collection("cities").document("NY"))
        .execute()
        .get();
Идти 
snapshot := client.Pipeline().
	Documents([]*firestore.DocumentRef{
		client.Collection("cities").Doc("SF"),
		client.Collection("cities").Doc("DC"),
		client.Collection("cities").Doc("NY"),
	}).
	Execute(ctx)

Поведение

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

Порядок документов, возвращаемых на этапе documents(...) , нестабилен и на него нельзя полагаться. Для получения детерминированного порядка можно использовать последующий этап 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"});

Этап documents(...) можно использовать для извлечения только документов SF и NYC , а затем сортировки их в порядке возрастания имени.

Node.js 

const results = await db.pipeline()
  .documents(
    db.collection("cities").doc("SF"),
    db.collection("cities").doc("NYC"))
  .sort(field("name").ascending())
  .execute();

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

  { name: "New York City", state: "New York" }
  { name: "San Francsico", state: "California" }