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

Tablestore:検索インデックス

最終更新日:Oct 22, 2026

Tablestore CLI を使用して検索インデックスを作成および管理し、非プライマリキー列によるデータクエリや複数条件を組み合わせたクエリを実現します。

前提条件

  • アクセス認証情報が設定された Tablestore CLI。詳細については、「Tablestore CLI」をご参照ください。

  • データテーブル。詳細については、「データテーブルの操作」をご参照ください。

検索インデックスの作成

create_search_index -n <indexName>

パラメーター

必須

説明

-i, --input

任意

検索インデックススキーマを定義する JSON ファイルへのパス。指定しない場合、CLI は対話型の入力を使用します。

-n, --name

必須

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

-t, --table

任意

データテーブルの名前。use コマンドでデータテーブルがすでに選択されている場合は不要です。

--ttl

任意

データの Time-to-Live (TTL)。データが保持される期間を指定します。単位:秒。デフォルト値:-1 (データは期限切れになりません)。最小値:86400 (1 日)。TTL を超えたデータは自動的に削除されます。

重要

検索インデックスのライフサイクル管理機能を使用するには、UpdateRow 操作を無効にします。検索インデックスの TTL とデータテーブルの TTL は独立しています。検索インデックスの TTL は、データテーブルの TTL 以下である必要があります。

プロンプトが表示されたら、インデックススキーマを JSON 形式で入力するか、-i パラメーターを使用してスキーマファイルを指定します。スキーマには次の設定が含まれます:

パラメーター

必須

説明

IndexSetting

任意

インデックス設定。RoutingFields が含まれます。

RoutingFields (任意):カスタムルーティングフィールド。プライマリキー列をルーティングフィールドとして選択します。同じルーティングフィールド値を持つデータは、読み書き時に同じパーティションに分散され、クエリパフォーマンスが向上します。通常、ルーティングフィールドは 1 つだけ設定します。複数のルーティングフィールドを設定した場合、Tablestore はその値を連結して 1 つにします。

FieldSchemas

必須

FieldSchema オブジェクトのリスト。各 FieldSchema には、次のフィールドが含まれます:

  • FieldName (必須):検索インデックスのフィールド名 (列名)。型:String。検索インデックス内のフィールドは、プライマリキー列または属性列にすることができます。

  • FieldType (必須):フィールドのデータ型。

  • IsArray (任意):フィールドが配列であるかどうかを指定します。型:Boolean。true に設定した場合、列は配列となり、データは ["a","b","c"] のような JSON 配列形式で書き込む必要があります。Nested は配列型であるため、FieldType が Nested の場合はこのパラメーターを設定する必要はありません。

  • Index (任意):インデックスを有効にするかどうかを指定します。型:Boolean。デフォルト値は true で、この場合、列に対して転置インデックスまたは空間インデックスが構築されます。false に設定した場合、列にインデックスは構築されません。

  • Analyzer (任意):トークン化のタイプ。フィールドタイプが Text の場合にこのパラメーターを設定します。設定しない場合、デフォルトは 1 文字ずつのトークン化になります。

  • AnalyzerParameter:SingleWord アナライザーのパラメーター。CaseSensitive (マッチングで大文字と小文字を区別するかどうか。デフォルト:false) および DelimitWord (アルファベット単語と数字を分割するかどうか。デフォルト:false) が含まれます。

  • EnableSortAndAgg (任意):ソートと集計を有効にするかどうかを指定します。型:Boolean。EnableSortAndAgg が true に設定されているフィールドのみがソートに使用できます。

    重要

    Nested フィールドはソートと集計をサポートしていません。ただし、Nested フィールド内のサブ列はソートと集計をサポートしています。

  • IsVirtualField (任意):列が仮想列であるかどうかを指定します。型:Boolean。デフォルト値:false。true に設定した場合、SourceFieldNames が必須です。

  • SourceFieldNames (任意):データテーブル内のフィールド名。型:String。IsVirtualField が true に設定されている場合に必須です。

IndexSort

任意

インデックスの事前ソート設定。デフォルト:プライマリキーによるソート。

重要

Nested フィールドを含むインデックスは IndexSort をサポートしておらず、事前ソートはできません。

Sorters (任意):事前ソート方法。プライマリキーによるソート (PrimaryKeySort) とフィールド値によるソート (FieldSort) をサポートしています。詳細については、「並べ替えとページング」をご参照ください。

  • Name:ソート方法。PrimaryKeySort はプライマリキーでソートします。FieldSort はフィールド値でソートします。ソートと集計が有効になっているインデックス化されたフィールドのみが事前ソート可能です。

  • Sorter:FieldName (ソート用のフィールド名。フィールド値ソートで必須) と Order (ソート順:ASC は昇順、DESC は降順。デフォルト:ASC) を含みます。

例

search_index という名前の検索インデックスを作成します。

create_search_index -n search_index

プロンプトに従ってインデックススキーマを入力します。例:

{
    "IndexSetting": {
        "RoutingFields": null
    },
    "FieldSchemas": [
        {
            "FieldName": "gid",
            "FieldType": "LONG",
            "Index": true,
            "EnableSortAndAgg": true,
            "IsArray": false,
            "IsVirtualField": false
        },
        {
            "FieldName": "col3",
            "FieldType": "TEXT",
            "Index": true,
            "Analyzer": "single_word",
            "AnalyzerParameter": {
                "CaseSensitive": true,
                "DelimitWord": null
            },
            "EnableSortAndAgg": false,
            "IsArray": false,
            "IsVirtualField": false
        }
    ],
    "IndexSort": {
        "Sorters": [
            {
                "Name": "PrimaryKeySort",
                "Sorter": {
                    "Order": "ASC"
                }
            }
        ]
    }
}

ファイルから検索インデックスを作成します:

create_search_index -n search_index -i /tmp/indexschema.json

検索インデックスの一覧表示

list_search_index

パラメーター

必須

説明

-a, --all

任意

すべてのデータテーブルの検索インデックスを一覧表示します。

-d, --detail

任意

検索インデックスに関する詳細情報を表示します。

-t, --table

任意

データテーブルの名前。use コマンドでデータテーブルがすでに選択されている場合は不要です。

例

現在のデータテーブルの検索インデックスを詳細付きで一覧表示します。

list_search_index -d

検索インデックス詳細の表示

describe_search_index -n <indexName>

パラメーター

必須

説明

-n, --name

必須

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

-o, --output

任意

出力をローカルの JSON または TXT ファイルに保存します。

-t, --table

任意

データテーブルの名前。use コマンドでデータテーブルがすでに選択されている場合は不要です。

例

search_index インデックスの詳細を表示します。

describe_search_index -n search_index

出力の Index schema フィールドには、検索インデックススキーマが含まれます。TimeToLive は、検索インデックスの TTL を示します。

検索インデックスを使用したデータクエリ

Tablestore CLI は、Term クエリ、Terms クエリ、Match All クエリ、Match クエリ、Match Phrase クエリ、Prefix クエリ、Range クエリ、Wildcard クエリ、トークンベースの Wildcard クエリ、Bool クエリ、Geo クエリ、Exists クエリなどの検索インデックスクエリタイプをサポートしています。ユースケースに合ったクエリタイプを選択してください。

search -n <indexName> --return_all_indexed

プロンプトが表示されたら、クエリ条件を JSON 形式で入力します。クエリ条件には次の設定が含まれます:

パラメーター

必須

説明

Offset

任意

結果を返す開始位置。

Limit

任意

返される行の最大数。データを返さずに件数のみを取得するには、Limit を 0 に設定します。

Collapse

任意

折りたたみの設定。このパラメーターを使用して、特定列で結果セットを折りたたみ (重複除去) します。FieldName は列名を指定します。整数、浮動小数点、Keyword 型の列のみがサポートされています。

Sort

任意

結果のソート順。詳細については、「クエリ時の定義」をご参照ください。設定しない場合、結果は事前ソート順で返されます。事前ソート順が定義されていない場合、結果はプライマリキー順で返されます。

GetTotalCount

任意

一致した行の総数を返すかどうかを指定します。デフォルト値:false。このオプションを有効にすると、クエリのレイテンシーが増加する可能性があります。

Token

任意

残りの結果を読み取るためのページネーション トークン。レスポンスにすべての一致した行が含まれていない場合、サーバーは Token を返します。次のリクエストでこの Token を渡して読み取りを続行します。最初のリクエストでは Token を null に設定します。

Query

必須

クエリタイプ。サポートされているタイプ:MatchAllQuery、MatchQuery、MatchPhraseQuery、TermQuery、TermsQuery、PrefixQuery、RangeQuery、WildcardQuery、ExistsQuery、NestedQuery、KnnVectorQuery、および BoolQuery。

Aggregations

任意

集計の設定。最小値、最大値、合計、平均、カウント、個別カウントの各操作をサポートしています。

  • Name:集計タイプ (min, max, sum, avg, count など)。

  • Aggregation:集計パラメーターの設定。AggName (カスタム集計名)、Field (集計するフィールド)、MissingValue (フィールドが空の場合のデフォルト値) が含まれます。

例

search_index を使用して現在のテーブル内のデータをクエリし、すべてのインデックス化された列を返します。

search -n search_index --return_all_indexed

プロンプトに従ってクエリ条件を入力します。次の例では、uid が 10001 に等しい行をクエリし、pid 列の平均を計算します:

{
    "Offset": 0,
    "Limit": 10,
    "Collapse": null,
    "Sort": null,
    "GetTotalCount": true,
    "Token": null,
    "Query": {
        "Name": "TermQuery",
        "Query": {
            "FieldName": "uid",
            "Term": 10001
        }
    },
    "Aggregations": [{
        "Name": "avg",
        "Aggregation": {
            "AggName": "agg1",
            "Field": "pid"
        }
    }]
}

検索インデックスの削除

drop_search_index -n <indexName> -y

パラメーター

必須

説明

-n, --name

必須

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

-t, --table

任意

データテーブルの名前。use コマンドでデータテーブルがすでに選択されている場合は不要です。

-y, --yes

必須

削除を確定します。このパラメーターはコマンドで必須です。

例

search_index インデックスを削除します。

drop_search_index -n search_index -y