Returns an instance ofFirestore corresponding to the givenApp with default database ID.

FirebaseFirestore usesfirebase::App to communicate with Firebase Authentication to authenticate users to theFirestore server backend.

If you callGetInstance() multiple times with the sameApp, you will get the same instance ofFirestore.

Returns an instance ofFirestore corresponding to the defaultApp with default database ID.

FirebaseFirestore uses the defaultApp to communicate with Firebase Authentication to authenticate users to theFirestore server backend.

If you callGetInstance() multiple times, you will get the same instance.

Returns an instance ofFirestore corresponding to the givenApp with the given database ID.

FirebaseFirestore usesfirebase::App to communicate with Firebase Authentication to authenticate users to theFirestore server backend.

If you callGetInstance() multiple times with the sameApp, you will get the same instance ofFirestore.

Returns an instance ofFirestore corresponding to the defaultApp with the given database ID.

FirebaseFirestore usesfirebase::App to communicate with Firebase Authentication to authenticate users to theFirestore server backend.

If you callGetInstance() multiple times with the sameApp, you will get the same instance ofFirestore.

Sets the log verbosity of allFirestore instances.

The default verbosity level iskLogLevelInfo.

Attaches a listener for a snapshots-in-sync event.

Server-generated updates and local changes can affect multiple snapshot listeners. The snapshots-in-sync event indicates that all listeners affected by a given change have fired.

NOTE: The snapshots-in-sync event only indicates that listeners are in sync with each other, but does not relate to whether those snapshots are in sync with the server. UseSnapshotMetadata in the individual listeners to determine if a snapshot is from the cache or the server.

Clears the persistent storage.

This includes pending writes and cached documents.

Must be called while theFirestore instance is not started (after the app is shut down or when the app is first initialized). On startup, this method must be called before other methods (other thansettings() andset_settings()). If theFirestore instance is still running, the function will complete with an error code ofFailedPrecondition.

Note:ClearPersistence() is primarily intended to help write reliable tests that useFirestore. It uses the most efficient mechanism possible for dropping existing data but does not attempt to securely overwrite or otherwise make cached data unrecoverable. For applications that are sensitive to the disclosure of cache data in between user sessions we strongly recommend not to enable persistence in the first place.

Returns aCollectionReference instance that refers to the collection at the specified path within the database.

Returns aCollectionReference instance that refers to the collection at the specified path within the database.

Returns aQuery instance that includes all documents in the database that are contained in a collection or subcollection with the given collection_id.

Returns aQuery instance that includes all documents in the database that are contained in a collection or subcollection with the given collection_id.

Disables network access for this instance.

While the network is disabled, any snapshot listeners or Get() calls will return results from cache, and any write operations will be queued until network usage is re-enabled via a call toEnableNetwork().

If the network was already disabled, callingDisableNetwork() again is a no-op.

Returns aDocumentReference instance that refers to the document at the specified path within the database.

Returns aDocumentReference instance that refers to the document at the specified path within the database.

Re-enables network usage for this instance after a prior call toDisableNetwork().

If the network is currently enabled, callingEnableNetwork() is a no-op.

Deleted copy constructor;Firestore must be created withFirestore::GetInstance().

Loads aFirestore bundle into the local cache.

Loads aFirestore bundle into the local cache, with the provided callback executed for progress updates.

Reads aFirestoreQuery from the local cache, identified by the given name.

Named queries are packaged into bundles on the server side (along with the resulting documents) and loaded into local cache usingLoadBundle. Once in the local cache, you can use this method to extract a query by name.

If a query cannot be found, the returned future will complete with itserror() set to a non-zero error code.

Executes the given update and then attempts to commit the changes applied within the transaction.

If any document read within the transaction has changed, the update function will be retried. If it fails to commit after 5 attempts, the transaction will fail.

Executes the given update and then attempts to commit the changes applied within the transaction.

If any document read within the transaction has changed, the update function will be retried. If it fails to commit after themax_attempts specified in the givenTransactionOptions, the transaction will fail.

Terminates thisFirestore instance.

After callingTerminate(), only theClearPersistence() method may be used. Calling any other methods will result in an error.

To restart after termination, simply create a new instance ofFirestore withFirestore::GetInstance().

Terminate() does not cancel any pending writes and any tasks that are awaiting a response from the server will not be resolved. The next time you start this instance, it will resume attempting to send these writes to the server.

Note: under normal circumstances, callingTerminate() is not required. This method is useful only when you want to force this instance to release all of its resources or in combination withClearPersistence() to ensure that all local state is destroyed between test runs.

Waits until all currently pending writes for the active user have been acknowledged by the backend.

The returned future is resolved immediately without error if there are no outstanding writes. Otherwise, the future is resolved when all previously issued writes (including those written in a previous app session) have been acknowledged by the backend. The future does not wait for writes that were added after the method is called. If you wish to wait for additional writes, you have to callWaitForPendingWrites again.

Any outstandingWaitForPendingWrites futures are resolved with an error during user change.

Returns thefirebase::App that thisFirestore was created with.

Returns thefirebase::App that thisFirestore was created with.

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

Unlike transactions, write batches are persisted offline and therefore are preferable when you don't need to condition your writes on read data.

Deleted copy assignment operator;Firestore must be created withFirestore::GetInstance().

Sets any custom settings used to configure thisFirestore object.

Returns the settings used by thisFirestore object.

Destructor for theFirestore object.

When deleted, this instance will be removed from the cache ofFirestore objects. If you callGetInstance() in the future with the sameApp, a newFirestore instance will be created.

Default constructor, to be used only for mockingFirestore.