firestore.projects.databases.documents.partition Query

POST {{baseUrl}}/v1/{{parent}}:partitionQuery?$.xgafv=<string>&access_token=<string>&alt=<string>&callback=<string>&fields=<string>&key=<string>&oauth_token=<string>&prettyPrint=<boolean>&quotaUser=<string>&upload_protocol=<string>&uploadType=<string>

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.

Request Params

Key	Datatype	Description
`$.xgafv`	string	V1 error format.
`access_token`	string	OAuth access token.
`alt`	string	Data format for response.
`callback`	string	JSONP
`fields`	string	Selector specifying which fields to include in a partial response.
`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.
`oauth_token`	string	OAuth 2.0 token for the current user.
`prettyPrint`	string	Returns response with indentations and line breaks.
`quotaUser`	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.
`upload_protocol`	string	Upload protocol for media (e.g. "raw", "multipart").
`uploadType`	string	Legacy upload protocol for media (e.g. "media", "multipart").

Request Body

{"pageSize"=>"<integer>", "pageToken"=>"<string>", "partitionCount"=>"<int64>", "structuredQuery"=>{"endAt"=>{"before"=>"<boolean>", "values"=>[{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, {"value"=>"<Error: Too many levels of nesting to fake this schema>"}]}, "from"=>[{"allDescendants"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "collectionId"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}, {"allDescendants"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "collectionId"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}], "limit"=>"<integer>", "offset"=>"<integer>", "orderBy"=>[{"direction"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "field"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}, {"direction"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "field"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}], "select"=>{"fields"=>[{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, {"value"=>"<Error: Too many levels of nesting to fake this schema>"}]}, "startAt"=>{"before"=>"<boolean>", "values"=>[{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, {"value"=>"<Error: Too many levels of nesting to fake this schema>"}]}, "where"=>{"compositeFilter"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "fieldFilter"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "unaryFilter"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}}}

HEADERS

Key	Datatype	Required	Description
`Content-Type`	string

RESPONSES

status: OK

{&quot;nextPageToken&quot;:&quot;incididunt id Excepteur&quot;,&quot;partitions&quot;:[{&quot;before&quot;:&quot;\u003cboolean\u003e&quot;,&quot;values&quot;:[{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;}]},{&quot;before&quot;:&quot;\u003cboolean\u003e&quot;,&quot;values&quot;:[{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;}]}]}