Table Store Python SDK 摺疊（去重） - Tablestore

前提條件

功能說明

摺疊按照指定多元索引欄位的值對匹配行分組，每個不同欄位值只返回一行代表資料。分組內返回哪一行由查詢排序方式決定，可通過排序和翻頁設定。摺疊只改變查詢結果，不修改資料表。

重要

摺疊欄位必須啟用排序與統計彙總，只支援 Keyword、Long 和 Double 類型的非數組欄位。摺疊查詢只能使用 limit 和 offset 翻頁，不能使用 next_token；limit + offset 不能超過 100000。統計彙總、分組和匹配總行數均基於摺疊前的結果，無法通過響應擷取摺疊後的總分組數。

以下樣本按 category 摺疊結果，並按 price 降序排序，因此每個類別返回價格最高的一行。

query = MatchAllQuery()
search_query = SearchQuery(
    query,
    sort=Sort([FieldSort("price", SortOrder.DESC)]),
    collapse_field=Collapse("category"),
    limit=10,
    get_total_count=True,
)
response = client.search(
    "example_table",
    "example_index",
    search_query,
    ColumnsToGet(
        ["category", "price"],
        ColumnReturnType.SPECIFIED,
    ),
)
print(response.total_count)
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`	查詢條件。根據資料匹配需求設定具體 Query 類型。
sort（可選）	`Sort`	返回結果的排序方式。有關配置方法，請參見排序和翻頁。
get_total_count（可選）	`bool`	是否返回匹配總行數。預設值為 `False`；設定為 `True` 會增加查詢開銷。
next_token（可選）	`bytes`	使用摺疊功能時不能設定。
offset（可選）	`int`	起始分組位置，預設值為 `0`。與 `limit` 之和不能超過 `100000`。
limit（可選）	`int`	本次查詢返回的最大行數。設定為 `0` 時不返回具體行。
aggs（可選）	`list[Agg]`	指標彙總配置。有關配置方法，請參見統計彙總。
group_bys（可選）	`list[BaseGroupBy]`	分組配置。有關配置方法，請參見統計彙總。
collapse_field（必選）	`Collapse`	結果摺疊配置。
highlight（可選）	`Highlight`	`Text` 欄位的摘要與高亮配置。有關配置方法，請參見摘要與高亮。

摺疊配置

search_query.collapse_field 的類型為 Collapse，包含以下參數。

名稱	類型	說明
field_name（必選）	`str`	摺疊欄位名稱。欄位必須啟用排序與統計彙總，且為 `Keyword`、`Long` 或 `Double` 類型的非數組欄位。

返回列

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]`	摺疊後的行資料，每個不同摺疊欄位值最多返回一行。
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()