BaseAggregationQuery(nested_query)Represents an aggregation query to the Firestore API.
Methods
add_aggregation
add_aggregation(
aggregation: google.cloud.firestore_v1.base_aggregation.BaseAggregation,
)Adds an aggregation operation to the nested query
| Parameter | |
|---|---|
| Name | Description |
aggregation |
BaseAggregation
An aggregation operation, e.g. a CountAggregation |
add_aggregations
add_aggregations(
aggregations: List[google.cloud.firestore_v1.base_aggregation.BaseAggregation],
)Adds a list of aggregations to the nested query
| Parameter | |
|---|---|
| Name | Description |
aggregations |
list
a list of aggregation operations |
count
count(alias: str | None = None)Adds a count over the nested query
get
get(transaction=None, retry: Union[retries.Retry, None, gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: float | None = None)Runs the aggregation query.
This sends a RunAggregationQuery RPC and returns a list of aggregation results in the stream of RunAggregationQueryResponse messages.
| Parameters | |
|---|---|
| Name | Description |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. Defaults to a system-specified policy. |
timeout |
float
The timeout for this request. Defaults to a system-specified value. |
| Returns | |
|---|---|
| Type | Description |
list | The aggregation query results |
stream
stream(transaction=None, retry: Union[retries.Retry, None, gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: float | None = None)Runs the aggregation query.
This sends aRunAggregationQuery RPC and returns an iterator in the stream of RunAggregationQueryResponse messages.
| Parameters | |
|---|---|
| Name | Description |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. Defaults to a system-specified policy. |
timeout |
float
The timeout for this request. Defaults to a system-specified value. |
| Returns | |
|---|---|
| Type | Description |
list | The aggregation query results |