Class AggregationResult (2.7.0)

Version 2.7.0

• 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

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

The result of a single bucket from a Firestore aggregation query.

The keys of aggregate_fields are the same for all results in an aggregation query, unlike document queries which can have different fields present for each result.

Attribute

Name	Description
aggregate_fields	Mapping[str, google.cloud.firestore_v1.types.Value] The result of the aggregation functions, ex: ``COUNT(*) AS total_docs``. The key is the `alias][google.firestore.v1.StructuredAggregationQuery.Aggregation.alias]` assigned to the aggregation function on input and the size of this map equals the number of aggregation functions in the query.

Inheritance

builtins.object > proto.message.Message > AggregationResult

Classes

AggregateFieldsEntry

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

The abstract base class for a message.

Parameters

Name	Description
kwargs	dict Keys and values corresponding to the fields of the message.
mapping	Union[dict, `.Message`] A dictionary or message to be used to determine the values for this message.
ignore_unknown_fields	Optional(bool) If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.