public sealed class StructuredAggregationQuery.Types.Aggregation.Types.Count : IMessage<StructuredAggregationQuery.Types.Aggregation.Types.Count>, IEquatable<StructuredAggregationQuery.Types.Aggregation.Types.Count>, IDeepCloneable<StructuredAggregationQuery.Types.Aggregation.Types.Count>, IBufferMessage, IMessage
Reference documentation and code samples for the Firestore v1 API class StructuredAggregationQuery.Types.Aggregation.Types.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.
Implements
IMessageStructuredAggregationQueryTypesAggregationTypesCount, IEquatableStructuredAggregationQueryTypesAggregationTypesCount, IDeepCloneableStructuredAggregationQueryTypesAggregationTypesCount, IBufferMessage, IMessageNamespace
GoogleCloudGoogle.Cloud.FirestoreV1Assembly
Google.Cloud.Firestore.V1.dll
Constructors
Count()
public Count()
Count(Count)
public Count(StructuredAggregationQuery.Types.Aggregation.Types.Count other)
Parameter | |
---|---|
Name | Description |
other | StructuredAggregationQueryTypesAggregationTypesCount |
Properties
UpTo
public long? UpTo { get; set; }
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.
Property Value | |
---|---|
Type | Description |
long |