Skip to content

Commit 4c7d5aa

Browse files
committed
Add documentation
1 parent d2d50c7 commit 4c7d5aa

File tree

2 files changed

+12
-0
lines changed

2 files changed

+12
-0
lines changed

firebase-firestore/src/androidTest/java/com/google/firebase/firestore/IndexingTest.java

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,7 @@ public void testAutoIndexCreationSetSuccessfully() {
118118
.build();
119119
db.setFirestoreSettings(settings);
120120

121+
// Based on current heuristic, collection document counts (3) > 2 * resultSize (1).
121122
CollectionReference collection =
122123
testCollectionWithDocs(
123124
map(
@@ -136,13 +137,17 @@ public void testAutoIndexCreationSetSuccessfully() {
136137

137138
results = waitFor(collection.whereEqualTo("match", true).get());
138139
assertEquals(1, results.size());
140+
141+
assertDoesNotThrow(() -> db.getPersistentCacheIndexManager().deleteAllIndexes());
142+
assertEquals(1, results.size());
139143
}
140144

141145
@Test
142146
public void testAutoIndexCreationSetSuccessfullyUsingDefault() {
143147
// Use persistent disk cache (default)
144148
FirebaseFirestore db = testFirestore();
145149

150+
// Based on current heuristic, collection document counts (3) > 2 * resultSize (1).
146151
CollectionReference collection =
147152
testCollectionWithDocs(
148153
map(
@@ -161,6 +166,9 @@ public void testAutoIndexCreationSetSuccessfullyUsingDefault() {
161166

162167
results = waitFor(collection.whereEqualTo("match", true).get());
163168
assertEquals(1, results.size());
169+
170+
assertDoesNotThrow(() -> db.getPersistentCacheIndexManager().deleteAllIndexes());
171+
assertEquals(1, results.size());
164172
}
165173

166174
@Test

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,10 @@ public void disableIndexAutoCreation() {
5252
client.setIndexAutoCreationEnabled(false);
5353
}
5454

55+
/**
56+
* Removes all persistent cache indexes. Please note this function will also deletes indexes
57+
* generated by {@link FirebaseFirestore#setIndexConfiguration(String)}.
58+
*/
5559
public void deleteAllIndexes() {
5660
client.deleteAllFieldIndexes();
5761
}

0 commit comments

Comments
 (0)