IndexField interface

此 API 作为开发人员预览版提供,可能会根据我们收到的反馈进行更改。不要在生产环境中使用此 API。

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

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

签名:

export declare interface IndexField 

特性

财产类型描述
数组配置“包含” (测试版)要创建什么类型的数组索引。对于array-containsarray-contains-any索引,设置为CONTAINS只能设置arrayConfigorder之一;
字段路径细绳(测试版)索引的字段路径。
命令'上升' | “下降” (测试版)要创建什么类型的数组索引。 for == , != , < 设置为ASCENDING或 'DESCENDING = , < = ,and不在` 过滤器。仅应设置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。

要创建什么类型的数组索引。设置for ASCENDING或“降序” == , != , < = , < = ,and不在` 过滤器。

仅应设置arrayConfigorder之一。

签名:

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