Class BaseAggregationQuery (2.20.2)
Stay organized with collections Save and categorize content based on your preferences.

BaseAggregationQuery(nested_query,alias:typing.Optional[str]=None)

Represents an aggregation query to the Firestore API.

Methods

add_aggregation

add_aggregation(aggregation:google.cloud.firestore_v1.base_aggregation.BaseAggregation,)-> None

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:typing.List[google.cloud.firestore_v1.base_aggregation.BaseAggregation],)-> None

Adds a list of aggregations to the nested query

Parameter
Name	Description
`aggregations`	`list` a list of aggregation operations

avg

avg(field_ref:str|google.cloud.firestore_v1.field_path.FieldPath,alias:typing.Optional[str]=None,)

Adds an avg over the nested query

count

count(alias:typing.Optional[str]=None)

Adds a count over the nested query

get

get(transaction=None,retry:Union[retries.Retry,retries.AsyncRetry,None,object]=_MethodDefault._DEFAULT_VALUE,timeout:float|None=None,*,explain_options:Optional[ExplainOptions]=None)-> (QueryResultsList[AggregationResult]|Coroutine[Any,Any,List[List[AggregationResult]]])

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
`(QueryResultsList[List[AggregationResult]] Coroutine[Any, Any, List[List[AggregationResult]]])`	The aggregation query results.

stream

stream(transaction:Optional[transaction.Transaction]=None,retry:(retries.Retry|retries.AsyncRetry|object|None)=_MethodDefault._DEFAULT_VALUE,timeout:Optional[float]=None,*,explain_options:Optional[ExplainOptions]=None)-> (StreamGenerator[List[AggregationResult]]|AsyncStreamGenerator[List[AggregationResult]])