Firestore in Datastore mode V1 API - Class Google::Cloud::Datastore::V1::AggregationQuery::Aggregation (v1.0.0)

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

Defines an aggregation that produces a single result.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#alias

def alias() -> ::String
Returns
  • (::String) —

    Optional. Optional name of the property to store the result of the aggregation.

    If not provided, Datastore will pick a default name following the format property_<incremental_id++>. 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 property_1, COUNT_UP_TO(3) AS count_up_to_3, COUNT(*) AS property_2 OVER ( ... );

    Requires:

    • Must be unique across all aggregation aliases.
    • Conform to [entity property name][google.datastore.v1.Entity.properties] limitations.

#alias=

def alias=(value) -> ::String
Parameter
  • value (::String) —

    Optional. Optional name of the property to store the result of the aggregation.

    If not provided, Datastore will pick a default name following the format property_<incremental_id++>. 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 property_1, COUNT_UP_TO(3) AS count_up_to_3, COUNT(*) AS property_2 OVER ( ... );

    Requires:

    • Must be unique across all aggregation aliases.
    • Conform to [entity property name][google.datastore.v1.Entity.properties] limitations.
Returns
  • (::String) —

    Optional. Optional name of the property to store the result of the aggregation.

    If not provided, Datastore will pick a default name following the format property_<incremental_id++>. 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 property_1, COUNT_UP_TO(3) AS count_up_to_3, COUNT(*) AS property_2 OVER ( ... );

    Requires:

    • Must be unique across all aggregation aliases.
    • Conform to [entity property name][google.datastore.v1.Entity.properties] limitations.

#avg

def avg() -> ::Google::Cloud::Datastore::V1::AggregationQuery::Aggregation::Avg
Returns

#avg=

def avg=(value) -> ::Google::Cloud::Datastore::V1::AggregationQuery::Aggregation::Avg
Parameter
Returns

#count

def count() -> ::Google::Cloud::Datastore::V1::AggregationQuery::Aggregation::Count
Returns

#count=

def count=(value) -> ::Google::Cloud::Datastore::V1::AggregationQuery::Aggregation::Count
Parameter
Returns

#sum

def sum() -> ::Google::Cloud::Datastore::V1::AggregationQuery::Aggregation::Sum
Returns

#sum=

def sum=(value) -> ::Google::Cloud::Datastore::V1::AggregationQuery::Aggregation::Sum
Parameter
Returns