Table Store Python SDK 首碼查詢 - Tablestore

前提條件

功能說明

首碼查詢用於匹配指定欄位中以查詢字串開頭的欄位值或分詞詞條。對於 Keyword 欄位，欄位值必須以查詢字串開頭；對於 Text 欄位，只要分詞後的任一詞條以查詢字串開頭即可匹配，查詢字串本身不會被分詞。匹配區分大小寫。調用 search 方法時，需要將查詢類型設定為 PrefixQuery。欄位類型說明請參見字串類型。

PrefixQuery(field_name, prefix, weight=None)

以下樣本查詢 category 欄位值以 book- 開頭的資料，返回最多 10 行資料及匹配總行數。

query = PrefixQuery("category", "book-")
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)

參數說明

查詢請求

search 方法包含以下參數。

名稱	類型	說明
table_name（必選）	`str`	資料表名稱。
index_name（必選）	`str`	多元索引名稱。
search_query（必選）	`SearchQuery`	查詢條件和通用查詢配置。
columns_to_get（可選）	`ColumnsToGet`	返回列配置。未設定時只返回主鍵列。
routing_keys（可選）	`list`	自訂路由欄位對應的主索引值列表。未配置自訂路由時無需設定。
timeout_s（可選）	`int`	請求級逾時時間，單位為秒。未設定時使用用戶端預設逾時時間。

查詢配置

search_query 的類型為 SearchQuery，包含以下參數。

名稱	類型	說明
query（必選）	`Query`	查詢條件。設定為 `PrefixQuery`。
sort（可選）	`Sort`	返回結果的排序方式。有關配置方法，請參見排序和翻頁。
get_total_count（可選）	`bool`	是否返回匹配總行數。預設值為 `False`。設定為 `True` 會增加查詢開銷。
next_token（可選）	`bytes`	翻頁憑證。將上一次響應的 `next_token` 設定到下一次請求中可繼續讀取後續資料。有關配置方法，請參見排序和翻頁。
offset（可選）	`int`	本次查詢的起始位置。適用於淺翻頁。
limit（可選）	`int`	本次查詢返回的最大行數。設定為 `0` 時不返回具體行。
aggs（可選）	`list[Agg]`	統計彙總配置。有關配置方法，請參見統計彙總。
group_bys（可選）	`list[BaseGroupBy]`	分組配置。有關配置方法，請參見統計彙總。
collapse_field（可選）	`Collapse`	結果摺疊配置，用於按指定欄位對返回結果去重。有關配置方法，請參見摺疊（去重）。
highlight（可選）	`Highlight`	`Text` 欄位的摘要與高亮配置。有關配置方法，請參見摘要與高亮。

查詢條件

search_query.query 的類型為 PrefixQuery，包含以下參數。

名稱	類型	說明
field_name（必選）	`str`	要查詢的 `Keyword` 或 `Text` 類型索引欄位名稱。
prefix（必選）	`str`	查詢字串。對於 `Keyword` 欄位，欄位值必須以該字串開頭；對於 `Text` 欄位，分詞後的任一詞條必須以該字串開頭。查詢字串本身不會被分詞，匹配區分大小寫。
weight（可選）	`float`	查詢條件的相關性權重，必須為正浮點數。該參數不影響匹配結果和返回行數，僅在按相關性評分排序時影響結果順序。預設值為 `1.0`。

返回列

columns_to_get 的類型為 ColumnsToGet，包含以下參數。

名稱	類型	說明
column_names（可選）	`list[str]`	要返回的屬性列名稱。僅 `return_type` 為 `SPECIFIED` 時需要設定。
return_type（可選）	`ColumnReturnType`	返回列模式。`NONE`（預設值）僅返回主鍵列；`SPECIFIED` 返回 `column_names` 指定的屬性列；`ALL` 返回資料表中的全部屬性列；`ALL_FROM_INDEX` 返回已建立索引的全部屬性列。

傳回值

search 方法返回 SearchResponse。核心欄位如下。

欄位	類型	說明
rows	`list[Row]`	本次查詢返回的行資料，數量不超過 `limit`。
next_token	`bytes`	下一頁憑證。值非空時，將其設定到下一次請求中繼續讀取。
total_count	`int`	匹配行數。傳回值取決於 `get_total_count` 配置。
is_all_succeed	`bool`	是否已成功查詢全部索引分割區。值為 `False` 時返回的是部分結果，`total_count` 可能小於實際匹配行數。
agg_results	`list[AggResult]`	統計彙總結果。未配置 `aggs` 時為空白。
group_by_results	`list[GroupByResult]`	分組結果。未配置 `group_bys` 時為空白。
search_hits	`list[SearchHit]`	查詢命中結果，包含相關性評分、高亮結果和匹配子行等擴充資訊。

相容 Tuple 返回格式

Tablestore Python SDK 5.2.0 開始將查詢介面的傳回值由 Tuple 調整為響應對象，5.1.0 及以下版本直接返回 Tuple。5.2.1 及以上版本可調用 SearchResponse.v1_response() 擷取與舊版本相容的 Tuple。新代碼建議直接存取 SearchResponse 的屬性，避免返回欄位擴充後解包數量不匹配。

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