Method: googleapis.firestore.v1.projects.databases.documents.partitionQuery

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.

Arguments

Parameters
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.
body	object (PartitionQueryRequest) Required.

Raised exceptions

Exceptions
ConnectionError	In case of a network problem (such as DNS failure or refused connection).
HttpError	If the response status is >= 400 (excluding 429 and 503).
TimeoutError	If a long-running operation takes longer to finish than the specified timeout limit.
TypeError	If an operation or function receives an argument of the wrong type.
ValueError	If an operation or function receives an argument of the right type but an inappropriate value. For example, a negative timeout.

Response

If successful, the response contains an instance of PartitionQueryResponse.

Subworkflow snippet

Some fields might be optional or required. To identify required fields, refer to the API documentation.

YAML

- partitionQuery:
    call: googleapis.firestore.v1.projects.databases.documents.partitionQuery
    args:
        parent: ...
        body:
            pageSize: ...
            pageToken: ...
            partitionCount: ...
            structuredQuery:
                endAt:
                    before: ...
                    values: ...
                from: ...
                limit: ...
                offset: ...
                orderBy: ...
                select:
                    fields: ...
                startAt: ...
                where:
                    compositeFilter:
                        filters: ...
                        op: ...
                    fieldFilter:
                        field:
                            fieldPath: ...
                        op: ...
                        value:
                            arrayValue:
                                values: ...
                            booleanValue: ...
                            bytesValue: ...
                            doubleValue: ...
                            geoPointValue:
                                latitude: ...
                                longitude: ...
                            integerValue: ...
                            mapValue:
                                fields: ...
                            nullValue: ...
                            referenceValue: ...
                            stringValue: ...
                            timestampValue: ...
                    unaryFilter:
                        field: ...
                        op: ...
    result: partitionQueryResult

JSON

[
  {
    "partitionQuery": {
      "call": "googleapis.firestore.v1.projects.databases.documents.partitionQuery",
      "args": {
        "parent": "...",
        "body": {
          "pageSize": "...",
          "pageToken": "...",
          "partitionCount": "...",
          "structuredQuery": {
            "endAt": {
              "before": "...",
              "values": "..."
            },
            "from": "...",
            "limit": "...",
            "offset": "...",
            "orderBy": "...",
            "select": {
              "fields": "..."
            },
            "startAt": "...",
            "where": {
              "compositeFilter": {
                "filters": "...",
                "op": "..."
              },
              "fieldFilter": {
                "field": {
                  "fieldPath": "..."
                },
                "op": "...",
                "value": {
                  "arrayValue": {
                    "values": "..."
                  },
                  "booleanValue": "...",
                  "bytesValue": "...",
                  "doubleValue": "...",
                  "geoPointValue": {
                    "latitude": "...",
                    "longitude": "..."
                  },
                  "integerValue": "...",
                  "mapValue": {
                    "fields": "..."
                  },
                  "nullValue": "...",
                  "referenceValue": "...",
                  "stringValue": "...",
                  "timestampValue": "..."
                }
              },
              "unaryFilter": {
                "field": "...",
                "op": "..."
              }
            }
          }
        }
      },
      "result": "partitionQueryResult"
    }
  }
]