当数据查询的结果中含有某种类型的数据较多时,可以使用折叠(Collapse)功能按照某一列对结果集做折叠,使对应类型的数据在结果展示中只出现一次,保证结果展示中类型的多样性。
前提条件
注意事项
- 折叠功能只能使用Offset+Limit方式翻页,不能使用Token方式。
- 对结果集同时使用统计聚合与折叠功能时,统计聚合功能只作用于使用折叠功能前的结果集。
- 使用折叠功能后,返回的总分组数取决于Offset+Limit的最大值,目前支持返回的总分组数最大为50000。
- 执行结果中返回的总行数是使用折叠功能前的匹配行数,使用折叠功能后的总分组数无法获取。
参数
参数 | 说明 |
---|---|
TableName | 数据表名称。 |
IndexName | 多元索引名称。 |
Query | 可以是任意Query类型。 |
Collapse | 折叠参数设置,包含FieldName设置。 FieldName:列名,按该列对结果集做折叠,只支持应用于整型、浮点数和Keyword类型的列,不支持数组类型的列。 |
Offset | 本次查询的开始位置。 |
Limit | 本次查询需要返回的最大数量。 如果只为了获取行数,无需具体数据,可以设置Limit=0,即不返回任意一行数据。 |
示例
/// <summary>
/// 根据"pk0"列对结果集做折叠。
/// </summary>
/// <param name="otsClient"></param>
public static void UseCollapse(OTSClient otsClient)
{
MatchAllQuery matchAllQuery = new MatchAllQuery();
Collapse collapse = new Collapse();
collapse.FieldName = "pk0";
SearchQuery searchQuery = new SearchQuery();
searchQuery.Query = matchAllQuery;
searchQuery.Collapse = collapse;
SearchRequest searchRequest = new SearchRequest(TableName, IndexName, searchQuery);
SearchResponse searchResponse = otsClient.Search(searchRequest);
foreach (Row row in searchResponse.Rows)
{
Console.WriteLine(JsonConvert.SerializeObject(row));
}
}