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; // only for nested type
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 | はい | フィールドの型。 詳細については、「データ型」をご参照ください。 重要 多次元インデックスのフィールド型は、データテーブル内の対応するフィールド型と一致させる必要があります。 | |
analyzer | string | いいえ | トークナイザのタイプです。デフォルト値は文字トークン化です。このパラメーターは TEXT フィールドにのみ設定します。 |
index | bool | いいえ | フィールドのインデックスを作成するかどうかを指定します。デフォルト値は true です。このパラメーターを true に設定すると、転置インデックスまたは空間インデックスが作成されます。このパラメーターを false に設定した場合、フィールドのインデックスは作成されません。 |
sort_and_agg | bool | いいえ | フィールドのソートと集約を有効にするかどうかを指定します。 この機能が有効になっているフィールドのみがソートに使用できます。 |
field_schemas | いいえ | サブフィールドの構成です。このパラメーターは、フィールド型が NESTED の場合にのみ必須です。 | |
is_array | bool | いいえ | フィールドが配列であるかどうかを指定します。このパラメーターを true に設定すると、フィールドは配列になります。このフィールドに書き込まれるデータは、 このパラメーターは 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 | いいえ | ベクターフィールドのプロパティパラメーターです。このパラメーターは、フィールド型が VECTOR の場合に必須です。 | |
json_type | いいえ | JSON フィールドのインデックスタイプです。サポートされている値は OBJECT と Object です。このパラメーターは、フィールド型が JSON の場合に必須です。 |