Class BaseAggregationQuery (2.19.0)

Version latest

• 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

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, None, gapic_v1.method._MethodDefault
    ] = _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: Union[
        retries.Retry, None, gapic_v1.method._MethodDefault
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: Optional[float] = None,
    *,
    explain_options: Optional[ExplainOptions] = None
) -> (
    StreamGenerator[List[AggregationResult]]
    | AsyncStreamGenerator[List[AggregationResult]]
)

Runs the aggregation query.

This sends aRunAggregationQuery RPC and returns a generator in the stream of RunAggregationQueryResponse messages.

Parameters
Name	Description
retry	Optional[google.api_core.retry.Retry] Designation of what errors, if any, should be retried. Defaults to a system-specified policy.
timeout	Optinal[float] The timeout for this request. Defaults to a system-specified value.

Returns
Type	Description
StreamGenerator[List[AggregationResult]] AsyncStreamGenerator[List[AggregationResult]]	A generator of the query results.

sum

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

Adds a sum over the nested query