Cloud Firestore V1 Client - Class Count (1.32.0)

Reference documentation and code samples for the Cloud Firestore V1 Client class 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.

Generated from protobuf message google.firestore.v1.StructuredAggregationQuery.Aggregation.Count

Constructor.

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 the unboxed value from getUpTo()

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.

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.

Sets the field by wrapping a primitive type in a Google\Protobuf\Int64Value object.

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.