ドキュメント

説明

事前定義されたドキュメントの固定されたセットを検索して、ドキュメントを返します。

ステージは 1 つ以上のドキュメントを入力として受け取る必要があり、パスが重複するドキュメントを含めることはできません。リファレンス ドキュメントが存在しない場合、そのドキュメント パスの結果は生成されません。

このステージは Firestore の batchGet と同様に動作し、バッチ オペレーションの後にポスト フィルタリング手順を実行するのではなく、結果を直接フィルタリングできます。

構文

Node.js

const results = await db.pipeline()
  .documents(
    db.collection("cities").doc("SF"),
    db.collection("cities").doc("NY"))
  .execute();

クライアントの例

Web

const results = await execute(db.pipeline()
  .documents([
    doc(db, "cities", "SF"),
    doc(db, "cities", "DC"),
    doc(db, "cities", "NY")
  ])
);
test.firestore.js
Swift
let results = try await db.pipeline()
  .documents([
    db.collection("cities").document("SF"),
    db.collection("cities").document("DC"),
    db.collection("cities").document("NY")
  ]).execute()
PipelineSnippets.swift

Kotlin

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

Java

Task<Pipeline.Snapshot> results = db.pipeline()
    .documents(
        db.collection("cities").document("SF"),
        db.collection("cities").document("DC"),
        db.collection("cities").document("NY")
    ).execute();
DocSnippets.java
Python
results = (
    client.pipeline()
    .documents(
        client.collection("cities").document("SF"),
        client.collection("cities").document("DC"),
        client.collection("cities").document("NY"),
    )
    .execute()
)
firestore_pipelines.py
Java
Pipeline.Snapshot results =
    firestore
        .pipeline()
        .documents(
            firestore.collection("cities").document("SF"),
            firestore.collection("cities").document("DC"),
            firestore.collection("cities").document("NY"))
        .execute()
        .get();
PipelineSnippets.java

動作

documents ステージを使用するには、パイプラインの最初のステージとして登場する必要があります。

documents ステージから返されるドキュメントの順序は不安定であり、それに依存すべきではありません。後続の並べ替えステージを使用して、決定的な順序を取得できます。

ドキュメントの例:

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