Class: Google::Cloud::Firestore::V1::StructuredAggregationQuery

Inherits:

Object

Object
Google::Cloud::Firestore::V1::StructuredAggregationQuery

show all

Extended by:: Protobuf::MessageExts::ClassMethods

Includes:: Protobuf::MessageExts

Defined in:: proto_docs/google/firestore/v1/query.rb

Overview

Firestore query for running an aggregation over a StructuredQuery.

Defined Under Namespace

Classes: Aggregation

Instance Attribute Summary collapse

#aggregations ⇒ ::Array<::Google::Cloud::Firestore::V1::StructuredAggregationQuery::Aggregation>
Optional.
#structured_query ⇒ ::Google::Cloud::Firestore::V1::StructuredQuery
Nested structured query.

Instance Attribute Details

#aggregations ⇒ `::Array<::Google::Cloud::Firestore::V1::StructuredAggregationQuery::Aggregation>`

Returns Optional. Series of aggregations to apply over the results of the structured_query.

Requires:

A minimum of one and maximum of five aggregations per query.

Returns:

(::Array<::Google::Cloud::Firestore::V1::StructuredAggregationQuery::Aggregation>) —
Optional. Series of aggregations to apply over the results of the structured_query.

Requires:
- A minimum of one and maximum of five aggregations per query.

# File 'proto_docs/google/firestore/v1/query.rb', line 391

class StructuredAggregationQuery
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Defines an aggregation that produces a single result.
  # @!attribute [rw] count
  #   @return [::Google::Cloud::Firestore::V1::StructuredAggregationQuery::Aggregation::Count]
  #     Count aggregator.
  # @!attribute [rw] sum
  #   @return [::Google::Cloud::Firestore::V1::StructuredAggregationQuery::Aggregation::Sum]
  #     Sum aggregator.
  # @!attribute [rw] avg
  #   @return [::Google::Cloud::Firestore::V1::StructuredAggregationQuery::Aggregation::Avg]
  #     Average aggregator.
  # @!attribute [rw] alias
  #   @return [::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:
  #
  #     * Must be unique across all aggregation aliases.
  #     * Conform to {::Google::Cloud::Firestore::V1::Document#fields document field name}
  #     limitations.
  class Aggregation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Count of documents that match the query.
    #
    # The `COUNT(*)` aggregation function operates on the entire document
    # so it does not require a field reference.
    # @!attribute [rw] up_to
    #   @return [::Google::Protobuf::Int64Value]
    #     Optional. Optional constraint on the maximum number of documents to
    #     count.
    #
    #     This provides a way to set an upper bound on the number of documents
    #     to scan, limiting latency, and cost.
    #
    #     Unspecified is interpreted as no bound.
    #
    #     High-Level Example:
    #
    #     ```
    #     AGGREGATE COUNT_UP_TO(1000) OVER ( SELECT * FROM k );
    #     ```
    #
    #     Requires:
    #
    #     * Must be greater than zero when present.
    class Count
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # 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.
    # @!attribute [rw] field
    #   @return [::Google::Cloud::Firestore::V1::StructuredQuery::FieldReference]
    #     The field to aggregate on.
    class Sum
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # 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.
    # @!attribute [rw] field
    #   @return [::Google::Cloud::Firestore::V1::StructuredQuery::FieldReference]
    #     The field to aggregate on.
    class Avg
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end
end

#structured_query ⇒ `::Google::Cloud::Firestore::V1::StructuredQuery`

Returns Nested structured query.