Query<T extends Object?> class abstract

Represents a Query over the data at a particular location.

Can construct refined Query objects by adding filters and ordering.

Available extensions
Annotations

Constructors

Query()

Properties

firestore → FirebaseFirestore
The FirebaseFirestore instance of this query.
no setter
hashCode → int
The hash code for this object.
no setterinherited
parameters → Map<String, dynamic>
Exposes the parameters on the query delegate.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

endAt(List<Object?> values) → Query<T>
Takes a list of values, creates and returns a new Query that ends at the provided fields relative to the order of the query.
endAtDocument(DocumentSnapshot<Object?> documentSnapshot) → Query<T>
Creates and returns a new Query that ends at the provided document (inclusive). The end position is relative to the order of the query. The document must contain all of the fields provided in the orderBy of this query.
endBefore(List<Object?> values) → Query<T>
Takes a list of values, creates and returns a new Query that ends before the provided fields relative to the order of the query.
endBeforeDocument(DocumentSnapshot<Object?> documentSnapshot) → Query<T>
Creates and returns a new Query that ends before the provided document snapshot (exclusive). The end position is relative to the order of the query. The document must contain all of the fields provided in the orderBy of this query.
get([GetOptions? options]) → Future<QuerySnapshot<T>>
Fetch the documents for this query.
limit(int limit) → Query<T>
Creates and returns a new Query that's additionally limited to only return up to the specified number of documents.
limitToLast(int limit) → Query<T>
Creates and returns a new Query that only returns the last matching documents.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
orderBy(Object field, {bool descending = false}) → Query<T>
Creates and returns a new Query that's additionally sorted by the specified field. The field may be a String representing a single field name or a FieldPath.
snapshots({bool includeMetadataChanges = false}) → Stream<QuerySnapshot<T>>
Notifies of query results at this location.
startAfter(List<Object?> values) → Query<T>
Takes a list of values, creates and returns a new Query that starts after the provided fields relative to the order of the query.
startAfterDocument(DocumentSnapshot<Object?> documentSnapshot) → Query<T>
Creates and returns a new Query that starts after the provided document (exclusive). The starting position is relative to the order of the query. The documentSnapshot must contain all of the fields provided in the orderBy of this query.
startAt(List<Object?> values) → Query<T>
Takes a list of values, creates and returns a new Query that starts at the provided fields relative to the order of the query.
startAtDocument(DocumentSnapshot<Object?> documentSnapshot) → Query<T>
Creates and returns a new Query that starts at the provided document (inclusive). The starting position is relative to the order of the query. The document must contain all of the fields provided in the orderBy of this query.
toString() → String
A string representation of this object.
inherited
where(Object field, {Object? isEqualTo, Object? isNotEqualTo, Object? isLessThan, Object? isLessThanOrEqualTo, Object? isGreaterThan, Object? isGreaterThanOrEqualTo, Object? arrayContains, List<Object?>? arrayContainsAny, List<Object?>? whereIn, List<Object?>? whereNotIn, bool? isNull}) → Query<T>
Creates and returns a new Query with additional filter on specified field. field refers to a field in a document.
withConverter<R>({required FromFirestore<R> fromFirestore, required ToFirestore<R> toFirestore}) → Query<R>
Transforms a Query to manipulate a custom object instead of a Map<String, dynamic>.

Operators

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