runAggregationQuery method
- RunAggregationQueryRequest request,
- String parent, {
- String? $fields,
Runs an aggregation query.
Rather than producing Document results like Firestore.RunQuery, this API
allows running an aggregation to produce a series of AggregationResult
server-side. High-Level Example: -- Return the number of documents in table given a filter. SELECT COUNT(*) FROM ( SELECT * FROM k where a = true );
request
- The metadata request object.
Request parameters:
parent
- Required. The parent resource name. In the format:
projects/{project_id}/databases/{database_id}/documents
or
projects/{project_id}/databases/{database_id}/documents/{document_path}
.
For example: projects/my-project/databases/my-database/documents
or
projects/my-project/databases/my-database/documents/chatrooms/my-chatroom
Value must have pattern
^projects/\[^/\]+/databases/\[^/\]+/documents/\[^/\]+/.*$
.
$fields
- Selector specifying which fields to include in a partial
response.
Completes with a RunAggregationQueryResponse.
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<RunAggregationQueryResponse> runAggregationQuery(
RunAggregationQueryRequest 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') + ':runAggregationQuery';
final response_ = await _requester.request(
url_,
'POST',
body: body_,
queryParams: queryParams_,
);
return (response_ as core.List)
.map((value) => RunAggregationQueryResponseElement.fromJson(
value as core.Map<core.String, core.dynamic>))
.toList();
}