Classes for representing aggregation queries for the Google Cloud Firestore API.
A AggregationQuery can be created directly from a Collection and that can be a more common way to create an aggregation query than direct usage of the constructor.
Classes
AggregationResult
AggregationResult(alias: str, value: int, read_time=None)A class representing result from Aggregation Query
| Parameters | |
|---|---|
| Name | Description |
alias |
str
The alias for the aggregation. |
value |
int
The resulting read_time |
AvgAggregation
AvgAggregation(
field_ref: str | google.cloud.firestore_v1.field_path.FieldPath,
alias: typing.Optional[str] = None,
)Helper class that provides a standard way to create an ABC using inheritance.
BaseAggregation
BaseAggregation(alias: typing.Optional[str] = None)Helper class that provides a standard way to create an ABC using inheritance.
BaseAggregationQuery
BaseAggregationQuery(nested_query, alias: typing.Optional[str] = None)Represents an aggregation query to the Firestore API.
CountAggregation
CountAggregation(alias: typing.Optional[str] = None)Helper class that provides a standard way to create an ABC using inheritance.
SumAggregation
SumAggregation(
field_ref: str | google.cloud.firestore_v1.field_path.FieldPath,
alias: typing.Optional[str] = None,
)Helper class that provides a standard way to create an ABC using inheritance.