QueryBuilder class

Implemented types

Properties

hashCode int
The hash code for this object.
no setterinherited
query Query
no getterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
sortOrders Iterable<FieldSort>
no setterinherited

Methods

buildForTesting() Query
inherited
changes() → Observable<Changes>
clone() → SnapshotEmitterInternal<DocumentReference>
dereference() SnapshotEmitter<DocumentData>
Dereferences the document references in the result of this query. For example, collection.query().snapshot() returns an array of DocumentReference objects, but collection.query().dereference().snapshot() returns an array of the actual document data.
eq(FieldName fieldName, dynamic value) QueryBuilder
A shortcut for where with Operator.equals.
inherited
extractData(DocumentReference data) → dynamic
flipSortOrder() QueryBuilder
getLimit() int
inherited
gt(FieldName fieldName, dynamic value) QueryBuilder
A shortcut for where with Operator.greaterThan.
inherited
gte(FieldName fieldName, dynamic value) QueryBuilder
A shortcut for where with Operator.greaterThanOrEqual.
inherited
isIn(FieldName fieldName, Iterable values) QueryBuilder
A shortcut for where with Operator.inList.
inherited
isNotIn(FieldName fieldName, Iterable values) QueryBuilder
A shortcut for where with Operator.notInList.
inherited
like(FieldName fieldName, String value, {bool caseSensitive = true}) QueryBuilder
A shortcut for where with Operator.like (case insensitive) or Operator.likeCs (case sensitive).
inherited
limit(int limit) QueryBuilder
inherited
limitBy(int limit, {Iterable<FieldName> fields = const []}) QueryBuilder
inherited
lt(FieldName fieldName, dynamic value) QueryBuilder
A shortcut for where with Operator.lessThan.
inherited
lte(FieldName fieldName, dynamic value) QueryBuilder
A shortcut for where with Operator.lessThanOrEqual.
inherited
neq(FieldName fieldName, dynamic value) QueryBuilder
A shortcut for where with Operator.notEquals.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
notLike(FieldName fieldName, String value, {bool caseSensitive = true}) QueryBuilder
A shortcut for where with Operator.notLike (case insensitive) or Operator.notLikeCs (case sensitive).
inherited
paginate({int pageSize = 100, bool subscribe = true}) Pagination<DocumentReference>
Returns a pagination wrapper for this query with pageSize defaulting to 100 and subscribe defaulting to true.
inherited
peek() Iterable<DocumentReference>
setForceFetchFromServer() QueryBuilder
Forces the query to return data from the server even if there is a query that already returned the requested result.
snapshot() Future<Iterable<DocumentReference>>
Returns a promise that resolves to the query results.
inherited
snapshots({bool subscribe = true}) → Observable<Iterable<DocumentReference>>
Returns an observable that emits the query results and updates whenever the query results change unless subscribe=false is provided.
override
sortBy(FieldName fieldName, [SortOrder order = SortOrder.asc]) QueryBuilder
inherited
toJson() Map<String, dynamic>
override
toString() String
A string representation of this object.
inherited
where(FieldName fieldName, Operator operator, dynamic value) QueryBuilder
inherited

Operators

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