当数据查询的结果中含有某种类型的数据较多时,可以使用折叠(Collapse)功能按照某一列对结果集做折叠,使对应类型的数据在结果展示中只出现一次,保证结果展示中类型的多样性。
前提条件
注意事项
- 折叠功能只能使用offset+limit方式翻页,不能使用token方式。
- 对结果集同时使用统计聚合与折叠功能时,统计聚合功能只作用于使用折叠功能前的结果集。
- 使用折叠功能后,返回的总分组数取决于offset+limit的最大值,目前支持返回的总分组数最大为50000。
- 执行结果中返回的总行数是使用折叠功能前的匹配行数,使用折叠功能后的总分组数无法获取。
参数
参数 | 说明 |
---|---|
query | 任意Query类型。 |
collapse | 折叠参数设置,包含fieldName设置。 fieldName:列名,按该列对结果集做折叠,只支持应用于整型、浮点数和Keyword类型的列,不支持数组类型的列。 |
offset | 本次查询的开始位置。 |
limit | 本次查询需要返回的最大数量。 如果只为了获取行数,无需具体数据,可以设置limit=0,即不返回任意一行数据。 |
getTotalCount | 是否返回匹配的总行数,默认为false,表示不返回。 返回匹配的总行数会影响查询性能。 |
tableName | 数据表名称。 |
indexName | 多元索引名称。 |
columnsToGet | 是否返回所有列。
|
示例
let searchQuery = {
offset: 0,
limit: 100,
query: {
queryType: TableStore.QueryType.MATCH_ALL_QUERY,
},
collapse: {
fieldName: "col_keyword",
},
getTotalCount: false,
};
let params = {
tableName: tableName,
indexName: indexName,
searchQuery: searchQuery,
columnToGet: { //返回列设置,可设置为RETURN_SPECIFIED(自定义返回列)、RETURN_ALL(返回所有列)、RETURN_ALL_FROM_INDEX(返回多元索引中的所有列)、RETURN_NONE(不返回)。
returnType: TableStore.ColumnReturnType.RETURN_ALL_FROM_INDEX
},
timeoutMs: 30000,
}
client.search(params, function (err, data) {
if (err) {
console.log('search error:', err.toString());
} else {
console.log('search success:', data);
}
});