Firestore in Datastore mode V1 API - Class Google::Cloud::Datastore::V1::AggregationQuery::Aggregation::Count (v1.0.0)

Reference documentation and code samples for the Firestore in Datastore mode V1 API class Google::Cloud::Datastore::V1::AggregationQuery::Aggregation::Count.

Count of entities that match the query.

The COUNT(*) aggregation function operates on the entire entity 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 entities to count.

    This provides a way to set an upper bound on the number of entities to scan, limiting latency, and cost.

    Unspecified is interpreted as no bound.

    If a zero value is provided, a count result of zero should always be expected.

    High-Level Example:

    AGGREGATE COUNT_UP_TO(1000) OVER ( SELECT * FROM k );

    Requires:

    • Must be non-negative when present.

#up_to=

def up_to=(value) -> ::Google::Protobuf::Int64Value
Parameter
  • value (::Google::Protobuf::Int64Value) —

    Optional. Optional constraint on the maximum number of entities to count.

    This provides a way to set an upper bound on the number of entities to scan, limiting latency, and cost.

    Unspecified is interpreted as no bound.

    If a zero value is provided, a count result of zero should always be expected.

    High-Level Example:

    AGGREGATE COUNT_UP_TO(1000) OVER ( SELECT * FROM k );

    Requires:

    • Must be non-negative when present.
Returns
  • (::Google::Protobuf::Int64Value) —

    Optional. Optional constraint on the maximum number of entities to count.

    This provides a way to set an upper bound on the number of entities to scan, limiting latency, and cost.

    Unspecified is interpreted as no bound.

    If a zero value is provided, a count result of zero should always be expected.

    High-Level Example:

    AGGREGATE COUNT_UP_TO(1000) OVER ( SELECT * FROM k );

    Requires:

    • Must be non-negative when present.