検索インデックス情報のクエリ - Tablestore SDK for Java - Tablestore

Tablestore SDK for Java は、検索インデックスのスキーマ、データ同期の進捗、メータリング情報、およびステータスを取得します。

前提条件

開始する前に、以下を確認してください。

Tablestore SDK for Java をインストール済みで、クライアントが初期化されていること。
テーブルと検索インデックスが存在すること。

説明

describeSearchIndex を呼び出して、テーブル内の検索インデックスの構成とインデックスステータスを取得します。

public DescribeSearchIndexResponse describeSearchIndex(DescribeSearchIndexRequest request)

次の例では、example_table の example_index をクエリし、インデックスステータス、同期フェーズ、Time to Live (TTL)、およびフィールド名を出力します。

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()` を呼び出して、インデックスデータの TTL (秒) を取得します。値が `-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`	インデックスステータスの説明。