Query<T> class

Implementers

• CollectionGroup
• CollectionReference

Annotations

• @immutable

Properties

firestore → Firestore

final

hashCode → int

The hash code for this object.

no setter, override

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

endAt(List<Object?> fieldValues) → Query<T>

Creates and returns a new Query that ends at the provided set of field values relative to the order of the query. The order of the provided values must match the order of the order by clauses of the query.

endAtDocument(DocumentSnapshot<Object?> snapshot) → Query<T>

Creates and returns a new Query that ends at the provided set of field values relative to the order of the query. The order of the provided values must match the order of the order by clauses of the query.

endBefore(List<Object?> fieldValues) → Query<T>

Creates and returns a new Query that ends before the set of field values relative to the order of the query. The order of the provided values must match the order of the order by clauses of the query.

endBeforeDocument(DocumentSnapshot<Object?> snapshot) → Query<T>

Creates and returns a new Query that ends before the set of field values relative to the order of the query. The order of the provided values must match the order of the order by clauses of the query.

get() → Future<QuerySnapshot<T>>

Executes the query and returns the results as a QuerySnapshot.

limit(int limit) → Query<T>

Creates and returns a new Query that only returns the first matching 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

offset(int offset) → Query<T>

Specifies the offset of the returned results.

orderBy(Object path, {bool descending = false}) → Query<T>

Creates and returns a new Query that's additionally sorted by the specified field, optionally in descending order instead of ascending.

orderByFieldPath(FieldPath fieldPath, {bool descending = false}) → Query<T>

Creates and returns a new Query that's additionally sorted by the specified field, optionally in descending order instead of ascending.

select([List<FieldPath> fieldPaths = const []]) → Query<DocumentData>

Creates and returns a new Query instance that applies a field mask to the result and returns only the specified subset of fields. You can specify a list of field paths to return, or use an empty list to only return the references of matching documents.

startAfter(List<Object?> fieldValues) → Query<T>

Creates and returns a new Query that starts after the provided set of field values relative to the order of the query. The order of the provided values must match the order of the order by clauses of the query.

startAfterDocument(DocumentSnapshot<Object?> snapshot) → Query<T>

Creates and returns a new Query that starts after the provided set of field values relative to the order of the query. The order of the provided values must match the order of the order by clauses of the query.

startAt(List<Object?> fieldValues) → Query<T>

Creates and returns a new Query that starts at the provided set of field values relative to the order of the query. The order of the provided values must match the order of the order by clauses of the query.

startAtDocument(DocumentSnapshot<Object?> documentSnapshot) → Query<T>

Creates and returns a new Query that starts at the provided set of field values relative to the order of the query. The order of the provided values must match the order of the order by clauses of the query.

toString() → String

A string representation of this object.

inherited

where(Object path, WhereFilter op, Object? value) → Query<T>

Creates and returns a new Query with the additional filter that documents must contain the specified field and that its value should satisfy the relation constraint provided.

whereFieldPath(FieldPath fieldPath, WhereFilter op, Object? value) → Query<T>

Creates and returns a new Query with the additional filter that documents must contain the specified field and that its value should satisfy the relation constraint provided.

whereFilter(Filter filter) → Query<T>

Creates and returns a new Query with the additional filter that documents should satisfy the relation constraint(s) provided.

withConverter<U>({required FromFirestore<U> fromFirestore, required ToFirestore<U> toFirestore}) → Query<U>

Applies a custom data converter to this Query, allowing you to use your own custom model objects with Firestore. When you call get on the returned Query, the provided converter will convert between Firestore data and your custom type U.

Operators

operator ==(Object other) → bool

The equality operator.

override