Kueri Rentang - Tablestore SDK untuk Python - Tablestore

Gunakan Tablestore SDK untuk Python untuk menjalankan kueri rentang berbasis indeks pencarian dan memfilter data berdasarkan batas nilai bidang, dengan kendali atas apakah setiap batas disertakan atau tidak.

Prasyarat

Pasang Tablestore SDK untuk Python dan inisialisasi klien.

Deskripsi

Kueri rentang berbasis indeks pencarian mencocokkan baris yang nilai bidangnya berada dalam rentang tertentu. Anda dapat menentukan hanya batas bawah, hanya batas atas, atau keduanya, tetapi setidaknya satu batas harus ditentukan. Untuk bidang Text, suatu baris cocok jika salah satu token-nya berada dalam rentang tersebut. Saat memanggil metode search, atur jenis kueri menjadi RangeQuery.

RangeQuery(field_name, range_from=None, range_to=None, include_lower=True, include_upper=False)

Contoh berikut mengkueri baris yang nilai bidang price-nya berada dalam rentang kiri-tertutup, kanan-terbuka [100, 500), serta mengembalikan hingga 10 baris dan jumlah total baris yang cocok.

query = RangeQuery(
    "price",
    range_from=100,
    range_to=500,
    include_lower=True,
    include_upper=False,
)
search_query = SearchQuery(
    query,
    limit=10,
    get_total_count=True,
)
response = client.search(
    "example_table",
    "example_index",
    search_query,
    ColumnsToGet(return_type=ColumnReturnType.ALL),
)
print(response.total_count)
for row in response.rows:
    print(row)

Parameter

Permintaan pencarian

Metode search mencakup parameter berikut.

Nama	Tipe	Deskripsi
table_name (wajib)	`str`	Nama tabel data.
index_name (wajib)	`str`	Nama indeks pencarian.
search_query (wajib)	`SearchQuery`	Kondisi kueri dan konfigurasi kueri umum.
columns_to_get (opsional)	`ColumnsToGet`	Konfigurasi kolom yang dikembalikan. Jika parameter ini tidak ditentukan, hanya kolom kunci primer yang dikembalikan.
routing_keys (opsional)	`list`	Daftar nilai kunci primer untuk bidang routing kustom. Anda tidak perlu menentukan parameter ini jika routing kustom tidak dikonfigurasi.
timeout_s (opsional)	`int`	Timeout permintaan dalam detik. Jika parameter ini tidak ditentukan, timeout tingkat client akan digunakan.

Konfigurasi kueri

search_query bertipe SearchQuery dan mencakup parameter berikut.

Nama	Type	Deskripsi
query (wajib)	`Query`	Kondisi kueri. Atur parameter ini ke `RangeQuery`.
sort (opsional)	`Sort`	Urutan pengurutan hasil kueri. Untuk informasi selengkapnya, lihat Sort and paginate results.
get_total_count (opsional)	`bool`	Menentukan apakah jumlah total baris yang cocok dikembalikan. Nilai default: `False`. Mengatur parameter ini ke `True` meningkatkan beban kueri.
next_token (opsional)	`bytes`	Token paginasi. Atur parameter ini ke `next_token` dari respons sebelumnya untuk mengambil halaman berikutnya. Untuk informasi selengkapnya, lihat Sort and paginate results.
offset (opsional)	`int`	Offset tempat kueri saat ini dimulai. Gunakan parameter ini untuk paginasi dangkal.
limit (opsional)	`int`	Jumlah maksimum baris yang dikembalikan. Jika parameter ini diatur ke `0`, tidak ada data baris yang dikembalikan.
aggs (opsional)	`list[Agg]`	Konfigurasi agregasi. Untuk informasi selengkapnya, lihat Aggregation.
group_bys (opsional)	`list[BaseGroupBy]`	Konfigurasi pengelompokan. Untuk informasi selengkapnya, lihat Aggregation.
collapse_field (opsional)	`Collapse`	Konfigurasi collapsing hasil, yang menghapus hasil duplikat berdasarkan bidang tertentu. Untuk informasi selengkapnya, lihat Collapse query results.
highlight (opsional)	`Highlight`	Konfigurasi ringkasan dan penyorotan untuk bidang `Text`. Untuk informasi selengkapnya, lihat Summary and highlighting.

Kondisi kueri

search_query.query bertipe RangeQuery dan mencakup parameter berikut.

Nama	Tipe	Deskripsi
field_name (wajib)	`str`	Nama bidang terindeks yang akan dikueri. Kueri rentang mendukung bidang `Long`, `Double`, `Boolean`, `Keyword`, `Text`, dan `Date` serta bidang turunan dari bidang JSON Object. Untuk bidang `Text`, suatu baris cocok jika salah satu token-nya berada dalam rentang tersebut.
range_from (opsional)	`str / int / float / bool`	Batas bawah. Anda harus menentukan setidaknya salah satu dari `range_from` dan `range_to`.
range_to (opsional)	`str / int / float / bool`	Batas atas. Anda harus menentukan setidaknya salah satu dari `range_from` dan `range_to`.
include_lower (opsional)	`bool`	Menentukan apakah batas bawah disertakan. Nilai default: `True`.
include_upper (opsional)	`bool`	Menentukan apakah batas atas disertakan. Nilai default: `False`.

Kolom yang dikembalikan

columns_to_get bertipe ColumnsToGet dan mencakup parameter berikut.

Nama	Tipe	Deskripsi
column_names (opsional)	`list[str]`	Nama kolom atribut yang dikembalikan. Tentukan parameter ini hanya ketika `return_type` bernilai `SPECIFIED`.
return_type (opsional)	`ColumnReturnType`	Mode kolom yang dikembalikan. `NONE` (default) hanya mengembalikan kolom kunci primer; `SPECIFIED` mengembalikan kolom atribut dalam `column_names`; `ALL` mengembalikan semua kolom atribut dari tabel; dan `ALL_FROM_INDEX` mengembalikan semua kolom atribut yang terindeks.

Respons

Metode search mengembalikan objek SearchResponse. Tabel berikut menjelaskan bidang utamanya.

Bidang	Tipe	Deskripsi
rows	`list[Row]`	Baris yang dikembalikan oleh kueri saat ini. Jumlah baris tidak melebihi `limit`.
next_token	`bytes`	Token untuk halaman berikutnya. Jika bidang ini tidak kosong, teruskan ke permintaan berikutnya untuk melanjutkan pembacaan.
total_count	`int`	Jumlah baris yang cocok. Nilainya bergantung pada konfigurasi `get_total_count`.
is_all_succeed	`bool`	Menunjukkan apakah semua partisi indeks telah dikueri. Jika nilainya `False`, hasil parsial dikembalikan dan `total_count` mungkin kurang dari jumlah aktual baris yang cocok.
agg_results	`list[AggResult]`	Hasil agregasi. Bidang ini kosong jika `aggs` tidak dikonfigurasi.
group_by_results	`list[GroupByResult]`	Hasil pengelompokan. Bidang ini kosong jika `group_bys` tidak dikonfigurasi.
search_hits	`list[SearchHit]`	Hasil pencarian, termasuk informasi tambahan seperti skor relevansi, sorotan, dan baris turunan yang cocok.

Respons kompatibel Tupel

Mulai Tablestore SDK untuk Python versi 5.2.0, API pencarian mengembalikan objek respons, bukan tupel. Versi 5.1.0 dan sebelumnya mengembalikan tupel secara langsung. Pada versi 5.2.1 dan seterusnya, Anda dapat memanggil SearchResponse.v1_response() untuk mendapatkan tupel yang kompatibel dengan versi sebelumnya. Untuk kode baru, akses atribut SearchResponse secara langsung guna menghindari error unpacking jika bidang respons diperluas.

(
    rows,
    next_token,
    total_count,
    is_all_succeed,
    agg_results,
    group_by_results,
    search_hits,
) = response.v1_response()