Table Store Python SDK 多條件組合查詢 - Tablestore

前提條件

功能說明

多條件組合查詢使用 BoolQuery 將多個子查詢組合成複雜條件。子查詢可以是任意查詢類型，也可以是另一個 BoolQuery。must_queries 和 filter_queries 表示 AND，should_queries 表示 OR，must_not_queries 表示 NOT；其中 filter_queries 和 must_not_queries 不參與相關性評分。

未設定 minimum_should_match 時，如果同級包含 must_queries 或 filter_queries，則 should_queries 預設不作為必須滿足的條件；其他包含 should_queries 的情況預設至少滿足一個 should_queries 子查詢。

BoolQuery(
    must_queries=None,
    must_not_queries=None,
    filter_queries=None,
    should_queries=None,
    minimum_should_match=None,
    weight=None,
)

以下樣本查詢 city 等於 hangzhou 且 category 等於 book 的資料。

query = BoolQuery(
    must_queries=[
        TermQuery("city", "hangzhou"),
        TermQuery("category", "book"),
    ]
)
response = client.search(
    "example_table",
    "example_index",
    SearchQuery(query, limit=10, get_total_count=True),
    ColumnsToGet(return_type=ColumnReturnType.ALL),
)
print(response.rows)

參數說明

查詢請求

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`	查詢條件。設定為 `BoolQuery`。
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 的類型為 BoolQuery，包含以下參數。

名稱	類型	說明
must_queries（可選）	`list[Query]`	必須全部滿足的子查詢。匹配的子查詢參與相關性評分。
filter_queries（可選）	`list[Query]`	必須全部滿足的子查詢，但不參與相關性評分。
should_queries（可選）	`list[Query]`	至少滿足指定數量的子查詢。滿足的條件越多，相關性得分越高。
must_not_queries（可選）	`list[Query]`	不能滿足其中任何一個條件的子查詢，不參與相關性評分。
minimum_should_match（可選）	`int`	必須滿足的 `should_queries` 子查詢最小數量。
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()

情境樣本

組合 OR、NOT 和過濾條件

以下樣本要求資料屬於 book- 分類，並至少滿足 Python 或 Java 分類中的一個，同時排除 deprecated 狀態。

query = BoolQuery(
    filter_queries=[PrefixQuery("category", "book-")],
    should_queries=[
        TermQuery("category", "book-python"),
        TermQuery("category", "book-java"),
    ],
    must_not_queries=[TermQuery("status", "deprecated")],
    minimum_should_match=1,
)
response = client.search(
    "example_table",
    "example_index",
    SearchQuery(query, limit=10),
)
print(response.rows)