Firestore API - Class AggregateQuery (3.12.0) 

public sealed class AggregateQuery : IEquatable<AggregateQuery>

Reference documentation and code samples for the Firestore API class AggregateQuery.

A query for running server-side aggregations. Instances of this can be created using Count() and Aggregate(AggregateField, params AggregateField[]).

Inheritance

object > AggregateQuery

Namespace

Google.Cloud.Firestore

Assembly

Google.Cloud.Firestore.dll

Methods

ExplainAsync(ExplainOptions, CancellationToken)

public Task<ExplainResults<AggregateQuerySnapshot>> ExplainAsync(ExplainOptions options, CancellationToken cancellationToken = default)

Returns an explanation for this query, optionally executing it.

Parameters
Name Description
options ExplainOptions

The ExplainOptions to use. Must not be null.
cancellationToken CancellationToken

A cancellation token for the operation.
Returns
Type Description
TaskExplainResultsAggregateQuerySnapshot

A Google.Cloud.Firestore.V1.PlanSummary for this query.

GetHashCode()

public override int GetHashCode()
Returns
Type Description
int
Overrides

GetSnapshotAsync(CancellationToken)

public Task<AggregateQuerySnapshot> GetSnapshotAsync(CancellationToken cancellationToken = default)

Asynchronously takes a snapshot of the result after applying the aggregate functions on the query.

Parameter
Name Description
cancellationToken CancellationToken

A cancellation token for the operation.
Returns
Type Description
TaskAggregateQuerySnapshot

A AggregateQuerySnapshot which contains results of the Aggregate functions.