FirebaseFirestore | Doclava
public class

FirebaseFirestore

extends Object
java.lang.Object
   ↳ com.google.firebase.firestore.FirebaseFirestore

Class Overview

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

Subclassing Note: Firestore classes are not meant to be subclassed except for use in test mocks. Subclassing is not supported in production code and new SDK releases may break code that does so.

Summary

Public Methods
WriteBatch batch()
Creates a write batch, used for performing multiple writes as a single atomic operation.
CollectionReference collection(String collectionPath)
Gets a CollectionReference instance that refers to the collection at the specified path within the database.
DocumentReference document(String documentPath)
Gets a `DocumentReference` instance that refers to the document at the specified path within the database.
FirebaseApp getApp()
Returns the FirebaseApp instance to which this FirebaseFirestore belongs.
FirebaseFirestoreSettings getFirestoreSettings()
Returns the settings used by this FirebaseFirestore object.
static FirebaseFirestore getInstance()
static FirebaseFirestore getInstance(FirebaseApp app)
<TResult> Task<TResult> runTransaction(Function<TResult> updateFunction)
Executes the given updateFunction and then attempts to commit the changes applied within the transaction.
void setFirestoreSettings(FirebaseFirestoreSettings settings)
Sets any custom settings used to configure this FirebaseFirestore object.
static void setLoggingEnabled(boolean loggingEnabled)
Globally enables / disables Firestore logging for the SDK.
[Expand]
Inherited Methods
From class java.lang.Object

Public Methods

public WriteBatch batch ()

Creates a write batch, used for performing multiple writes as a single atomic operation.

Returns
WriteBatch The created WriteBatch object.

public CollectionReference collection (String collectionPath)

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

Parameters
collectionPath String: A slash-separated path to a collection.
Returns
CollectionReference The CollectionReference instance.

public DocumentReference document (String documentPath)

Gets a `DocumentReference` instance that refers to the document at the specified path within the database.

Parameters
documentPath String: A slash-separated path to a document.
Returns
DocumentReference The DocumentReference instance.

public FirebaseApp getApp ()

Returns the FirebaseApp instance to which this FirebaseFirestore belongs.

Returns
FirebaseApp The FirebaseApp instance to which this FirebaseFirestore belongs.

public FirebaseFirestoreSettings getFirestoreSettings ()

Returns the settings used by this FirebaseFirestore object.

Returns
FirebaseFirestoreSettings

public static FirebaseFirestore getInstance ()

public static FirebaseFirestore getInstance (FirebaseApp app)

Parameters
app FirebaseApp
Returns
FirebaseFirestore

public Task<TResult> runTransaction (Function<TResult> 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 Function: The function to execute within the transaction context.
Returns
Task<TResult> The task returned from the updateFunction.

public void setFirestoreSettings (FirebaseFirestoreSettings settings)

Sets any custom settings used to configure this FirebaseFirestore object. This method can only be called before calling any other methods on this object.

Parameters
settings FirebaseFirestoreSettings

public static void setLoggingEnabled (boolean loggingEnabled)

Globally enables / disables Firestore logging for the SDK.

Parameters
loggingEnabled boolean