すべてのプロダクト
Search
ドキュメントセンター

Tablestore:検索インデックスの説明をクエリする

最終更新日:Dec 28, 2024

検索インデックスを作成した後、フィールド情報や事前ソート設定など、検索インデックスの説明をクエリできます。

API操作

DescribeSearchIndex 操作を呼び出して、検索インデックスの説明をクエリできます。

パラメーター

パラメーター

説明

tableName

データテーブルの名前。

indexName

検索インデックスの名前。

メソッド

Tablestoreコンソール、Tablestore CLI、またはTablestore SDKを使用して、検索インデックスの説明をクエリできます。

検索インデックスの説明をクエリする前に、以下の準備が完了していることを確認してください。

Tablestoreコンソールの使用

Tablestoreコンソールで検索インデックスの説明をクエリできます。たとえば、検索インデックスの基本情報、課金情報、ルーティングキー、インデックスフィールド、および事前ソート設定をクエリできます。

  1. インデックスタブに移動します。

    1. Tablestoreコンソールにログオンします。

    2. 上部のナビゲーションバーで、リソースグループとリージョンを選択します。

    3. 概要ページで、管理するインスタンスの名前をクリックするか、インスタンスのアクション列のインスタンスの管理をクリックします。

    4. インスタンスの詳細タブのテーブルタブで、データテーブルの名前をクリックするか、データテーブルのアクション列のインデックスをクリックします。

  2. インデックスタブで、管理する検索インデックスのアクション列のインデックスの詳細をクリックします。

  3. インデックスの詳細ダイアログボックスで、検索インデックスの基本情報、課金情報、ルーティングキー、インデックスフィールド、および事前ソート設定をクエリできます。

Tablestore CLIの使用

Tablestore CLIでdescribe_search_indexコマンドを実行して、検索インデックスの説明をクエリできます。詳細については、検索インデックスを参照してください。

次のサンプルコードは、search_indexという名前の検索インデックスの説明をクエリする方法の例を示しています。

describe_search_index -n search_index

次のコードは出力例を示しています。コマンド出力では、Index schemaパラメーターは検索インデックスのスキーマを示し、TimeToLiveパラメーターは検索インデックス内のデータの有効期間を示します。

Index schema:
{
    "IndexSetting": {
        "RoutingFields": null
    },
    "FieldSchemas": [
        {
            "FieldName": "id",
            "FieldType": "KEYWORD",
            "Index": true,
            "IndexOptions": null,
            "Analyzer": null,
            "AnalyzerParameter": null,
            "EnableSortAndAgg": true,
            "EnableHighlighting": null,
            "Store": false,
            "IsArray": false,
            "FieldSchemas": null,
            "IsVirtualField": false,
            "SourceFieldNames": null,
            "DateFormats": null
        },
        // ... (rest of the JSON is unchanged)
}
TimeToLive: -1

Tablestore SDKの使用

次のTablestore SDKを使用して、検索インデックスの説明をクエリできます。Tablestore SDK for JavaTablestore SDK for GoTablestore SDK for PythonTablestore SDK for Node.jsTablestore SDK for .NETTablestore SDK for PHP。この例では、Tablestore SDK for Javaを使用します。

次のサンプルコードは、有効期限(TTL)、作成時刻、同期ステータス、フィールド情報など、検索インデックスの詳細をクエリする方法の例を示しています。

private static DescribeSearchIndexResponse describeSearchIndex(SyncClient client) {
    DescribeSearchIndexRequest request = new DescribeSearchIndexRequest();
    // データテーブルの名前を指定します。
    request.setTableName("<TABLE_NAME>"); 
    // 検索インデックスの名前を指定します。
    request.setIndexName("<INDEX_NAME>"); 
    DescribeSearchIndexResponse response = client.describeSearchIndex(request);
    // レスポンスの詳細を表示します。
    System.out.println(response.jsonize()); 
    // 検索インデックス内のデータの同期ステータスを表示します。
    System.out.println(response.getSyncStat().getSyncPhase().name());
    return response;
}

関連情報

既存の検索インデックスが要件を満たさなくなった場合は、新しい検索インデックスを作成するか、既存の検索インデックスのスキーマを変更してインデックスフィールドを追加、削除、または変更するか、検索インデックスのTTL構成を調整できます。詳細については、検索インデックスを作成する検索インデックスのスキーマを動的に変更する、および検索インデックスのTTLを指定するを参照してください。