Cloud Firestore V1 API - Class Google::Cloud::Firestore::V1::StructuredAggregationQuery::Aggregation (v1.0.0)

Reference documentation and code samples for the Cloud Firestore V1 API class Google::Cloud::Firestore::V1::StructuredAggregationQuery::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 field to store the result of the aggregation into.

    If not provided, Firestore will pick a default name following the format field_<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 field_1, COUNT_UP_TO(3) AS count_up_to_3, COUNT(*) AS field_2 OVER ( ... );

    Requires:

#alias=

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

    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_<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 field_1, COUNT_UP_TO(3) AS count_up_to_3, COUNT(*) AS field_2 OVER ( ... );

    Requires:

Returns
  • (::String) —

    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_<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 field_1, COUNT_UP_TO(3) AS count_up_to_3, COUNT(*) AS field_2 OVER ( ... );

    Requires:

#avg

def avg() -> ::Google::Cloud::Firestore::V1::StructuredAggregationQuery::Aggregation::Avg
Returns

#avg=

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

#count

def count() -> ::Google::Cloud::Firestore::V1::StructuredAggregationQuery::Aggregation::Count
Returns

#count=

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

#sum

def sum() -> ::Google::Cloud::Firestore::V1::StructuredAggregationQuery::Aggregation::Sum
Returns

#sum=

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