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; // 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;
}
名稱 | 類型 | 是否必選 | 描述 |
field_name | string | 是 | 字段名稱。 重要 字段名稱必須與數據表中的字段名稱相同。 |
field_type | 是 | 字段類型。更多信息,請參見基礎數據類型及映射。 重要 多元索引的字段類型必須與數據表中字段類型相匹配。 | |
analyzer | string | 否 | 分詞器類型。默認值為單字分詞。當字段類型為TEXT時可設置此參數。 |
index | bool | 否 | 是否開啟索引。默認值為true,表示對該列構建倒排索引或者空間索引;如果設置為false,則不會對該列構建索引。 |
sort_and_agg | bool | 否 | 是否開啟排序與統計聚合功能。 只有開啟排序與統計聚合功能的字段才能進行排序。 |
store | 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時,必須設置此參數。 |