创建多元索引后,使用ListSearchIndex接口可以获取当前实例下或某个数据表关联的所有多元索引的列表信息。

前提条件

  • 已初始化OTSClient,详情请参见初始化
  • 已创建数据表并写入数据。
  • 已在数据表上创建多元索引,详情请参见创建多元索引

参数

参数 说明
tableName 数据表名称,可以为空。
  • 如果设置了数据表名称,则返回该数据表关联的所有多元索引的列表。
  • 如果未设置数据表名称,则返回当前实例下所有多元索引的列表。

示例

client.listSearchIndex({
    tableName: TABLE_NAME //设置数据表名称。
}, function (err, data) {
    if (err) {
        console.log('error:', err);
        return;
    }
    console.log('success:', JSON.stringify(data, null, 2));
});