当数据查询的结果中含有某种类型的数据较多时，可以使用折叠（Collapse）功能按照某一列对结果集做折叠，使对应类型的数据在结果展示中只出现一次，保证结果展示中类型的多样性。
前提条件
已初始化OTSClient。具体操作，请参见初始化OTSClient。
已在数据表上创建多元索引。具体操作，请参见创建多元索引。
注意事项
- 折叠功能只能使用offset+limit方式翻页，不能使用token方式。
- 对结果集同时使用统计聚合与折叠功能时，统计聚合功能只作用于使用折叠功能前的结果集。
- 使用折叠功能后，返回的总分组数取决于offset+limit的最大值，目前支持返回的总分组数最大为50000。
- 执行结果中返回的总行数是使用折叠功能前的匹配行数，使用折叠功能后的总分组数无法获取。
参数
参数 | 说明 |
query | 可以是任意Query类型。 |
collapse | 折叠参数设置，包含field_name设置。 field_name：列名，按该列对结果集做折叠，只支持应用于整型、浮点数和Keyword类型的列，不支持数组类型的列。 |
offset | 本次查询的开始位置。 |
limit | 本次查询需要返回的最大数量。 如果只为了获取行数，无需具体数据，可以设置limit=0，即不返回任意一行数据。 |
get_total_count | 是否返回匹配的总行数，默认为false，表示不返回。 返回匹配的总行数会影响查询性能。 |
table_name | 数据表名称。 |
index_name | 多元索引名称。 |
columns_to_get | 是否返回所有列，包含return_type和column_names设置。
|
示例
以下示例用于查询表中price列的值能够匹配1000的数据，结果集按照product_name列的值做折叠。
# 构造查询条件，返回price为1000的所有商品。
query = TermQuery('price', 1000)
# 根据"product_name"列对结果集做折叠。
collapse = Collapse('product_name')
search_response = client.search('<TABLE_NAME>', '<SEARCH_INDEX_NAME>',
SearchQuery(query, limit=100, get_total_count = False, collapse_field = collapse),
columns_to_get = ColumnsToGet(return_type = ColumnReturnType.ALL_FROM_INDEX))
print('request_id : %s' % search_response.request_id)
print('is_all_succeed : %s' % search_response.is_all_succeed)
print('total_count : %s' % search_response.total_count)
print('rows : %s' % search_response.rows)常见问题
相关文档
多元索引查询类型包括精确查询、多词精确查询、全匹配查询、匹配查询、短语匹配查询、前缀查询、范围查询、通配符查询、多条件组合查询、地理位置查询、嵌套类型查询、向量检索和列存在性查询，您可以选择合适的查询类型进行多维度数据查询。
如果要对结果集进行排序或者翻页，您可以使用排序和翻页功能来实现。具体操作，请参见排序和翻页。
如果要按照某一列对结果集做折叠，使对应类型的数据在结果展示中只出现一次，您可以使用折叠（去重）功能来实现。具体操作，请参见折叠（去重）。
如果要进行数据分析，例如求最值、求和、统计行数等，您可以使用Search接口的统计聚合功能或者SQL查询来实现。具体操作，请参见统计聚合和SQL查询。
如果要快速导出数据，而不关心整个结果集的顺序时，您可以使用ParallelScan接口和ComputeSplits接口实现多并发导出数据。具体操作，请参见并发导出数据。