创建多元索引后,使用DescribeSearchIndex接口可以查询多元索引的描述信息,包括多元索引的字段信息和索引配置等。
前提条件
已初始化OTSClient。具体操作,请参见初始化OTSClient。
已在数据表上创建多元索引。具体操作,请参见创建多元索引。
参数
参数 | 说明 |
tableName | 数据表名称。 |
indexName | 多元索引名称。 |
示例
以下示例用于获取多元索引的详细信息,例如数据生命周期、创建时间、同步状态、字段信息等。
private static DescribeSearchIndexResponse describeSearchIndex(SyncClient client) {
DescribeSearchIndexRequest request = new DescribeSearchIndexRequest();
//设置数据表名称。
request.setTableName("<TABLE_NAME>");
//设置多元索引名称。
request.setIndexName("<INDEX_NAME>");
DescribeSearchIndexResponse response = client.describeSearchIndex(request);
//打印response的详细信息。
System.out.println(response.jsonize());
//打印多元索引数据同步状态。
System.out.println(response.getSyncStat().getSyncPhase().name());
return response;
}
相关文档
如果已有多元索引不满足使用需求,您可以创建新的多元索引、通过修改多元索引的Schema来增删改多元索引字段或者根据需要调整多元索引的TTL。具体操作,请参见创建多元索引、动态修改schema和生命周期管理。