Meminta data menggunakan indeks pencarian.
Sintaks permintaan
message SearchRequest {
optional string table_name = 1;
optional string index_name = 2;
optional ColumnsToGet columns_to_get = 3;
optional bytes search_query = 4;
repeated bytes routing_values = 5;
optional int32 timeout_ms = 6;
}Parameter | Tipe | Diperlukan | Deskripsi |
table_name | string | Ya | Nama tabel data. |
index_name | string | Ya | Nama indeks pencarian. |
columns_to_get | Tidak | Kolom yang ingin Anda kembalikan. | |
search_query | bytes | Ya | Konfigurasi query. Nilainya harus dienkripsi dalam protobuf. Untuk informasi lebih lanjut tentang item konfigurasi, lihat SearchQuery. |
routing_values | bytes | Tidak | Kunci routing. |
timeout_ms | int32 | Tidak | Periode timeout untuk query. Unit: milidetik. |
Sintaks respons
message SearchResponse {
optional int64 total_hits = 1;
repeated bytes rows = 2;
repeated SearchHit search_hits = 5;
optional bool is_all_succeeded = 3;
optional bytes next_token = 6;
optional bytes aggs = 7;
optional bytes group_bys = 8;
optional ConsumedCapacity consumed = 9;
optional ConsumedCapacity reserved_consumed = 10;
}Parameter | Tipe | Deskripsi |
total_hits | int64 | Jumlah total baris yang cocok. |
rows | bytes | Informasi tentang baris. Nilainya dienkripsi dalam PlainBuffer. Untuk informasi lebih lanjut, lihat PlainBuffer. |
search_hits | Baris yang cocok dikembalikan. Nilai pengembalian hanya ada ketika Anda menggunakan fitur query vektor KNN atau sorotan. | |
is_all_succeeded | bool | Menunjukkan apakah query berhasil. |
next_token | bytes | Posisi dari mana pembacaan data berikutnya dimulai. Jika semua baris data yang memenuhi kondisi dikembalikan, nilai parameter ini kosong. |
aggs | bytes | Operasi agregasi yang dilakukan pada baris data, seperti menghitung nilai maksimum, minimum, rata-rata, atau jumlah baris. Hasil agregasi dienkripsi dalam protobuf. |
group_bys | bytes | Mengelompokkan baris data berdasarkan nilai bidang atau rentang. Hasil pengelompokan dienkripsi dalam protobuf. |
consumed | Jumlah unit kapasitas terukur yang dikonsumsi oleh operasi. | |
reserved_consumed | Jumlah unit kapasitas cadangan yang dikonsumsi oleh operasi. |