Stay organized with collections
Save and categorize content based on your preferences.
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.
(Public Preview) 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;
(Public Preview) 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:
readonlyarrayConfig?:'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:
readonlyfieldPath: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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-02-27 UTC."],[],[],null,["# IndexField interface\n\n\u003e 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.\n\u003e | **Warning:** This API is now obsolete.\n\u003e\n\u003e Instead of creating cache indexes manually, consider using `enablePersistentCacheIndexAutoCreation()` to let the SDK decide whether to create cache indexes for queries running locally.\n\nA single field element in an index configuration.\n\n**Signature:** \n\n export declare interface IndexField \n\nProperties\n----------\n\n| Property | Type | Description |\n|-----------------------------------------------------------------|-----------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [arrayConfig](./firestore_.indexfield.md#indexfieldarrayconfig) | 'CONTAINS' | ***(Public Preview)*** 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; |\n| [fieldPath](./firestore_.indexfield.md#indexfieldfieldpath) | string | ***(Public Preview)*** The field path to index. |\n| [order](./firestore_.indexfield.md#indexfieldorder) | 'ASCENDING' \\| 'DESCENDING' | ***(Public Preview)*** What type of array index to create. Set to `ASCENDING` or 'DESCENDING` for `==`, `!=`, `\\\u003c=`, `\\\u003c=`, `in` and `not-in\\` filters.Only one of `arrayConfig` or `order` should be set. |\n\nIndexField.arrayConfig\n----------------------\n\n\u003e 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.\n\nWhat type of array index to create. Set to `CONTAINS` for `array-contains` and `array-contains-any` indexes.\n\nOnly one of `arrayConfig` or `order` should be set;\n\n**Signature:** \n\n readonly arrayConfig?: 'CONTAINS';\n\nIndexField.fieldPath\n--------------------\n\n\u003e 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.\n\nThe field path to index.\n\n**Signature:** \n\n readonly fieldPath: string;\n\nIndexField.order\n----------------\n\n\u003e 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.\n\nWhat type of array index to create. Set to `ASCENDING` or 'DESCENDING`for`==`,`!=`,`\\\u003c=`,`\\\u003c=`,`in`and`not-in\\` filters.\n\nOnly one of `arrayConfig` or `order` should be set.\n\n**Signature:** \n\n readonly order?: 'ASCENDING' | 'DESCENDING';"]]
