You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
> Instead of creating cache indexes manually, consider using `enablePersistentCacheIndexAutoCreation()` to let SDK decide whether to create cache indexes for queries running locally.
18
+
> Instead of creating cache indexes manually, consider using `enablePersistentCacheIndexAutoCreation()` to let the SDK decide whether to create cache indexes for queries running locally.
> Instead of creating cache indexes manually, consider using `enablePersistentCacheIndexAutoCreation()` to let SDK decide whether to create cache indexes for queries running locally.
18
+
> Instead of creating cache indexes manually, consider using `enablePersistentCacheIndexAutoCreation()` to let the SDK decide whether to create cache indexes for queries running locally.
19
19
>
20
20
21
21
A list of Firestore indexes to speed up local query execution.
> Instead of creating cache indexes manually, consider using `enablePersistentCacheIndexAutoCreation()` to let SDK decide whether to create cache indexes for queries running locally.
18
+
> Instead of creating cache indexes manually, consider using `enablePersistentCacheIndexAutoCreation()` to let the SDK decide whether to create cache indexes for queries running locally.
|[deleteAllPersistentCacheIndexes(indexManager)](./firestore_.md#deleteallpersistentcacheindexes)| Removes all persistent cache indexes.<!---->Please note this function will also deletes indexes generated by <code>setIndexConfiguration()</code>, which is deprecated. |
65
65
|[disablePersistentCacheIndexAutoCreation(indexManager)](./firestore_.md#disablepersistentcacheindexautocreation)| Stops creating persistent cache indexes automatically for local query execution. The indexes which have been created by calling <code>enablePersistentCacheIndexAutoCreation()</code> still take effect. |
66
-
|[enablePersistentCacheIndexAutoCreation(indexManager)](./firestore_.md#enablepersistentcacheindexautocreation)| Enables SDK to create persistent cache indexes automatically for local query execution when SDK believes cache indexes can help improves performance.<!---->This feature is disabled by default. |
66
+
|[enablePersistentCacheIndexAutoCreation(indexManager)](./firestore_.md#enablepersistentcacheindexautocreation)| Enables the SDK to create persistent cache indexes automatically for local query execution when the SDK believes cache indexes can help improve performance.<!---->This feature is disabled by default. |
67
67
| <b>function(left...)</b> |
68
68
|[aggregateQuerySnapshotEqual(left, right)](./firestore_.md#aggregatequerysnapshotequal)| Compares two <code>AggregateQuerySnapshot</code> instances for equality.<!---->Two <code>AggregateQuerySnapshot</code> instances are considered "equal" if they have underlying queries that compare equal, and the same data. |
69
69
|[queryEqual(left, right)](./firestore_.md#queryequal)| Returns true if the provided queries point to the same collection and apply the same constraints. |
|[FirestoreError](./firestore_.firestoreerror.md#firestoreerror_class)| An error returned by a Firestore operation. |
136
136
|[GeoPoint](./firestore_.geopoint.md#geopoint_class)| An immutable object representing a geographic location in Firestore. The location is represented as latitude/longitude pair.<!---->Latitude values are in the range of \[-90, 90\]. Longitude values are in the range of \[-180, 180\]. |
137
137
|[LoadBundleTask](./firestore_.loadbundletask.md#loadbundletask_class)| Represents the task of loading a Firestore bundle. It provides progress of bundle loading, as well as task completion and error events.<!---->The API is compatible with <code>Promise<LoadBundleTaskProgress></code>. |
138
-
|[PersistentCacheIndexManager](./firestore_.persistentcacheindexmanager.md#persistentcacheindexmanager_class)| A <code>PersistentCacheIndexManager</code> which you can config persistent cache indexes used for local query execution.<!---->To use, call <code>getPersistentCacheIndexManager()</code> to get an instance. |
138
+
|[PersistentCacheIndexManager](./firestore_.persistentcacheindexmanager.md#persistentcacheindexmanager_class)| A <code>PersistentCacheIndexManager</code> for configuring persistent cache indexes used for local query execution.<!---->To use, call <code>getPersistentCacheIndexManager()</code> to get an instance. |
139
139
|[Query](./firestore_.query.md#query_class)| A <code>Query</code> refers to a query which you can read or listen to. You can also construct refined <code>Query</code> objects by adding filters and ordering. |
140
140
|[QueryCompositeFilterConstraint](./firestore_.querycompositefilterconstraint.md#querycompositefilterconstraint_class)| A <code>QueryCompositeFilterConstraint</code> is used to narrow the set of documents returned by a Firestore query by performing the logical OR or AND of multiple [QueryFieldFilterConstraint](./firestore_.queryfieldfilterconstraint.md#queryfieldfilterconstraint_class)<!---->s or [QueryCompositeFilterConstraint](./firestore_.querycompositefilterconstraint.md#querycompositefilterconstraint_class)<!---->s. <code>QueryCompositeFilterConstraint</code>s are created by invoking [or()](./firestore_.md#or) or [and()](./firestore_.md#and) and can then be passed to [query()](./firestore_.md#query) to create a new query instance that also contains the <code>QueryCompositeFilterConstraint</code>. |
141
141
|[QueryConstraint](./firestore_.queryconstraint.md#queryconstraint_class)| A <code>QueryConstraint</code> is used to narrow the set of documents returned by a Firestore query. <code>QueryConstraint</code>s are created by invoking [where()](./firestore_.md#where)<!---->, [orderBy()](./firestore_.md#orderby)<!---->, [startAt()](./firestore_.md#startat)<!---->, [startAfter()](./firestore_.md#startafter)<!---->, [endBefore()](./firestore_.md#endbefore)<!---->, [endAt()](./firestore_.md#endat)<!---->, [limit()](./firestore_.md#limit)<!---->, [limitToLast()](./firestore_.md#limittolast) and can then be passed to [query()](./firestore_.md#query) to create a new query instance that also contains this <code>QueryConstraint</code>. |
@@ -689,7 +689,7 @@ If the transaction completed successfully or was explicitly aborted (the `update
689
689
690
690
> Warning: This API is now obsolete.
691
691
>
692
-
> Instead of creating cache indexes manually, consider using `enablePersistentCacheIndexAutoCreation()` to let SDK decide whether to create cache indexes for queries running locally.
692
+
> Instead of creating cache indexes manually, consider using `enablePersistentCacheIndexAutoCreation()` to let the SDK decide whether to create cache indexes for queries running locally.
693
693
>
694
694
695
695
Configures indexing for local query execution. Any previous index configuration is overridden. The `Promise` resolves once the index configuration has been persisted.
@@ -728,7 +728,7 @@ FirestoreError if the JSON format is invalid.
728
728
729
729
> Warning: This API is now obsolete.
730
730
>
731
-
> Instead of creating cache indexes manually, consider using `enablePersistentCacheIndexAutoCreation()` to let SDK decide whether to create cache indexes for queries running locally.
731
+
> Instead of creating cache indexes manually, consider using `enablePersistentCacheIndexAutoCreation()` to let the SDK decide whether to create cache indexes for queries running locally.
732
732
>
733
733
734
734
Configures indexing for local query execution. Any previous index configuration is overridden. The `Promise` resolves once the index configuration has been persisted.
@@ -1172,7 +1172,7 @@ void
1172
1172
1173
1173
## enablePersistentCacheIndexAutoCreation()
1174
1174
1175
-
Enables SDK to create persistent cache indexes automatically for local query execution when SDK believes cache indexes can help improves performance.
1175
+
Enables the SDK to create persistent cache indexes automatically for local query execution when the SDK believes cache indexes can help improve performance.
0 commit comments