FieldSchema mendefinisikan konfigurasi bidang untuk indeks pencarian. Setiap bidang dalam indeks pencarian memerlukan entri FieldSchema yang menetapkan properti seperti tipe bidang, tokenizer, dan perilaku pengindeksan.
Parameters
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 | Required | Description |
field_name | string | Yes | Nama bidang. Nama tersebut harus sesuai dengan nama bidang yang sesuai di tabel data. Penting Ketidaksesuaian nama bidang menyebabkan pembuatan indeks gagal. |
field_type | Yes | Tipe bidang. Untuk informasi selengkapnya, lihat Data types. Penting Tipe bidang untuk indeks pencarian harus sesuai dengan tipe bidang yang sesuai di tabel data. | |
analyzer | string | No | Jenis tokenizer. Default: tokenisasi kata tunggal. Hanya berlaku untuk bidang TEXT. |
index | bool | No | Menentukan apakah pengindeksan diaktifkan untuk bidang ini. Default: true. Jika diatur ke true, indeks terbalik atau indeks spasial akan dibuat. Jika diatur ke false, tidak ada indeks yang dibuat. |
sort_and_agg | bool | No | Menentukan apakah pengurutan dan agregasi diaktifkan untuk bidang ini. Hanya bidang yang telah diaktifkan fitur pengurutan dan agregasinya yang dapat digunakan untuk pengurutan. |
field_schemas | No | Konfigurasi subbidang. Diperlukan hanya ketika tipe bidang adalah NESTED. | |
is_array | bool | No | Menentukan apakah bidang ini merupakan array. Jika diatur ke true, data yang ditulis ke bidang ini harus dalam format array JSON, seperti Tidak diperlukan untuk bidang NESTED. |
analyzer_parameter | bytes | No | Pengaturan parameter tokenizer opsional. Nilainya harus dikodekan dengan protobuf. Parameter yang didukung bervariasi tergantung jenis tokenizer. Untuk informasi selengkapnya, lihat Tokenizers. |
is_virtual_field | bool | No | Menentukan apakah bidang ini merupakan kolom virtual. Default: false. Diperlukan hanya saat menggunakan kolom virtual. |
source_field_names | string | No | Nama bidang sumber di tabel data yang dipetakan ke kolom virtual ini. Diperlukan hanya saat is_virtual_field diatur ke true. |
date_formats | string | No | Format tanggal. Diperlukan hanya untuk bidang DATE. |
enable_highlighting | bool | No | Menentukan apakah sorotan kueri dan ringkasan diaktifkan. Default: false. Hanya bidang TEXT yang mendukung fitur ini. Atur parameter ini ke true untuk mengaktifkan sorotan kueri dan ringkasan. |
vector_options | No | Parameter konfigurasi untuk bidang vektor. Diperlukan saat tipe bidang adalah VECTOR. | |
json_type | No | Tipe indeks bidang JSON. Nilai yang valid: OBJECT dan Object. Diperlukan saat tipe bidang adalah JSON. |