partitionQuery method

Future<PartitionQueryResponse> partitionQuery(PartitionQueryRequest request, String parent, { String? $fields, })

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 - The metadata request object.

Request parameters:

parent - 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. Value must have pattern ^projects/\[^/\]+/databases/\[^/\]+/documents/\[^/\]+/.*$.

$fields - Selector specifying which fields to include in a partial response.

Completes with a PartitionQueryResponse.

Completes with a commons.ApiRequestError if the API endpoint returned an error.

If the used http.Client completes with an error when making a REST call, this method will complete with the same error.

Implementation

async.Future<PartitionQueryResponse> partitionQuery(
  PartitionQueryRequest request,
  core.String parent, {
  core.String? $fields,
}) async {
  final body_ = convert.json.encode(request);
  final queryParams_ = <core.String, core.List<core.String>>{
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'v1/' + core.Uri.encodeFull('$parent') + ':partitionQuery';

  final response_ = await _requester.request(
    url_,
    'POST',
    body: body_,
    queryParams: queryParams_,
  );
  return PartitionQueryResponse.fromJson(
      response_ as core.Map<core.String, core.dynamic>);
}