Module base_aggregation (2.10.0)

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
NameDescription
alias str

The alias for the aggregation.

value int

The resulting read_time

BaseAggregation

BaseAggregation()

Helper class that provides a standard way to create an ABC using inheritance.

BaseAggregationQuery

BaseAggregationQuery(nested_query)

Represents an aggregation query to the Firestore API.

CountAggregation

CountAggregation(alias: str | None = None)

Helper class that provides a standard way to create an ABC using inheritance.