| GitHub Repository |
Classes
| Class | Description |
|---|---|
| com. |
Represents an aggregation that can be performed by Firestore. |
| com. |
Represents an "average" aggregation that can be performed by Firestore. |
| com. |
Represents a "count" aggregation that can be performed by Firestore. |
| com. |
Represents a "sum" aggregation that can be performed by Firestore. |
| com. |
A query that calculates aggregations over an underlying query. |
| com. |
The results of executing an AggregateQuery. |
| com. |
BasePath represents a path sequence in the Firestore database. It is composed of an ordered sequence of string segments. |
| com. |
Immutable class representing an array of bytes in Firestore. |
| com. |
A Firestore BulkWriter that can be used to perform a large number of writes in parallel. |
| com. |
Options used to configure request throttling in BulkWriter. |
| com. |
|
| com. |
A Collection Group query matches all documents that are contained in a collection or subcollection with a specific collection ID. |
| com. |
A CollectionReference can be used for adding documents, getting document references, and querying
for documents (using the methods inherited from Query).
Subclassing Note: Firestore classes are not meant to be subclassed except for use in |
| com. |
A DocumentChange represents a change to the documents matching a query. It contains the document affected and a the type of change that occurred (added, modifed, or removed). |
| com. |
A DocumentReference refers to a document location in a Firestore database and can be used to write, read, or listen to the location. There may or may not exist a document at the referenced location. A DocumentReference can also be used to create a CollectionReference to a subcollection. |
| com. |
A DocumentSnapshot contains data read from a document in a Firestore database. The data can be
extracted with the #getData() or #get(String) methods.
If the DocumentSnapshot points to a non-existing document, getData() and its corresponding |
| com. |
A ExecutionStats contains information about the execution of a query. |
| com. |
ExplainMetrics contains information about planning and execution of a query. |
| com. |
Options used to configure explain queries. |
| com. |
|
| com. |
ExplainResults contains information about planning, execution, and results of a query. |
| com. |
A wrapper object to access explain stats if explain or analyze was enabled for the Pipeline query execution. |
| com. |
A FieldMask can be used to limit the number of fields returned by a getAll() call. |
| com. |
A FieldPath refers to a field in a document. The path may consist of a single field name
(referring to a top level field in the document), or a list of field names (referring to a nested
field in the document). |
| com. |
Sentinel values that can be used when writing document fields with set() or update(). |
| com. |
|
| com. |
Represents a Firestore data bundle with results from the given document and query snapshots. |
| com. |
Builds a Firestore data bundle with results from the given document and query snapshots. |
| com. |
Represents the options that are used to configure the use of OpenTelemetry for telemetry collection in the Firestore SDK. |
| com. |
|
| com. |
A Factory class to create new Firestore instances. |
| com. |
|
| com. |
|
| com. |
|
| com. |
|
| com. |
Abstract. A GenericQuerySnapshot represents the results of a query that returns documents. It can contain zero or more DocumentSnapshot objects. |
| com. |
Immutable class representing a geographic location in Firestore |
| com. |
|
| com. |
The Pipeline class provides a flexible and expressive framework for building complex data
transformation and query pipelines for Firestore.
A pipeline takes data sources, such as Firestore collections or collection groups, and applies |
| com. |
A Snapshot contains the results of a pipeline execution. It can be used to access the documents, execution time, and explain stats. |
| com. |
A PipelineResult contains data read from a Firestore Pipeline. The data can be extracted with the
#getData() or #get(String) methods.
If the PipelineResult represents a non-document result, getReference() will return a null |
| com. |
A factory for creating Pipeline instances, which provide a framework for building data
transformation and query pipelines for Firestore.
Start by calling Firestore#pipeline() to obtain an instance of |
| com. |
|
| com. |
A Plan contains information about the planning stage of a query. |
| com. |
Preconditions that can be used to restrict update() calls. |
| com. |
A Query which you can read or listen to. You can also construct refined Query objects by adding filters and ordering. |
| com. |
A QueryDocumentSnapshot contains data read from a document in a Firestore database as part of a
query. The document is guaranteed to exist and its data can be extracted using the #getData() or #get(String) methods.
QueryDocumentSnapshot offers the same API surface as DocumentSnapshot. Since query |
| com. |
A split point that can be used in a query as a starting and/or end point for the query results. The cursors returned by #getStartAt() and #getEndBefore() can only be used in a query that matches the constraint of query that produced this partition. |
| com. |
A QuerySnapshot contains the results of a query. It can contain zero or more DocumentSnapshot objects. |
| com. |
Class used to store state required for running a recursive delete operation. Each recursive delete call should use a new instance of the class. |
| com. |
An options object that configures the behavior of set() calls. By providing one of the SetOptions objects returned by #merge, #mergeFields and #mergeFieldPaths, the set() calls in DocumentReference, WriteBatch and Transaction can be configured to perform granular merges instead of overwriting the target documents in their entirety. |
| com. |
Represents a query whose results can be streamed. If the stream fails with a retryable error,
implementations of StreamableQuery can optionally support retries with a cursor, as indicated by
isRetryableWithCursor. Retrying with a cursor means that the StreamableQuery can be resumed
where it failed by first calling startAfter(lastDocumentReceived). |
| com. |
A Transaction is passed to a Function to provide the methods to read and write data within the transaction context. See Also: Firestore#runTransaction(Function) |
| com. |
Options specifying the behavior of Firestore Transactions.
A transaction in Firestore can be either read-write or read-only. |
| com. |
|
| com. |
A typesafe builder class representing those options that are applicable when configuring a transaction to be read-only. All methods function as "set" rather than returning a new copy with a value set on it. |
| com. |
A typesafe builder class representing those options that are applicable when configuring a transaction to be read-write. All methods function as "set" rather than returning a new copy with a value set on it. By default, a read-write transaction will be attempted a max of 5 times. |
| com. |
Abstract class that collects and bundles all write operations for Transaction and WriteBatch. |
| com. |
A query that finds the documents whose vector fields are closest to a certain query vector.
Create an instance of VectorQuery with Query#findNearest. |
| com. |
Specifies the behavior of the VectorQuery generated by a call to Query#findNearest. |
| com. |
|
| com. |
A VectorQuerySnapshot contains the results of a VectorQuery. It can contain zero or more DocumentSnapshot objects. |
| com. |
Represents a vector in Firestore documents. Create an instance with FieldValue#vector. |
| com. |
A Firestore WriteBatch that can be used to atomically commit multiple write operations at once. See Also: Firestore#batch() |
| com. |
A WriteResult exposes the update time set by the server. |
Interfaces
| Interface | Description |
|---|---|
| com. |
A callback set by addWriteErrorListener() to be run every time an operation fails and
determines if an operation should be retried. |
| com. |
A callback set by addWriteResultListener() to be run every time an operation successfully
completes. |
| com. |
An interface for event listeners. |
| com. |
Represents a Firestore Database and is the entry point for all Firestore operations |
| com. |
An interface for Firestore factories. |
| com. |
An interface for Firestore RPC factory. Implementation will be loaded via java.util.ServiceLoader. |
| com. |
Represents a listener that can be removed by calling remove(). |
| com. |
User callback that takes a Firestore Async Transaction. |
| com. |
User callback that takes a Firestore Transaction. |
Enums
| Enum | Description |
|---|---|
| com. |
An enumeration of snapshot diff types. |
| com. |
The direction of a sort. |
| com. |
|
| com. |
The distance measure to use when comparing vectors in a VectorQuery. See Also: com.google.cloud.firestore.Query#findNearest |
Exceptions
| Exception | Description |
|---|---|
| com. |
The error thrown when a BulkWriter operation fails. |
| com. |
A Firestore Service exception. |