全部產品
Search
文件中心

Tablestore:FieldSchema

更新時間:Jun 30, 2024

表示多元索引所有欄位的配置資訊。

資料結構

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;
}

名稱

類型

是否必選

描述

field_name

string

欄位名稱。

重要

欄位名稱必須與資料表中的欄位名稱相同。

field_type

FieldType

欄位類型。更多資訊,請參見資料類型映射

重要

多元索引的欄位類型必須與資料表中欄位類型相匹配。

analyzer

string

分詞器類型。預設值為單字分詞。當欄位類型為TEXT時可設定此參數。

index

bool

是否開啟索引。預設值為true,表示對該列構建倒排索引或者空間索引;如果設定為false,則不會對該列構建索引。

sort_and_agg

bool

是否開啟排序與統計彙總功能。

只有開啟排序與統計彙總功能的欄位才能進行排序。

store

bool

是否在多元索引中附加儲存該欄位的值。

開啟後,可以直接從多元索引中讀取該欄位的值,而不必反查資料表,可用於查詢效能最佳化。

field_schemas

repeated FieldSchema

欄位配置資訊。只有欄位類型為巢狀型別時,才需要設定此參數。

is_array

bool

是否為數組。如果設定為true,則表示該列是一個數組。在資料表中寫入資料時,必須按照JSON數組格式寫入,例如["a","b","c"]

當欄位類型為巢狀型別時,無需設定此參數。

analyzer_parameter

bytes

分詞的選擇性參數配置,由protobuf編碼。

使用不同分詞類型時支援的選擇性參數配置不同。更多資訊,請參見分詞

is_virtual_field

bool

該欄位是否為虛擬列。預設值為false。只有在使用虛擬列時,才需要設定此參數。

source_field_names

string

資料表中的欄位名稱。當使用虛擬列且欄位的is_virtual_field配置為true時,才需要設定此參數。

date_formats

string

日期的格式。當欄位類型為Date時,才需要設定此參數。