FieldSchema の定義 - Tablestore - Alibaba Cloud ドキュメントセンター

FieldSchema は、検索インデックスのフィールド構成を定義します。検索インデックスの各フィールドには、フィールドタイプ、トークナイザー、インデックス作成の動作などのプロパティを指定する 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;
    repeated FieldSchema field_schemas = 8; // NESTED 型の場合のみ
    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;
    optional bool enable_highlighting = 14;
    optional VectorOptions vector_options = 15;
    optional JsonType json_type = 16;
}

名前	型	必須	説明
field_name	string	はい	フィールド名。データテーブル内の対応するフィールド名と一致させる必要があります。重要フィールド名が一致しない場合、インデックス作成は失敗します。
field_type	FieldType	はい	フィールドタイプ。詳細については、「データ型」をご参照ください。重要検索インデックスのフィールドタイプは、データテーブル内の対応するフィールドタイプと一致している必要があります。
analyzer	string	いいえ	トークナイザータイプ。デフォルト：シングルワードトークン分割。TEXT フィールドにのみ適用されます。
index	bool	いいえ	フィールドのインデックス作成を有効にするかどうかを指定します。デフォルト：true。true に設定すると、転置インデックスまたは空間インデックスが作成されます。false に設定すると、インデックスは作成されません。
sort_and_agg	bool	いいえ	フィールドのソートと集約を有効にするかどうかを指定します。ソートに使用できるのは、ソートと集約が有効なフィールドのみです。
field_schemas	FieldSchema	いいえ	サブフィールドの構成。フィールドタイプが NESTED の場合にのみ必須です。
is_array	bool	いいえ	フィールドが配列であるかどうかを指定します。true に設定した場合、このフィールドに書き込まれるデータは、`["a","b","c"]` のような JSON 配列形式である必要があります。 NESTED フィールドでは必須ではありません。
analyzer_parameter	bytes	いいえ	オプションのトークナイザーパラメーター設定。値は protobuf でエンコードされている必要があります。サポートされるパラメーターはトークナイザータイプによって異なります。詳細については、「トークナイザー」をご参照ください。
is_virtual_field	bool	いいえ	フィールドが仮想カラムであるかどうかを指定します。デフォルト：false。仮想カラムを使用する場合にのみ必須です。
source_field_names	string	いいえ	この仮想カラムにマッピングされる、データテーブル内のソースフィールド名。is_virtual_field が true に設定されている場合にのみ必須です。
date_formats	string	いいえ	日付フォーマット。DATE フィールドの場合にのみ必須です。
enable_highlighting	bool	いいえ	クエリハイライトとサマリーを有効にするかどうかを指定します。デフォルト：false。この機能は TEXT フィールドでのみサポートされます。このパラメーターを true に設定すると、クエリハイライトとサマリーが有効になります。
vector_options	VectorOptions	いいえ	ベクターフィールドの設定パラメーター。フィールドタイプが VECTOR の場合に必須です。
json_type	JsonType	いいえ	JSON フィールドのインデックスタイプ。有効な値：OBJECT。フィールドタイプが JSON の場合に必須です。