FirestoreQueryBuilder<T> class

A builder class for constructing Firestore queries with advanced functionalities.

Annotations
  • @riverpod

Constructors

FirestoreQueryBuilder()

Properties

filterSet FilterSet?
latefinalinherited
firebaseFirestoreInstance ↔ FirebaseFirestore?
latefinalinherited
fromJson ↔ T Function(Map<String, dynamic> json)
latefinalinherited
hashCode int
The hash code for this object.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

aggregateAverage(String field) Future<double>
Executes an aggregation query to calculate the average value of a specified field.
aggregateSum(String field) Future<num>
Executes an aggregation query to sum the values of a specified field.
build({FirebaseFirestore? firebaseFirestoreInstance, required T fromJson(Map<String, dynamic> json), FilterSet? filterSet}) → Query<T>
count() Future<int>
Executes an aggregation query to count the number of documents matching the query.
endBeforeDocument(DocumentSnapshot<Object?> documentSnapshot) → Query<T>
Sets the ending point for the query using a document snapshot.
get() Future<List<T>>
Executes the query and returns the results as a list of model objects.
limit(int limit) → Query<T>
Limits the number of documents retrieved.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
orderBy({required String field, bool descending = false}) → Query<T>
Adds sorting to the query.
startAfterDocument(DocumentSnapshot<Object?> documentSnapshot) → Query<T>
Sets the starting point for the query using a document snapshot.
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, Iterable<Object?>? arrayContainsAny, Iterable<Object?>? whereIn, Iterable<Object?>? whereNotIn, bool? isNull}) → Query<T>
Adds a filter to the query.
whereWithFilterSet(FilterSet? filterSet) → Query<T>
Build a query with filters and ordering

Operators

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