Jump to top
Edit Page

PersistentCacheIndexManager

interface

Returns the PersistentCache Index Manager used by the given Firestore object. The PersistentCacheIndexManager instance, or null if local persistent storage is not in use.

Methods

deleteAllIndexes

</>

Removes all persistent cache indexes. Note this function also deletes indexes generated by setIndexConfiguration(), which is deprecated.

deleteAllIndexes(): Promise<void>;

disableIndexAutoCreation

</>

Stops creating persistent cache indexes automatically for local query execution. The indexes which have been created by calling enableIndexAutoCreation() still take effect.

disableIndexAutoCreation(): Promise<void>;

enableIndexAutoCreation

</>

Enables the SDK to create persistent cache indexes automatically for local query execution when the SDK believes cache indexes can help improves performance. This feature is disabled by default.

enableIndexAutoCreation(): Promise<void>;