Tipe data FieldSchema mendefinisikan konfigurasi semua bidang dalam indeks pencarian.
Struktur data
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;
}Name | Type | Diperlukan | Deskripsi |
field_name | string | Ya | Nama dari field. Penting Nama bidang harus sesuai dengan nama bidang yang bersesuaian di tabel data. |
field_type | Ya | Tipe bidang. Untuk informasi selengkapnya, lihat Data types. Penting Tipe bidang untuk search index harus sesuai dengan tipe bidang yang bersesuaian di tabel data. | |
analyzer | string | Tidak | Jenis tokenizer. Nilai default-nya adalah tokenisasi kata tunggal. Atur parameter ini hanya untuk bidang TEXT. |
index | bool | Tidak | Menentukan apakah akan membuat indeks untuk bidang tersebut. Nilai default-nya adalah true. Jika parameter ini diatur ke true, indeks terbalik atau indeks spasial akan dibuat. Jika Anda mengatur parameter ini ke false, tidak ada indeks yang dibuat untuk bidang tersebut. |
sort_and_agg | bool | Tidak | Menentukan apakah fitur pengurutan dan agregasi diaktifkan untuk bidang tersebut. Hanya bidang yang memiliki fitur ini yang dapat digunakan untuk pengurutan. |
field_schemas | Tidak | Konfigurasi sub-bidang. Parameter ini hanya diperlukan ketika tipe bidang adalah NESTED. | |
is_array | bool | Tidak | Menentukan apakah bidang tersebut merupakan array. Jika Anda mengatur parameter ini ke true, bidang tersebut adalah array. Data yang ditulis ke bidang ini harus dalam format array JSON, seperti Parameter ini tidak diperlukan untuk bidang NESTED. |
analyzer_parameter | bytes | Tidak | Pengaturan parameter opsional untuk tokenizer. Nilainya harus dimarshalkan oleh protobuf. Parameter yang didukung bervariasi tergantung pada jenis tokenizer. Untuk informasi selengkapnya, lihat Tokenizers. |
is_virtual_field | bool | Tidak | Menentukan apakah bidang tersebut merupakan kolom virtual. Nilai default-nya adalah false. Parameter ini hanya diperlukan jika Anda menggunakan kolom virtual. |
source_field_names | string | Tidak | Nama bidang sumber di tabel data. Parameter ini hanya diperlukan jika `is_virtual_field` diatur ke true. |
date_formats | string | Tidak | Format tanggal. Parameter ini hanya diperlukan untuk bidang DATE. |
enable_highlighting | bool | No | Menentukan apakah ringkasan kueri dan penyorotan (highlighting) diaktifkan. Nilai default-nya adalah false. Hanya bidang TEXT yang mendukung fitur ini. Untuk menggunakan ringkasan kueri dan penyorotan, atur parameter ini ke true. |
vector_options | No | Parameter properti untuk bidang vektor. Parameter ini diperlukan jika tipe bidang adalah VECTOR. | |
json_type | No | Tipe indeks untuk bidang JSON. Nilai yang didukung adalah OBJECT dan Object. Parameter ini diperlukan jika tipe bidang adalah JSON. |