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

Reference documentation and code samples for the Cloud Firestore V1 API class Google::Cloud::Firestore::V1::StructuredAggregationQuery::Aggregation::Count.

Count of documents that match the query.

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

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#up_to

def up_to() -> ::Google::Protobuf::Int64Value
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.

#up_to=

def up_to=(value) -> ::Google::Protobuf::Int64Value
Parameter
  • value (::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.
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.