Class StructuredAggregationQuery (2.14.0)

StructuredAggregationQuery(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Firestore query for running an aggregation over a StructuredQuery][google.firestore.v1.StructuredQuery].

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes

NameDescription
structured_query google.cloud.firestore_v1.types.StructuredQuery
Nested structured query. This field is a member of oneof_ query_type.
aggregations MutableSequence[google.cloud.firestore_v1.types.StructuredAggregationQuery.Aggregation]
Optional. Series of aggregations to apply over the results of the structured_query. Requires: - A minimum of one and maximum of five aggregations per query.

Classes

Aggregation

Aggregation(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Defines an aggregation that produces a single result.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields