Pencocokan semua kueri - Tablestore SDK untuk Python - Tablestore

Gunakan Tablestore SDK untuk Python untuk mencocokkan semua baris dalam indeks pencarian dan mengembalikan baris yang cocok atau jumlah total baris yang sesuai.

Prasyarat

Instal Tablestore SDK untuk Python dan inisialisasi klien.

Deskripsi

Pencocokan semua kueri mencocokkan seluruh data dalam indeks pencarian tanpa kondisi berbasis bidang atau nilai. Saat memanggil metode search, atur jenis kueri menjadi MatchAllQuery.

MatchAllQuery()

Contoh berikut mencocokkan semua baris dalam indeks pencarian dan mengembalikan hingga 10 baris serta jumlah total baris yang cocok.

query = MatchAllQuery()
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)

Catatan

MatchAllQuery memberikan skor relevansi yang sama kepada semua baris yang cocok. Jika tidak ada urutan pengurutan yang ditentukan, urutan baris yang dikembalikan tidak dijamin. Untuk hanya mengambil jumlah total baris yang cocok, atur limit menjadi 0. Mengaktifkan pelacakan jumlah total meningkatkan beban kueri.

Parameter

Permintaan pencarian

Metode search mencakup parameter berikut.

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

Konfigurasi kueri

search_query bertipe SearchQuery dan mencakup parameter berikut.

Name	Type	Description
query (required)	`Query`	Kondisi kueri. Atur parameter ini ke `MatchAllQuery`.
sort (optional)	`Sort`	Urutan pengurutan hasil kueri. Untuk informasi lebih lanjut, lihat Sort and paginate results.
get_total_count (optional)	`bool`	Menentukan apakah akan mengembalikan jumlah total baris yang cocok. Nilai default: `False`. Menyetel parameter ini ke `True` meningkatkan beban kueri.
next_token (optional)	`bytes`	Token paginasi. Atur parameter ini ke `next_token` dari respons sebelumnya untuk mengambil halaman berikutnya. Untuk informasi lebih lanjut, lihat Sort and paginate results.
offset (optional)	`int`	Offset tempat kueri saat ini dimulai. Gunakan parameter ini untuk paginasi dangkal.
limit (optional)	`int`	Jumlah maksimum baris yang dikembalikan. Jika parameter ini diatur ke `0`, tidak ada data baris yang dikembalikan.
aggs (optional)	`list[Agg]`	Konfigurasi agregasi. Untuk informasi lebih lanjut, lihat Aggregation.
group_bys (optional)	`list[BaseGroupBy]`	Konfigurasi pengelompokan. Untuk informasi lebih lanjut, lihat Aggregation.
collapse_field (optional)	`Collapse`	Konfigurasi collapsing hasil, yang menghapus hasil duplikat berdasarkan bidang tertentu. Untuk informasi lebih lanjut, lihat Collapse query results.

Kondisi kueri

search_query.query bertipe MatchAllQuery dan tidak memiliki parameter tambahan.

Kolom yang dikembalikan

columns_to_get bertipe ColumnsToGet dan mencakup parameter berikut.

Name	Type	Description
column_names (optional)	`list[str]`	Nama kolom atribut yang akan dikembalikan. Tentukan parameter ini hanya ketika `return_type` adalah `SPECIFIED`.
return_type (optional)	`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 diindeks.

Respons

Metode search mengembalikan SearchResponse. Tabel berikut menjelaskan field inti.

Field	Type	Description
rows	`list[Row]`	Baris yang dikembalikan oleh kueri saat ini. Jumlah baris tidak melebihi `limit`.
next_token	`bytes`	Token untuk halaman berikutnya. Jika field 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. Field ini kosong jika `aggs` tidak dikonfigurasi.
group_by_results	`list[GroupByResult]`	Hasil pengelompokan. Field ini kosong jika `group_bys` tidak dikonfigurasi.
search_hits	`list[SearchHit]`	Hit pencarian, termasuk informasi tambahan seperti skor relevansi, sorotan, dan baris anak yang cocok.

Respons kompatibel tupel

Mulai dari Tablestore SDK untuk Python versi 5.2.0, API pencarian mengembalikan objek respons, bukan tupel. Versi 5.1.0 dan sebelumnya langsung mengembalikan tupel. 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 kesalahan unpacking jika field respons diperluas.

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