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,表示對該列構建倒排索引或者空間索引;如果設定為false,則不會對該列構建索引。 |
sort_and_agg | bool | 否 | 是否開啟排序與統計彙總功能。 只有開啟排序與統計彙總功能的欄位才能進行排序。 |
field_schemas | 否 | 欄位配置資訊。只有欄位類型為巢狀型別時,才需要設定此參數。 | |
is_array | bool | 否 | 是否為數組。如果設定為true,則表示該列是一個數組。在資料表中寫入資料時,必須按照JSON數組格式寫入,例如 當欄位類型為巢狀型別時,無需設定此參數。 |
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時,必須設定此參數。 |