Tablestore:検索インデックスの作成

パラメータ

説明

tableName

データテーブルの名前。

indexName

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

fieldSchemas

フィールドスキーマのリスト。各フィールドスキーマには次のパラメータが含まれます。

• fieldName (必須)：インデックスを作成するフィールドの名前。これは列名です。型： String。

  検索インデックスのフィールドには、プライマリキー列または属性列を指定できます。

• fieldType (必須)：フィールドのデータ型。このパラメータを TableStore.FieldType.XXX に設定します。

• index (オプション)：インデックスを有効にするかどうか。型：ブール型。

  デフォルト値：true。この場合、列の転置インデックスまたは空間インデックスが作成されます。false に設定すると、この列はインデックス作成の対象外となります。

• analyzer (オプション)：トークナイザーのタイプ。フィールドタイプが Text の場合に、このパラメータを設定します。設定しない場合、デフォルトで単語トークン化が使用されます。

• analyzerParameter (オプション)：トークナイザーのパラメータ設定。トークナイザーのタイプに基づいてパラメータを設定します。analyzer パラメータを設定する場合に必須です。

• enableSortAndAgg (オプション)：ソートと統計集計を有効にするかどうか。型：ブール型。

  enableSortAndAgg が true に設定されているフィールドのみがソートと統計集計が可能です。

  重要

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

• isAnArray (オプション)：フィールドが配列であるかどうか。型：ブール型。

  true に設定すると、列は配列になります。["a","b","c"] のような JSON 配列形式でデータを書き込みます。

  Nested タイプは本質的に配列であるため、fieldType が Nested の場合、このパラメータは不要です。

• fieldSchemas (オプション)：フィールドタイプが Nested の場合、このパラメータを使用して、ネストされたドキュメント内のサブ列のインデックスタイプを設定します。フィールドスキーマのリストを指定します。

• isVirtualField (オプション)：フィールドが仮想列であるかどうか。型：ブール型。デフォルト値：false。仮想列を使用する場合は true に設定します。

• sourceFieldName (オプション)：データテーブル内のソースフィールドの名前。型：String。isVirtualField が true に設定されている場合は必須です。

• dateFormats (オプション)：日付形式。型：String。フィールドタイプが Date の場合は必須です。詳細については、「日付と時刻のデータ型」をご参照ください。

• enableHighlighting (オプション)：サマリーとハイライトを有効にするかどうか。型：ブール型。デフォルト値：false。この機能を有効にする場合は true に設定します。ハイライトは Text 型のフィールドでのみサポートされます。

  重要

  この機能は、Tablestore SDK for Node.js 5.5.0 以降でサポートされています。

• vectorOptions (オプション)：ベクトルフィールドのプロパティ。Vector 型のフィールドの場合に必須です。次のパラメータが含まれます。

  • dataType：ベクトルのデータ型。サポートされているのは float32 のみです。その他のデータ型要件については、チケットを送信してください。

  • dimension：ベクトルの次元数。最大：4,096。

  • metricType：ベクトルの距離測定アルゴリズム。サポートされているアルゴリズム：ユークリッド距離 (euclidean)、コサイン類似度 (cosine)、ドット積 (dot_product)。

    • ユークリッド距離 (euclidean)：多次元空間における 2 つのベクトル間の直線距離を測定します。パフォーマンス上の理由から、Tablestore では最終的な平方根の計算がスキップされます。スコアが小さいほど類似度が高いことを示します。

    • コサイン類似度 (cosine)：2 つのベクトル間の角度のコサインを測定します。スコアが高いほど類似度が高いことを示します。テキストデータに一般的に使用されます。

    • ドット積 (dot_product)：同じ次元の 2 つのベクトルの対応する座標を乗算し、結果を合計します。スコアが高いほど類似度が高いことを示します。

    距離メトリックアルゴリズムの選択に関する詳細は、「距離メトリックアルゴリズム」をご参照ください。

indexSetting

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

routingFields (オプション)：カスタムルーティングフィールド。一部のプライマリキー列をルーティングフィールドとして選択できます。ほとんどの場合、1 つだけ設定する必要があります。複数のルーティングキーを設定すると、システムはルーティングキーの値を連結して 1 つの値にします。

インデックスデータの書き込み時に、システムはルーティングフィールドの値に基づいてインデックスデータを分散します。同じルーティングフィールド値を持つレコードは、同じデータパーティションに格納されます。

indexSort

インデックス事前ソート設定。sorters 設定が含まれます。設定しない場合、データはデフォルトでプライマリキーでソートされます。

timeToLive

オプション。データの生存時間 (TTL)。データ保持期間です。単位：秒。

デフォルト値：-1。この場合、データは期限切れになりません。最小 TTL 値は 86400 秒 (1 日) です。

データ保持期間が TTL を超えると、期限切れのデータは自動的にクリーンアップされます。