This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Instead of creating cache indexes manually, consider using
enablePersistentCacheIndexAutoCreation()
to let the SDK decide whether to create cache indexes for queries running locally.
The SDK definition of a Firestore index.
Signature:
export declare interface Index
Properties
Property | Type | Description |
---|---|---|
collectionGroup | string | (BETA) The ID of the collection to index. |
fields | IndexField[] | (BETA) A list of fields to index. |
Index.collectionGroup
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
The ID of the collection to index.
Signature:
readonly collectionGroup: string;
Index.fields
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
A list of fields to index.
Signature:
readonly fields?: IndexField[];