表格存储 Python SDK 折叠（去重）-表格存储 Tablestore(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()