查询多元索引描述信息

前提条件

• 已初始化Client。具体操作，请参见初始化Client。

• 已创建数据表并写入数据。具体操作，请参见创建数据表和写入数据。

• 已在数据表上创建多元索引。具体操作，请参见创建多元索引。

参数

示例

以下示例用于获取多元索引的详细信息，例如数据生命周期、创建时间、同步状态、字段信息等。

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

相关文档

如果已有多元索引不满足使用需求，您可以创建新的多元索引、通过修改多元索引的Schema来增删改多元索引字段或者根据需要调整多元索引的TTL。具体操作，请参见创建多元索引、动态修改schema和生命周期管理。