Class BaseAggregationQuery (2.16.1)

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: typing.Union[
        google.api_core.retry.retry_unary.Retry,
        None,
        google.api_core.gapic_v1.method._MethodDefault,
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Optional[float] = None,
) -> typing.Union[
    typing.List[google.cloud.firestore_v1.base_aggregation.AggregationResult],
    typing.Coroutine[
        typing.Any,
        typing.Any,
        typing.List[google.cloud.firestore_v1.base_aggregation.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: typing.Union[
        google.api_core.retry.retry_unary.Retry,
        None,
        google.api_core.gapic_v1.method._MethodDefault,
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Optional[float] = None,
) -> typing.Union[
    typing.Generator[
        typing.List[google.cloud.firestore_v1.base_aggregation.AggregationResult],
        typing.Any,
        None,
    ],
    typing.AsyncGenerator[
        typing.List[google.cloud.firestore_v1.base_aggregation.AggregationResult], None
    ],
]

Runs the aggregation query.

This sends aRunAggregationQuery RPC and returns an iterator 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

sum

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

Adds a sum over the nested query