Google は、黒人コミュニティのための人種的公平の促進に取り組んでいます。詳細をご覧ください。
このページは Cloud Translation API によって翻訳されました。
Switch to English

Method: projects.databases.documents.partitionQuery

クエリを並行して実行するために使用できるパーティションカーソルを返すことにより、クエリをパーティション化します。返されるパーティションカーソルは、documents.runQueryがクエリ結果の開始点/終了点として使用できる分割点です。

HTTPリクエスト

POST https://firestore.googleapis.com/v1beta1/{parent=projects/*/databases/*/documents}:partitionQuery

URLはgRPCトランスコーディング構文を使用します。

パスパラメータ

パラメーター
parent

string

必須。親リソース名。形式: projects/{project_id}/databases/{databaseId}/documents 。ドキュメントリソース名はサポートされていません。指定できるのはデータベースリソース名のみです。

リクエスト本文

リクエスト本文には、次の構造のデータが含まれています。

JSON表現
{
  "partitionCount": string,
  "pageToken": string,
  "pageSize": integer,
  "structuredQuery": {
    object (StructuredQuery)
  }
}
田畑
partitionCount

string ( int64 format)

パーティションポイントの必要な最大数。パーティションは、結果の複数のページにわたって返される場合があります。数値は正でなければなりません。実際に返されるパーティションの数はこれより少ない場合があります。

たとえば、これは、実行する並列クエリの数より1少ない数に設定したり、データパイプラインジョブの実行時に、使用可能なワーカーまたは計算インスタンスの数より1つ少ない数に設定したりできます。

pageToken

string

追加の結果セットを取得するために使用できるdocuments.partitionQueryへの前回の呼び出しから返されたnextPageToken値。結果のセット間の順序の保証はありません。したがって、複数の結果セットを使用するには、異なる結果セットをマージする必要があります。

たとえば、pageTokenを使用した2回の後続の呼び出しは、次を返す場合があります。

  • カーソルB、カーソルM、カーソルQ
  • カーソルA、カーソルU、カーソルW

documents.partitionQueryに提供されたクエリの結果に関して順序付けられた完全な結果セットを取得するには、結果セットをマージする必要があります:カーソルA、カーソルB、カーソルM、カーソルQ、カーソルU、カーソルW

pageSize

integer

この呼び出しで戻り、対象へのパーティションの最大数partitionCount

たとえば、 partitionCount = 10およびpageSize = 8の場合、documents.partitionQueryを最初に呼び出すと、最大8つのパーティションが返され、さらに結果が存在する場合はnextPageTokenが返されます。 documents.partitionQueryを2回呼び出すと、最大2つのパーティションが返され、 partitionCount指定された合計10個が完了します。

structuredQuery

object ( StructuredQuery )

構造化クエリ。クエリでは、すべての子孫を含むコレクションを指定し、名前の昇順で並べ替える必要があります。その他のフィルター、順序順、制限、オフセット、および開始/終了カーソルはサポートされていません。

レスポンスボディ

成功した場合、応答本文には次の構造のデータが含まれます。

Firestore.PartitionQueryの応答。

JSON表現
{
  "partitions": [
    {
      object (Cursor)
    }
  ],
  "nextPageToken": string
}
田畑
partitions[]

object ( Cursor )

結果を分割します。各パーティションは、documents.runQueryがクエリ結果の開始点または終了点として使用できる分割点です。 documents.runQueryリクエストは、このdocuments.partitionQueryリクエストに提供されたものと同じクエリを使用して作成する必要があります。パーティションカーソルは、documents.partitionQueryに提供されたクエリの結果と同じ順序で並べられます。

たとえば、documents.partitionQueryリクエストがパーティションカーソルAとBを返す場合、次の3つのクエリを実行すると、元のクエリの結果セット全体が返されます。

  • クエリ、endAt A
  • クエリ、startAt A、endAt B
  • クエリ、startAt B

空の結果は、クエリの結果が少なすぎてパーティション化できないことを示している可能性があります。

nextPageToken

string

documents.partitionQueryリクエストのpartitionCountで指定された数まで、追加の結果セットをリクエストするために使用できるページトークン。空白の場合、それ以上の結果はありません。

承認範囲

次のOAuthスコープのいずれかが必要です。

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要を参照してください。