Class Aggregation (2.7.1)

Version 2.7.1

• 2.16.0 (latest)
• 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

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

Defines a aggregation that produces a single result.

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

Attributes

Name	Description
count	google.cloud.firestore_v1.types.StructuredAggregationQuery.Aggregation.Count 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_

Inheritance

builtins.object > proto.message.Message > Aggregation

Classes

Count

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.