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

Inherits:

Object

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

show all

Extended by:: Protobuf::MessageExts::ClassMethods

Includes:: Protobuf::MessageExts

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

Overview

Defines a aggregation that produces a single result.

Defined Under Namespace

Classes: Count

Instance Attribute Summary collapse

#alias ⇒ ::String
Optional.
#count ⇒ ::Google::Cloud::Firestore::V1::StructuredAggregationQuery::Aggregation::Count
Count aggregator.

Instance Attribute Details

#alias ⇒ `::String`

Returns 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_UP_TO(4)
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_UP_TO(4) AS field_2
OVER (
  ...
);

Requires:

Must be unique across all aggregation aliases.
Conform to document field name limitations.

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_UP_TO(4)
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_UP_TO(4) AS field_2
OVER (
  ...
);
```
Requires:
- Must be unique across all aggregation aliases.
- Conform to document field name limitations.

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

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
end

#count ⇒ `::Google::Cloud::Firestore::V1::StructuredAggregationQuery::Aggregation::Count`

Returns Count aggregator.