DataLocalQuery<T> class
final
An immutable, lazily executed query over a DataLocal collection.
Filtering and sorting are currently evaluated in memory, so query cost grows with the collection size.
Constructors
-
DataLocalQuery.root(DataLocalCollection<
T> collection) -
Creates an unfiltered query rooted at
collection.factory
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
average(
String path) → Future< double?> -
Returns the mean for numeric values at
path, ornullwhen empty. -
count(
) → Future< int> - Returns the number of matching documents before the result limit.
-
endAt(
DataLocalQueryCursor cursor) → DataLocalQuery< T> -
Returns documents positioned at or before
cursor. -
endBefore(
DataLocalQueryCursor cursor) → DataLocalQuery< T> -
Returns only documents positioned before
cursor. -
get(
) → Future< DataLocalQuerySnapshot< T> > - Executes this query and returns a snapshot of matching documents.
-
limit(
int value) → DataLocalQuery< T> -
Restricts the result to at most
valuedocuments. -
limitToLast(
int value) → DataLocalQuery< T> -
Restricts the result to the final
valuedocuments. -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
orderBy(
String path, {bool descending = false, DataLocalNullOrder nullOrder = DataLocalNullOrder.automatic}) → DataLocalQuery< T> -
Returns a query ordered by the dot-separated field
path. -
orderByField(
DataLocalFieldPath path, {bool descending = false, DataLocalNullOrder nullOrder = DataLocalNullOrder.automatic}) → DataLocalQuery< T> -
Returns a query ordered by the parsed field
path. -
startAfter(
DataLocalQueryCursor cursor) → DataLocalQuery< T> -
Returns only documents positioned after
cursor. -
startAt(
DataLocalQueryCursor cursor) → DataLocalQuery< T> -
Returns documents positioned at or after
cursor. -
sum(
String path) → Future< num> -
Sums numeric values at
pathin the selected result. -
toString(
) → String -
A string representation of this object.
inherited
-
watch(
) → Stream< DataLocalQuerySnapshot< T> > - Emits the current query snapshot and then one snapshot per relevant commit.
-
where(
String path, {Object? isEqualTo = _unsetQueryValue, Object? isNotEqualTo = _unsetQueryValue, Object? isGreaterThan = _unsetQueryValue, Object? isGreaterThanOrEqualTo = _unsetQueryValue, Object? isLessThan = _unsetQueryValue, Object? isLessThanOrEqualTo = _unsetQueryValue, Object? whereIn = _unsetQueryValue, Object? whereNotIn = _unsetQueryValue, Object? arrayContains = _unsetQueryValue, Object? arrayContainsAny = _unsetQueryValue, Object? isNull = _unsetQueryValue, Object? isNotNull = _unsetQueryValue}) → DataLocalQuery< T> -
Returns a query with one additional predicate for
path. -
whereAny(
Iterable< DataLocalFilter> filters) → DataLocalQuery<T> - Adds an OR group; at least one supplied filter must match.
-
whereField(
DataLocalFieldPath path, {required DataLocalFilterOperator operator, required Object? value}) → DataLocalQuery< T> -
Returns a query with
operatorapplied to the parsed fieldpath.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited