Class Aggregation (2.10.1)

Stay organized with collections Save and categorize content based on your preferences.
Aggregation(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Defines a aggregation that produces a single result.

.. _oneof:


Count aggregator. This field is a member of oneof_ operator.
alias str
Optional. Optional name of the field to store the result of the aggregation into. If not provided, Firestore will pick a default name following the format field_. For example: :: AGGREGATE COUNT_UP_TO(1) AS count_up_to_1, COUNT_UP_TO(2), COUNT_UP_TO(3) AS count_up_to_3, COUNT_UP_TO(4) OVER ( ... ); becomes: :: AGGREGATE COUNT_UP_TO(1) AS count_up_to_1, COUNT_UP_TO(2) AS field_1, COUNT_UP_TO(3) AS count_up_to_3, COUNT_UP_TO(4) AS field_2 OVER ( ... ); Requires: - Must be unique across all aggregation aliases. - Conform to [document field name][google.firestore.v1.Document.fields] limitations.



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

Count of documents that match the query.

The COUNT(*) aggregation function operates on the entire document so it does not require a field reference.