Partitions a query by returning partition cursors that can be used to run the query in parallel. The returned partition cursors are split points that can be used by RunQuery as starting/end points for the query results.

Scopes

You will need authorization for at least one of the following scopes to make a valid call:

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

If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform. You can set the scope for this method like this: firestore1 --scope <scope> projects databases-documents-partition-query ...

Required Scalar Argument

• <parent> (string)
  • Required. The parent resource name. In the format: projects/{project_id}/databases/{database_id}/documents. Document resource names are not supported; only database resource names can be specified.

Required Request Value

The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.

For example, a structure like this:

PartitionQueryRequest:
  page-size: integer
  page-token: string
  partition-count: int64
  read-time: string
  structured-query:
    end-at:
      before: boolean
    limit: integer
    offset: integer
    start-at:
      before: boolean
    where:
      composite-filter:
        op: string
      field-filter:
        field:
          field-path: string
        op: string
        value:
          boolean-value: boolean
          bytes-value: string
          double-value: number
          geo-point-value:
            latitude: number
            longitude: number
          integer-value: string
          null-value: string
          reference-value: string
          string-value: string
          timestamp-value: string
      unary-filter:
        field:
          field-path: string
        op: string

can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.

• -r . page-size=92
  • The maximum number of partitions to return in this call, subject to partition_count. For example, if partition_count = 10 and page_size = 8, the first call to PartitionQuery will return up to 8 partitions and a next_page_token if more results exist. A second call to PartitionQuery will return up to 2 partitions, to complete the total of 10 specified in partition_count.
• page-token=dolores
  • The next_page_token value returned from a previous call to PartitionQuery that may be used to get an additional set of results. There are no ordering guarantees between sets of results. Thus, using multiple sets of results will require merging the different result sets. For example, two subsequent calls using a page_token may return: * cursor B, cursor M, cursor Q * cursor A, cursor U, cursor W To obtain a complete result set ordered with respect to the results of the query supplied to PartitionQuery, the results sets should be merged: cursor A, cursor B, cursor M, cursor Q, cursor U, cursor W
• partition-count=-62
  • The desired maximum number of partition points. The partitions may be returned across multiple pages of results. The number must be positive. The actual number of partitions returned may be fewer. For example, this may be set to one fewer than the number of parallel queries to be run, or in running a data pipeline job, one fewer than the number of workers or compute instances available.
• read-time=et
  • Reads documents as they were at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.

• structured-query.end-at before=false

  • If the position is just before or just after the given values, relative to the sort order defined by the query.

• .. limit=67

  • The maximum number of results to return. Applies after all other constraints. Requires: * The value must be greater than or equal to zero if specified.
• offset=67
  • The number of documents to skip before returning the first result. This applies after the constraints specified by the WHERE, START AT, & END AT but before the LIMIT clause. Requires: * The value must be greater than or equal to zero if specified.

• start-at before=false

  • If the position is just before or just after the given values, relative to the sort order defined by the query.

• ..where.composite-filter op=amet.

  • The operator for combining multiple filters.

• ..field-filter.field field-path=ea

  • A reference to a field in a document. Requires: * MUST be a dot-delimited (.) string of segments, where each segment conforms to document field name limitations.

• .. op=sadipscing

  • The operator to filter by.
• value boolean-value=true
  • A boolean value.
• bytes-value=no
  • A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries.
• double-value=0.7364988594037298
  • A double value.
• geo-point-value latitude=0.4551855025693473
  • The latitude in degrees. It must be in the range [-90.0, +90.0].

• longitude=0.8987894283575105

  • The longitude in degrees. It must be in the range [-180.0, +180.0].

• .. integer-value=et

  • An integer value.
• null-value=tempor
  • A null value.
• reference-value=aliquyam
  • A reference to a document. For example: projects/{project_id}/databases/{database_id}/documents/{document_path}.
• string-value=ipsum
  • A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries.

• timestamp-value=et

  • A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down.

• ...unary-filter.field field-path=sanctus

  • A reference to a field in a document. Requires: * MUST be a dot-delimited (.) string of segments, where each segment conforms to document field name limitations.

• .. op=lorem

  • The unary operator to apply.

About Cursors

The cursor position is key to comfortably set complex nested structures. The following rules apply:

• The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o .
• The cursor position is set relative to the top-level structure if it starts with ., e.g. -r .s.s
• You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar.
• You can move the cursor one level up by using ... Each additional . moves it up one additional level. E.g. ... would go three levels up.

Optional Output Flags

The method's return value a JSON encoded structure, which will be written to standard output by default.

• -o out
  • out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.

Optional General Properties

The following properties can configure any call, and are not specific to this method.

• -p $-xgafv=string

  • V1 error format.

• -p access-token=string

  • OAuth access token.

• -p alt=string

  • Data format for response.

• -p callback=string

  • JSONP

• -p fields=string

  • Selector specifying which fields to include in a partial response.

• -p key=string

  • API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

• -p oauth-token=string

  • OAuth 2.0 token for the current user.

• -p pretty-print=boolean

  • Returns response with indentations and line breaks.

• -p quota-user=string

  • Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• -p upload-type=string

  • Legacy upload protocol for media (e.g. "media", "multipart").

• -p upload-protocol=string

  • Upload protocol for media (e.g. "raw", "multipart").