当数据查询的结果中含有某种类型的数据较多时,可以使用折叠(Collapse)功能按照某一列对结果集做折叠,使对应类型的数据在结果展示中只出现一次,保证结果展示中类型的多样性。

前提条件

  • 已初始化Client,详情请参见初始化
  • 已创建数据表并写入数据。
  • 已在数据表上创建多元索引,详情请参见创建多元索引

注意事项

  • 折叠功能只能使用Offset+Limit方式翻页,不能使用Token方式。
  • 对结果集同时使用统计聚合与折叠功能时,统计聚合功能只作用于使用折叠功能前的结果集。
  • 使用折叠功能后,返回的总分组数取决于Offset+Limit的最大值,目前支持返回的总分组数最大为10000。
  • 执行结果中返回的总行数是使用折叠功能前的匹配行数,使用折叠功能后的总分组数无法获取。

参数

参数 说明
TableName 数据表名称。
IndexName 多元索引名称。
Query 可以是任意Query类型。
Collapse 折叠参数设置,包含FieldName设置。

FieldName:列名,按该列对结果集做折叠,只支持应用于整型、浮点数和Keyword类型的列,不支持数组类型的列。

Offset 本次查询的开始位置。
Limit 本次查询需要返回的最大数量。

如果只为了获取行数,无需具体数据,可以设置Limit=0,即不返回任意一行数据。

示例

func QueryWithCollapse(client *tablestore.TableStoreClient, tableName string, indexName string) {
    searchRequest := &tablestore.SearchRequest{}
    searchRequest.SetTableName(tableName)       //设置数据表名称。
    searchRequest.SetIndexName(indexName)       //设置多元索引名称。

    searchQuery := search.NewSearchQuery()
    searchQuery.SetQuery(&search.MatchQuery{    //构造查询条件。
        FieldName:          "user_id",
        Text:               "00002",
    })
    searchQuery.SetCollapse(&search.Collapse{
        FieldName: "product_name",              //根据"product_name"列对结果集做折叠。

    })
    searchQuery.SetOffset(0)
    searchQuery.SetLimit(100)
    searchRequest.SetColumnsToGet(&tablestore.ColumnsToGet{ReturnAll:true}) //设置为返回所有列。
    searchRequest.SetSearchQuery(searchQuery)

    searchResponse, err := client.Search(searchRequest)   //查询。
    if err != nil {
        fmt.Println("Failed to search with error:", err)
        return
    }
    for _, row := range searchResponse.Rows {           //打印本次返回的行。
        jsonBody, err := json.Marshal(row)
        if err != nil {
            panic(err)
        }
        fmt.Println("Row: ", string(jsonBody))
    }
}