19
19
import com .google .firebase .firestore .core .FirestoreClient ;
20
20
21
21
/**
22
- * A {@code PersistentCacheIndexManager} which you can config persistent cache indexes used for
23
- * local query execution .
22
+ * Persistent cache indexes can improve performance of local query execution. The {@code
23
+ * PersistentCacheIndexManager} controls index creation and lifecycle .
24
24
*
25
- * <p>To use, call {@link FirebaseFirestore#getPersistentCacheIndexManager()} to get an instance.
25
+ * <p>This is not the same as Cloud Firestore Indexes. Persistent cache indexes are optional indexes
26
+ * that only exist within the SDK to assist in local query execution.
27
+ *
28
+ * <p>To get an instance, call {@link FirebaseFirestore#getPersistentCacheIndexManager()}.
26
29
*/
27
30
public final class PersistentCacheIndexManager {
28
31
@ NonNull private FirestoreClient client ;
@@ -34,8 +37,8 @@ public final class PersistentCacheIndexManager {
34
37
}
35
38
36
39
/**
37
- * Enables SDK to create persistent cache indexes automatically for local query execution when SDK
38
- * believes cache indexes can help improves performance.
40
+ * Enables the SDK to create persistent cache indexes automatically for local query execution when
41
+ * the SDK believes cache indexes can help improves performance.
39
42
*
40
43
* <p>This feature is disabled by default.
41
44
*/
@@ -52,8 +55,8 @@ public void disableIndexAutoCreation() {
52
55
}
53
56
54
57
/**
55
- * Removes all persistent cache indexes. Please note this function also deletes indexes generated
56
- * by {@link FirebaseFirestore#setIndexConfiguration(String)}, which is deprecated.
58
+ * Removes all persistent cache indexes. Note this function also deletes indexes generated by
59
+ * {@link FirebaseFirestore#setIndexConfiguration(String)}, which is deprecated.
57
60
*/
58
61
public void deleteAllIndexes () {
59
62
client .deleteAllFieldIndexes ();
0 commit comments