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

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/firestore/v1/query.rb

Overview

Count of documents that match the query.

The COUNT(*) aggregation function operates on the entire document so it does not require a field reference.

Instance Attribute Summary collapse

Instance Attribute Details

#up_to ⇒ ::Google::Protobuf::Int64Value

Returns 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.

Returns:

  • (::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.


543
544
545
546
 
# File 'proto_docs/google/firestore/v1/query.rb', line 543

class Count
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end