Table Store Python SDK 匹配查詢 - Tablestore

前提條件

功能說明

匹配查詢用於檢索 Text 或 Keyword 類型欄位（欄位說明請參見字串類型）。查詢 Text 欄位時，查詢文本使用欄位的分詞器分詞，並根據 operator 或 minimum_should_match 判斷需要匹配的詞條；查詢 Keyword 欄位時，查詢文本不分詞。匹配查詢不要求詞條按查詢文本中的順序相鄰出現；如需按詞條順序和位置匹配，請使用短語匹配查詢。

MatchQuery(
    field_name,
    text,
    minimum_should_match=None,
    operator=None,
    weight=None,
)

以下樣本查詢 description 欄位中同時包含 tablestore 和 durable 詞條的資料。

query = MatchQuery(
    "description",
    "tablestore durable",
    operator=QueryOperator.AND,
)
response = client.search(
    "example_table",
    "example_index",
    SearchQuery(
        query,
        sort=Sort([ScoreSort()]),
        limit=10,
        get_total_count=True,
    ),
    ColumnsToGet(return_type=ColumnReturnType.ALL),
)
for hit in response.search_hits:
    print(hit.score, hit.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`	查詢條件。設定為 `MatchQuery`。
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 的類型為 MatchQuery，包含以下參數。

名稱	類型	說明
field_name（必選）	`str`	要查詢的 `Text` 或 `Keyword` 類型索引欄位名稱。
text（必選）	`str`	查詢文本。查詢 `Text` 欄位時進行分詞；查詢 `Keyword` 欄位時不分詞。
minimum_should_match（可選）	`int`	`operator` 為 `OR` 時至少需要匹配的查詢詞條數。
operator（可選）	`QueryOperator`	查詢詞條的組合方式。`OR`（預設）表示匹配任意詞條；`AND` 表示必須匹配全部詞條。
weight（可選）	`float`	查詢權重，必須為正浮點數。預設值為 `1.0`；影響相關性得分，不改變匹配範圍。

返回列

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

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

傳回值

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

欄位	類型	說明
rows	`list[Row]`	本次查詢返回的行資料，數量不超過 `limit`。
next_token	`bytes`	下一頁憑證。值為空白時表示沒有更多資料。
total_count	`int`	匹配行數，取決於 `get_total_count` 配置。
is_all_succeed	`bool`	是否已成功查詢全部索引分割區。值為 `False` 時返回的是部分結果。
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()

情境樣本

設定最小匹配詞條數

以下樣本要求查詢文本分詞後至少有兩個詞條命中。

query = MatchQuery(
    "description",
    "tablestore durable cloud",
    operator=QueryOperator.OR,
    minimum_should_match=2,
)
response = client.search(
    "example_table",
    "example_index",
    SearchQuery(query, limit=10),
)
print(response.rows)