com.google.cloud.firestore

Interface Firestore

All Superinterfaces:

AutoCloseable, com.google.cloud.Service<FirestoreOptions>

public interface Firestore
extends com.google.cloud.Service<FirestoreOptions>, AutoCloseable

Represents a Firestore Database and is the entry point for all Firestore operations

Method Summary

Modifier and Type	Method and Description
WriteBatch	batch() Gets a Firestore WriteBatch instance that can be used to combine multiple writes.
void	close() Closes the gRPC channels associated with this instance and frees up their resources.
CollectionReference	collection(String path) Gets a CollectionReference that refers to the collection at the specified path.
Query	collectionGroup(String collectionId) Creates and returns a new @link{Query} that includes all documents in the database that are contained in a collection or subcollection with the given @code{collectionId}.
DocumentReference	document(String path) Gets a DocumentReference that refers to the document at the specified path.
com.google.api.core.ApiFuture<List<DocumentSnapshot>>	getAll(DocumentReference... documentReferences) Retrieves multiple documents from Firestore.
com.google.api.core.ApiFuture<List<DocumentSnapshot>>	getAll(DocumentReference[] documentReferences, FieldMask fieldMask) Retrieves multiple documents from Firestore, while optionally applying a field mask to reduce the amount of data transmitted.
void	getAll(DocumentReference[] documentReferences, FieldMask fieldMask, com.google.api.gax.rpc.ApiStreamObserver<DocumentSnapshot> responseObserver) Retrieves multiple documents from Firestore while optionally applying a field mask to reduce the amount of data transmitted.
Iterable<CollectionReference>	getCollections() Deprecated. Use listCollections().
Iterable<CollectionReference>	listCollections() Fetches the root collections that are associated with this Firestore database.
<T> com.google.api.core.ApiFuture<T>	runTransaction(Transaction.Function<T> updateFunction) Executes the given updateFunction and then attempts to commit the changes applied within the transaction.
<T> com.google.api.core.ApiFuture<T>	runTransaction(Transaction.Function<T> updateFunction, TransactionOptions transactionOptions) Executes the given updateFunction and then attempts to commit the changes applied within the transaction.

Methods inherited from interface com.google.cloud.Service

getOptions

Method Detail

collection

@Nonnull
CollectionReference collection(@Nonnull
                                        String path)

Gets a CollectionReference that refers to the collection at the specified path.

Parameters:

path - A slash-separated path to a collection.

Returns:

The CollectionReference instance.

document

@Nonnull
DocumentReference document(@Nonnull
                                    String path)

Gets a DocumentReference that refers to the document at the specified path.

Parameters:

path - A slash-separated path to a document.

Returns:

The DocumentReference instance.

listCollections

@Nonnull
Iterable<CollectionReference> listCollections()

Fetches the root collections that are associated with this Firestore database.

Returns:

An Iterable that can be used to fetch all collections.

Throws:

FirestoreException - if the Iterable could not be initialized.

getCollections

@Deprecated
 @Nonnull
Iterable<CollectionReference> getCollections()

Deprecated. Use listCollections().

Fetches the root collections that are associated with this Firestore database.

Returns:

An Iterable that can be used to fetch all collections.

Throws:

FirestoreException - if the Iterable could not be initialized.

collectionGroup

Query collectionGroup(@Nonnull
                      String collectionId)

Creates and returns a new @link{Query} that includes all documents in the database that are contained in a collection or subcollection with the given @code{collectionId}.

Parameters:

collectionId - Identifies the collections to query over. Every collection or subcollection with this ID as the last segment of its path will be included. Cannot contain a slash.

Returns:

The created Query.

runTransaction

@Nonnull
<T> com.google.api.core.ApiFuture<T> runTransaction(@Nonnull
                                                             Transaction.Function<T> updateFunction)

Executes the given updateFunction and then attempts to commit the changes applied within the transaction. If any document read within the transaction has changed, the updateFunction will be retried. If it fails to commit after 5 attempts, the transaction will fail.

Parameters:

updateFunction - The function to execute within the transaction context.

Returns:

An ApiFuture that will be resolved with the result from updateFunction.

runTransaction

@Nonnull
<T> com.google.api.core.ApiFuture<T> runTransaction(@Nonnull
                                                             Transaction.Function<T> updateFunction,
                                                             @Nonnull
                                                             TransactionOptions transactionOptions)

Executes the given updateFunction and then attempts to commit the changes applied within the transaction. If any document read within the transaction has changed, the updateFunction will be retried. If it fails to commit after the maxmimum number of attemps specified in transactionOptions, the transaction will fail.

Parameters:

updateFunction - The function to execute within the transaction context.

Returns:

An ApiFuture that will be resolved with the result from updateFunction.

getAll

@Nonnull
com.google.api.core.ApiFuture<List<DocumentSnapshot>> getAll(@Nonnull
                                                                      DocumentReference... documentReferences)

Retrieves multiple documents from Firestore.

Parameters:

documentReferences - List of Document References to fetch.

getAll

@Nonnull
com.google.api.core.ApiFuture<List<DocumentSnapshot>> getAll(@Nonnull
                                                                      DocumentReference[] documentReferences,
                                                                      @Nullable
                                                                      FieldMask fieldMask)

Retrieves multiple documents from Firestore, while optionally applying a field mask to reduce the amount of data transmitted.

Parameters:

documentReferences - Array with Document References to fetch.

fieldMask - If set, specifies the subset of fields to return.

getAll

void getAll(@Nonnull
            DocumentReference[] documentReferences,
            @Nullable
            FieldMask fieldMask,
            com.google.api.gax.rpc.ApiStreamObserver<DocumentSnapshot> responseObserver)

Retrieves multiple documents from Firestore while optionally applying a field mask to reduce the amount of data transmitted. Returned documents will be out of order.

Parameters:

documentReferences - Array with Document References to fetch.

fieldMask - If not null, specifies the subset of fields to return.

responseObserver - The observer to be notified when DocumentSnapshot details arrive.

batch

@Nonnull
WriteBatch batch()

Gets a Firestore WriteBatch instance that can be used to combine multiple writes.

Returns:

A WriteBatch that operates on this Firestore client.

close

void close()
    throws Exception

Closes the gRPC channels associated with this instance and frees up their resources. This method blocks until all channels are closed. Once this method is called, this Firestore client is no longer usable.

Specified by:

close in interface AutoCloseable

Throws:

Exception