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

Tablestore:FieldSchema

最終更新日:Dec 28, 2024

FieldSchema は、検索インデックス内のすべてのフィールドの設定を指定します。

データ構造

message FieldSchema {
    optional string field_name = 1;
    optional FieldType field_type = 2;
    optional string analyzer = 4;
    optional bool index = 5;
    optional bool sort_and_agg = 6;
    optional bool store = 7;
    repeated FieldSchema field_schemas = 8; // ネストされた型のみに使用
    optional bool is_array = 9;
    optional bytes analyzer_parameter = 10;
    optional bool is_virtual_field = 11;
    repeated string source_field_names = 12;
    repeated string date_formats = 13;
}

パラメーター

必須

説明

field_name

string

はい

フィールドの名前。

重要

フィールド名は、データテーブルのフィールド名と同じである必要があります。

field_type

FieldType

はい

フィールドの型。詳細については、データ型マッピングを参照してください。

重要

検索インデックスのフィールド型は、データテーブルのフィールド型と一致する必要があります。

analyzer

string

いいえ

トークン化方式。デフォルトでは、単一単語トークン化が指定されています。このパラメーターは、field_type を TEXT に設定した場合にのみ使用できます。

index

bool

いいえ

インデックス作成を有効にするかどうかを指定します。デフォルト値:true。true の値は、Tablestore が列に転置インデックススキーマまたは時空間インデックススキーマを使用してインデックスを作成することを指定します。false の値は、Tablestore が列のインデックス作成を有効にしないことを指定します。

sort_and_agg

bool

いいえ

並べ替えおよび集計機能を有効にするかどうかを指定します。

並べ替えおよび集計機能が有効になっているフィールドのみを並べ替えることができます。

store

bool

いいえ

フィールドの値を検索インデックスに格納するかどうかを指定します。

store パラメーターを true に設定すると、データテーブルをクエリせずに検索インデックスからフィールドの値を読み取ることができます。これにより、クエリのパフォーマンスが向上します。

field_schemas

repeated FieldSchema

いいえ

フィールド設定情報。このパラメーターは、フィールドがネストされたデータ型の場合にのみ必要です。

is_array

bool

いいえ

値が配列かどうかを指定します。このパラメーターを true に設定すると、列は配列になります。列に書き込まれるデータは、["a","b","c"]などの JSON 配列である必要があります。

このパラメーターは、フィールドがネストされたデータ型の場合にのみオプションです。

analyzer_parameter

bytes

いいえ

トークン化のオプションパラメーターの設定。値は protobuf でエンコードする必要があります。

トークン化のタイプごとに、異なるオプションパラメーター設定がサポートされています。詳細については、トークン化を参照してください。

is_virtual_field

bool

いいえ

フィールドが仮想列かどうかを指定します。デフォルト値:false。このパラメーターは、仮想列を使用する場合にのみ必要です。

source_field_names

string

いいえ

データテーブル内のフィールドの名前。このパラメーターは、仮想列を使用し、is_virtual_field を true に設定した場合にのみ必要です。

date_formats

string

いいえ

日付の形式。このパラメーターは、field_type を DATE に設定した場合にのみ必要です。