ModelAggregateQuery<TValue extends AsyncAggregateValue> class

A query to output an aggregate of the documents in a collection.

コレクションのドキュメントの集計を出力するためのクエリ。

Annotations

Properties

defaultValue Object?
Initial value if value could not be obtained.
final
hashCode int
The hash code for this object.
no setteroverride
key String?
Field key to be queried.
final
onCreate → TValue Function(ModelAggregateQuery<AsyncAggregateValue> query, CollectionBase<DocumentBase> collection, VoidCallback onFinished)
Create an AsyncAggregateValue from the query.
final
onUpdate Future<void> Function(ModelUpdateNotification update, AsyncAggregateValue value)
Defines the behavior of the collection when it receives an update notification.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
type ModelAggregateQueryType
Query type.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() String
A string representation of this object.
override

Operators

operator ==(Object other) bool
The equality operator.
override

Static Methods

average(String key) ModelAggregateQuery<AsyncAggregateValue<double>>
Query to output the average value of the field key of the documents in the collection.
count() ModelAggregateQuery<AsyncAggregateValue<int>>
A query to output the total number of documents in the collection.
sum(String key) ModelAggregateQuery<AsyncAggregateValue<double>>
Query to output the total value of the fields in key of the documents in the collection.