Skip to content

Commit dd56689

Browse files
authored
Fix documentation according to cl/563780077 feedback. (#5323)
1 parent 5bc731c commit dd56689

File tree

2 files changed

+15
-8
lines changed

2 files changed

+15
-8
lines changed

firebase-firestore/src/main/java/com/google/firebase/firestore/FirebaseFirestore.java

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -410,7 +410,11 @@ public Task<Void> setIndexConfiguration(@NonNull String json) {
410410
}
411411

412412
/**
413-
* Returns the PersistentCache Index Manager used by this {@code FirebaseFirestore} object.
413+
* Gets the {@code PersistentCacheIndexManager} instance used by this {@code FirebaseFirestore}
414+
* object.
415+
*
416+
* <p>This is not the same as Cloud Firestore Indexes. Persistent cache indexes are optional
417+
* indexes that only exist within the SDK to assist in local query execution.
414418
*
415419
* @return The {@code PersistentCacheIndexManager} instance or null if local persistent storage is
416420
* not in use.

firebase-firestore/src/main/java/com/google/firebase/firestore/PersistentCacheIndexManager.java

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,13 @@
1919
import com.google.firebase.firestore.core.FirestoreClient;
2020

2121
/**
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.
2424
*
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()}.
2629
*/
2730
public final class PersistentCacheIndexManager {
2831
@NonNull private FirestoreClient client;
@@ -34,8 +37,8 @@ public final class PersistentCacheIndexManager {
3437
}
3538

3639
/**
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.
3942
*
4043
* <p>This feature is disabled by default.
4144
*/
@@ -52,8 +55,8 @@ public void disableIndexAutoCreation() {
5255
}
5356

5457
/**
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.
5760
*/
5861
public void deleteAllIndexes() {
5962
client.deleteAllFieldIndexes();

0 commit comments

Comments
 (0)