CollectionReference class
A CollectionReference object can be used for adding documents, getting DocumentReferences, and querying for documents (using the methods inherited from Query).
Properties
- firestore → FirebaseFirestore
-
The FirebaseFirestore instance of this query.
finalinherited
- hashCode → int
-
The hash code for this object.
no setteroverride
- id → String
-
Returns the ID of the referenced collection.
no setter
-
parameters
→ Map<
String, dynamic> -
Exposes the parameters on the query delegate.
no setterinherited
- parent → DocumentReference?
-
Returns the parent DocumentReference of this collection or
null.no setter - path → String
-
A string containing the slash-separated path to this CollectionReference
(relative to the root of the database).
no setter
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
add(
Map< String, dynamic> data) → Future<DocumentReference> -
Returns a
DocumentReferencewith an auto-generated ID, after populating it with provideddata. -
doc(
[String? path]) → DocumentReference -
Returns a
DocumentReferencewith the provided path. -
endAt(
List values) → Query -
Takes a list of
values, creates and returns a new Query that ends at the provided fields relative to the order of the query.inherited -
endAtDocument(
DocumentSnapshot documentSnapshot) → Query -
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.
inherited
-
endBefore(
List values) → Query -
Takes a list of
values, creates and returns a new Query that ends before the provided fields relative to the order of the query.inherited -
endBeforeDocument(
DocumentSnapshot documentSnapshot) → Query -
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.
inherited
-
get(
[GetOptions? options]) → Future< QuerySnapshot> -
Fetch the documents for this query.
inherited
-
limit(
int limit) → Query -
Creates and returns a new Query that's additionally limited to only return up
to the specified number of documents.
inherited
-
limitToLast(
int limit) → Query -
Creates and returns a new Query that only returns the last matching documents.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
orderBy(
dynamic field, {bool descending = false}) → Query -
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.inherited -
snapshots(
{bool includeMetadataChanges = false}) → Stream< QuerySnapshot> -
Notifies of query results at this location.
inherited
-
startAfter(
List values) → Query -
Takes a list of
values, creates and returns a new Query that starts after the provided fields relative to the order of the query.inherited -
startAfterDocument(
DocumentSnapshot documentSnapshot) → Query -
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
documentSnapshotmust contain all of the fields provided in the orderBy of this query.inherited -
startAt(
List values) → Query -
Takes a list of
values, creates and returns a new Query that starts at the provided fields relative to the order of the query.inherited -
startAtDocument(
DocumentSnapshot documentSnapshot) → Query -
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.
inherited
-
toString(
) → String -
A string representation of this object.
override
-
where(
dynamic field, {dynamic isEqualTo, dynamic isNotEqualTo, dynamic isLessThan, dynamic isLessThanOrEqualTo, dynamic isGreaterThan, dynamic isGreaterThanOrEqualTo, dynamic arrayContains, List? arrayContainsAny, List? whereIn, List? whereNotIn, bool? isNull}) → Query -
Creates and returns a new Query with additional filter on specified
field.fieldrefers to a field in a document.inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
override