IndexField interface

此 API 是为开发者提供的预览版,可能会根据我们收到的反馈发生变化。请勿在生产环境中使用此 API。

。 <ph type="x-smartling-placeholder">
</ph>

不妨考虑使用 enablePersistentCacheIndexAutoCreation(),让 SDK 决定是否为本地运行的查询创建缓存索引,而不是手动创建缓存索引。

索引配置中的单个字段元素。

签名

export declare interface IndexField 

属性

属性 类型 说明
arrayConfig “CONTAINS” (Beta 版)要创建的数组索引的类型。对于 array-containsarray-contains-any 索引,应设置为 CONTAINS只能设置 arrayConfigorder 中的一个;
fieldPath 字符串 (Beta 版)要编入索引的字段路径。
订单 “ASCENDING”|“DESCENDING” (Beta 版)要创建的数组索引的类型。设置为 ASCENDING 或 'DESCENDING for ==, !=, <=, <=, in and not-in` 过滤条件。只能设置 arrayConfigorder 中的一个。

IndexField.arrayConfig

此 API 是为开发者提供的预览版,可能会根据我们收到的反馈发生变化。请勿在生产环境中使用此 API。

要创建的数组索引的类型。对于 array-containsarray-contains-any 索引,应设置为 CONTAINS

只需设置 arrayConfigorder 中的一个;

签名

readonly arrayConfig?: 'CONTAINS';

IndexField.fieldPath

此 API 是为开发者提供的预览版,可能会根据我们收到的反馈发生变化。请勿在生产环境中使用此 API。

要编入索引的字段路径。

签名

readonly fieldPath: string;

IndexField.order

此 API 是为开发者提供的预览版,可能会根据我们收到的反馈发生变化。请勿在生产环境中使用此 API。

要创建的数组索引的类型。设置为 ASCENDING 或“DESCENDINGfor==,!=,<=,<=,inandnot-in”过滤条件。

只应设置 arrayConfigorder 中的一个。

签名

readonly order?: 'ASCENDING' | 'DESCENDING';