Method: projects.databases.documents.partitionQuery

{
  "partitionCount": string,
  "pageToken": string,
  "pageSize": integer,

  // Union field query_type can be only one of the following:
  "structuredQuery": {
    object (StructuredQuery)
  }
  // End of list of possible types for union field query_type.

  // Union field consistency_selector can be only one of the following:
  "readTime": string
  // End of list of possible types for union field consistency_selector.
}

string (int64 format)

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

たとえば、実行する並列クエリの数より 1 つ少ない数に設定したり、データ パイプライン ジョブを実行しているときに使用可能なワーカーまたはコンピューティング インスタンスの数より 1 少ない数に設定したりできます。

string

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

たとえば、pageToken を使用した後続の 2 つの呼び出しでは、次のような結果が返されます。

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

document.partitionQuery に指定したクエリの結果に基づいて並べ替えられた完全な結果セットを取得するには、カーソル A、カーソル B、カーソル M、カーソル Q、カーソル U、カーソル W の結果セットをマージする必要があります。

integer

この呼び出しで返されるパーティションの最大数。partitionCount の対象となります。

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

object (StructuredQuery)

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

string (Timestamp format)

指定された時点のドキュメントを読み取ります。

これは、過去 1 時間以内のマイクロ秒の精度のタイムスタンプにする必要があります。ポイントインタイム リカバリが有効になっている場合は、過去 7 日間以内の 1 分単位のタイムスタンプにすることもできます。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。