The Firestore for the Firestore database (useful for performing
transactions, etc.).
The collection's identifier.
A reference to the containing DocumentReference if this is a subcollection.
If this isn't a subcollection, the reference is null.
A string representing the path of the referenced collection (relative to the root of the database).
Add a new document to this collection with the specified data, assigning it a document ID automatically.
An Object containing the data for the new document.
A Promise resolved with a DocumentReference pointing to the
newly created document after it has been written to the backend.
Get a DocumentReference for the document within the collection at the
specified path. If no path is specified, an automatically-generated
unique ID will be used for the returned DocumentReference.
A slash-separated path to a document.
The DocumentReference instance.
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.
The snapshot of the document to end at.
The created Query.
Creates and returns a new Query that ends at the provided fields relative to the order of the query. The order of the field values must match the order of the order by clauses of the query.
The field values to end this query at, in order of the query's order by.
The created Query.
Creates and returns a new Query that ends before the provided document (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.
The snapshot of the document to end before.
The created Query.
Creates and returns a new Query that ends before the provided fields relative to the order of the query. The order of the field values must match the order of the order by clauses of the query.
The field values to end this query before, in order of the query's order by.
The created Query.
Executes the query and returns the results as a QuerySnapshot.
Note: By default, get() attempts to provide up-to-date data when possible
by waiting for data from the server, but it may return cached data or fail
if you are offline and the server cannot be reached. This behavior can be
altered via the GetOptions parameter.
An object to configure the get behavior.
A Promise that will be resolved with the results of the Query.
Returns true if this CollectionReference is equal to the provided one.
The CollectionReference to compare against.
true if this CollectionReference is equal to the provided one.
Creates and returns a new Query that only returns the first matching documents.
The maximum number of items to return.
The created Query.
Creates and returns a new Query that only returns the last matching documents.
You must specify at least one orderBy clause for limitToLast queries,
otherwise an exception will be thrown during execution.
The maximum number of items to return.
The created Query.
Attaches a listener for QuerySnapshot events. You may either pass
individual onNext and onError callbacks or pass a single observer
object with next and error callbacks. The listener can be cancelled by
calling the function that is returned when onSnapshot is called.
NOTE: Although an onCompletion callback can be provided, it will
never be called because the snapshot stream is never-ending.
A single object containing next and error callbacks.
An unsubscribe function that can be called to cancel the snapshot listener.
Attaches a listener for QuerySnapshot events. You may either pass
individual onNext and onError callbacks or pass a single observer
object with next and error callbacks. The listener can be cancelled by
calling the function that is returned when onSnapshot is called.
NOTE: Although an onCompletion callback can be provided, it will
never be called because the snapshot stream is never-ending.
Options controlling the listen behavior.
A single object containing next and error callbacks.
An unsubscribe function that can be called to cancel the snapshot listener.
Attaches a listener for QuerySnapshot events. You may either pass
individual onNext and onError callbacks or pass a single observer
object with next and error callbacks. The listener can be cancelled by
calling the function that is returned when onSnapshot is called.
NOTE: Although an onCompletion callback can be provided, it will
never be called because the snapshot stream is never-ending.
A callback to be called every time a new QuerySnapshot
is available.
A callback to be called if the listen fails or is cancelled. No further callbacks will occur.
An unsubscribe function that can be called to cancel the snapshot listener.
Attaches a listener for QuerySnapshot events. You may either pass
individual onNext and onError callbacks or pass a single observer
object with next and error callbacks. The listener can be cancelled by
calling the function that is returned when onSnapshot is called.
NOTE: Although an onCompletion callback can be provided, it will
never be called because the snapshot stream is never-ending.
Options controlling the listen behavior.
A callback to be called every time a new QuerySnapshot
is available.
A callback to be called if the listen fails or is cancelled. No further callbacks will occur.
An unsubscribe function that can be called to cancel the snapshot listener.
Creates and returns a new Query that's additionally sorted by the specified field, optionally in descending order instead of ascending.
The field to sort by.
Optional direction to sort by (asc or desc). If
not specified, order will be ascending.
The created 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 document must contain all of the fields provided in the orderBy of this query.
The snapshot of the document to start after.
The created Query.
Creates and returns a new Query that starts after the provided fields relative to the order of the query. The order of the field values must match the order of the order by clauses of the query.
The field values to start this query after, in order of the query's order by.
The created 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.
The snapshot of the document to start at.
The created Query.
Creates and returns a new Query that starts at the provided fields relative to the order of the query. The order of the field values must match the order of the order by clauses of the query.
The field values to start this query at, in order of the query's order by.
The created Query.
Creates and returns a new Query with the additional filter that documents must contain the specified field and the value should satisfy the relation constraint provided.
The path to compare
The operation string (e.g "<", "<=", "==", ">", ">=").
The value for comparison
The created Query.
Applies a custom data converter to this CollectionReference, allowing you to use your own custom model objects with Firestore. When you call add() on the returned CollectionReference instance, the provided converter will convert between Firestore data and your custom type U.
Passing in null as the converter parameter removes the current
converter.
Converts objects to and from Firestore. Passing in
null removes the current converter.
Applies a custom data converter to this CollectionReference, allowing you to use your own custom model objects with Firestore. When you call add() on the returned CollectionReference instance, the provided converter will convert between Firestore data and your custom type U.
Passing in null as the converter parameter removes the current
converter.
Converts objects to and from Firestore. Passing in
null removes the current converter.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2022-07-27 UTC.
A
CollectionReferenceobject can be used for adding documents, getting document references, and querying for documents (using the methods inherited fromQuery).