aggregate method
Future<AggregateResponse?>
aggregate(
- String tenantId,
- AggregationRequest aggregationRequest, [
- AggregateOptions? options
Aggregates documents by grouping them (if groupBy is provided) and applying multiple operations. Different operations (e.g. sum, countDistinct, avg, etc.) are supported.
Parameters:
-
String tenantId (required):
-
AggregationRequest aggregationRequest (required):
-
String parentTenantId:
-
bool includeStats:
Implementation
Future<AggregateResponse?> aggregate(String tenantId, AggregationRequest aggregationRequest, [ AggregateOptions? options ]) async {
final response = await aggregateWithHttpInfo(tenantId, aggregationRequest, options);
if (response.statusCode >= HttpStatus.badRequest) {
throw ApiException(response.statusCode, await _decodeBodyBytes(response));
}
// When a remote server returns no body with a status of 204, we shall not decode it.
// At the time of writing this, `dart:convert` will throw an "Unexpected end of input"
// FormatException when trying to decode an empty string.
if (response.body.isNotEmpty && response.statusCode != HttpStatus.noContent) {
return await apiClient.deserializeAsync(await _decodeBodyBytes(response), 'AggregateResponse',) as AggregateResponse;
}
return null;
}