Firestore in Datastore mode V1 API - Class Google::Cloud::Datastore::V1::AggregationResult (v1.5.0)

Reference documentation and code samples for the Firestore in Datastore mode V1 API class Google::Cloud::Datastore::V1::AggregationResult.

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

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

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#aggregate_properties

def aggregate_properties() -> ::Google::Protobuf::Map{::String => ::Google::Cloud::Datastore::V1::Value}
Returns
  • (::Google::Protobuf::Map{::String => ::Google::Cloud::Datastore::V1::Value}) — The result of the aggregation functions, ex: COUNT(*) AS total_entities.

    The key is the alias assigned to the aggregation function on input and the size of this map equals the number of aggregation functions in the query.

#aggregate_properties=

def aggregate_properties=(value) -> ::Google::Protobuf::Map{::String => ::Google::Cloud::Datastore::V1::Value}
Parameter
  • value (::Google::Protobuf::Map{::String => ::Google::Cloud::Datastore::V1::Value}) — The result of the aggregation functions, ex: COUNT(*) AS total_entities.

    The key is the alias assigned to the aggregation function on input and the size of this map equals the number of aggregation functions in the query.

Returns
  • (::Google::Protobuf::Map{::String => ::Google::Cloud::Datastore::V1::Value}) — The result of the aggregation functions, ex: COUNT(*) AS total_entities.

    The key is the alias assigned to the aggregation function on input and the size of this map equals the number of aggregation functions in the query.