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.
A single field element in an index configuration.
Signature:
export declare interface IndexField
Properties
| Property | Type | Description |
|---|---|---|
| arrayConfig | 'CONTAINS' | (BETA) What type of array index to create. Set to CONTAINS for array-contains and array-contains-any indexes.Only one of arrayConfig or order should be set; |
| fieldPath | string | (BETA) The field path to index. |
| order | 'ASCENDING' | 'DESCENDING' | (BETA) What type of array index to create. Set to ASCENDING or 'DESCENDING for ==, !=, <=, <=, in and not-in` filters.Only one of arrayConfig or order should be set. |
IndexField.arrayConfig
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.
What type of array index to create. Set to CONTAINS for array-contains and array-contains-any indexes.
Only one of arrayConfig or order should be set;
Signature:
readonly arrayConfig?: 'CONTAINS';
IndexField.fieldPath
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 field path to index.
Signature:
readonly fieldPath: string;
IndexField.order
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.
What type of array index to create. Set to ASCENDING or 'DESCENDINGfor==,!=,<=,<=,inandnot-in` filters.
Only one of arrayConfig or order should be set.
Signature:
readonly order?: 'ASCENDING' | 'DESCENDING';