Table Store Java SDK 查詢多元索引配置與狀態 - Tablestore

Java SDK 可查詢多元索引的索引結構、資料同步進度、計量情況及運行狀態。

前提條件

開始前，完成以下準備工作：

安裝Tablestore Java SDK並初始化用戶端。
已建立待查詢的資料表和多元索引。

功能說明

調用 describeSearchIndex 方法查詢指定資料表中一個多元索引的配置和運行狀態。

public DescribeSearchIndexResponse describeSearchIndex(DescribeSearchIndexRequest request)

以下樣本查詢 example_table 中 example_index 的資訊，並輸出索引狀態、同步階段、生命週期和欄位名稱。

String tableName = "example_table";
String indexName = "example_index";
DescribeSearchIndexRequest request = new DescribeSearchIndexRequest();
request.setTableName(tableName);
request.setIndexName(indexName);
request.setIncludeSyncStat(true);

DescribeSearchIndexResponse response = client.describeSearchIndex(request);
System.out.println(response.getIndexStatus().indexStatusEnum);
System.out.println(response.getSyncStat().getSyncPhase());
System.out.println(response.getTimeToLive());
for (FieldSchema fieldSchema : response.getSchema().getFieldSchemas()) {
    System.out.println(fieldSchema.getFieldName());
}

參數說明

DescribeSearchIndexRequest 包含以下參數：

名稱	類型	說明
tableName（必選）	`String`	資料表名稱。
indexName（必選）	`String`	多元索引名稱。
includeSyncStat（可選）	`Boolean`	是否返回資料同步進度，預設值為 `true`。設定為 `false` 時，傳回值中的 `syncStat` 為 `null`。

傳回值

DescribeSearchIndexResponse 包含以下欄位：

欄位	類型	說明
`schema`	`IndexSchema`	通過 `getSchema()` 擷取索引欄位、索引設定和預排序配置。對象結構請參見建立多元索引。
`syncStat`	`SyncStat`	通過 `getSyncStat()` 擷取資料同步進度。`includeSyncStat` 為 `false` 時，該欄位為 `null`。
`meteringInfo`	`MeteringInfo`	通過 `getMeteringInfo()` 擷取最近一次計量的資訊。
`brotherIndexName`	`String`	通過 `getBrotherIndexName()` 擷取關聯索引名稱。沒有關聯索引時，該欄位為 `null`。
`queryFlowWeight`	`List<QueryFlowWeight>`	通過 `getQueryFlowWeight()` 擷取查詢流量權重列表。未配置時，該欄位為 `null`。
`createTime`	`Long`	通過 `getCreateTime()` 擷取多元索引建立時間。
`indexStatus`	`IndexStatus`	通過 `getIndexStatus()` 擷取多元索引的運行狀態和狀態說明。
`timeToLive`	`Integer`	通過 `getTimeToLive()` 擷取索引資料的生命週期，單位為秒。`-1` 表示資料永不到期。

資料同步進度

syncStat 的類型為 SyncStat，包含以下欄位：

欄位	類型	說明
`syncPhase`	`SyncPhase`	通過 `getSyncPhase()` 擷取同步階段。`FULL` 表示全量同步，`INCR` 表示增量同步處理。
`currentSyncTimestamp`	`Long`	通過 `getCurrentSyncTimestamp()` 擷取當前同步時間戳記。

計量資訊

meteringInfo 的類型為 MeteringInfo，包含以下欄位：

欄位	類型	說明
`reservedThroughput`	`ReservedThroughput`	通過 `getReservedThroughput().getCapacityUnit().getReadCapacityUnit()` 擷取預留讀輸送量。
`storageSize`	`long`	通過 `getStorageSize()` 擷取最近一次計量時的索引儲存量。
`rowCount`	`long`	通過 `getRowCount()` 擷取最近一次計量時的索引總行數。
`timestamp`	`long`	通過 `getTimestamp()` 擷取最近一次計量的時間戳記。

查詢流量權重

queryFlowWeight[] 中每個元素的類型為 QueryFlowWeight，包含以下欄位：

欄位	類型	說明
`indexName`	`String`	通過 `getIndexName()` 擷取多元索引名稱。
`weight`	`Integer`	通過 `getWeight()` 擷取查詢流量權重，取值範圍為 0～100。

索引狀態

indexStatus 的類型為 IndexStatus，包含以下欄位：

欄位	類型	說明
`indexStatusEnum`	`IndexStatusEnum`	索引狀態。取值包括 `PENDING`、`FAILED`、`RUNNING` 和 `UNKNOWN`。
`statusDescription`	`String`	索引狀態說明。