Class Aggregation (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

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

Attributes
Name	Description
count	google.cloud.firestore_v1.types.StructuredAggregationQuery.Aggregation.Count Count aggregator. This field is a member of oneof_ operator.
sum	google.cloud.firestore_v1.types.StructuredAggregationQuery.Aggregation.Sum Sum aggregator. This field is a member of oneof_ operator.
avg	google.cloud.firestore_v1.types.StructuredAggregationQuery.Aggregation.Avg Average 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(*) 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(*) AS field_2 OVER ( ... ); Requires: - Must be unique across all aggregation aliases. - Conform to [document field name][google.firestore.v1.Document.fields] limitations.

Classes

Avg

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

Average of the values of the requested field.

• Only numeric values will be aggregated. All non-numeric values including NULL are skipped.

• If the aggregated values contain NaN, returns NaN. Infinity math follows IEEE-754 standards.

• If the aggregated value set is empty, returns NULL.

• Always returns the result as a double.

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.

Sum

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

Sum of the values of the requested field.

• Only numeric values will be aggregated. All non-numeric values including NULL are skipped.

• If the aggregated values contain NaN, returns NaN. Infinity math follows IEEE-754 standards.

• If the aggregated value set is empty, returns 0.

• Returns a 64-bit integer if all aggregated numbers are integers and the sum result does not overflow. Otherwise, the result is returned as a double. Note that even if all the aggregated values are integers, the result is returned as a double if it cannot fit within a 64-bit signed integer. When this occurs, the returned value will lose precision.

• When underflow occurs, floating-point aggregation is non-deterministic. This means that running the same query repeatedly without any changes to the underlying values could produce slightly different results each time. In those cases, values should be stored as integers over floating-point numbers.