Class AggregationQuery (2.12.0)

Version 2.12.0

• 2.19.0 (latest)
• 2.18.0
• 2.17.2
• 2.16.1
• 2.15.0
• 2.14.0
• 2.13.1
• 2.12.0
• 2.11.1
• 2.10.1
• 2.9.1
• 2.8.0
• 2.7.3
• 2.6.1
• 2.5.3
• 2.4.0
• 2.3.4
• 2.2.0
• 2.1.3
• 2.0.2
• 1.9.2
• 1.8.1
• 1.7.0
• 1.6.2
• 1.5.0
• 1.4.0
• 1.3.0

AggregationQuery(nested_query)

Represents an aggregation query to the Firestore API.

Methods

get

get(
    transaction=None,
    retry: Union[
        retries.Retry, None, gapic_v1.method._MethodDefault
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: float | None = None,
) -> 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
list	The aggregation query results

stream

stream(
    transaction=None,
    retry: Union[
        retries.Retry, None, gapic_v1.method._MethodDefault
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: float | None = None,
) -> Union[Generator[List[AggregationResult], Any, None]]

Runs the aggregation query.

This sends a RunAggregationQuery RPC and then returns an iterator which consumes each document returned in the stream of RunAggregationQueryResponse messages.

If a transaction is used and it already has write operations added, this method cannot be used (i.e. read-after-write is not allowed).

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 :Yields: AggregationResult -- The result of aggregations of this query The timeout for this request. Defaults to a system-specified value.