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

前提条件

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

注意事项

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

参数

参数 说明
table_name 数据表名称。
index_name 多元索引名称。
query 可以是任意Query类型。
collapse 折叠参数设置,包含field_name设置。

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

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

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

示例

$request = array(
    'table_name' => 'php_sdk_test',
    'index_name' => 'php_sdk_test_search_index',
    'search_query' => array(
        'offset' => 0,
        'limit' => 10,
        'get_total_count' => true,
        'collapse' => array(
            'field_name' => 'keyword'
        ),
        'query' => array(
            'query_type' => QueryTypeConst::MATCH_ALL_QUERY
        ),
//        'sort' => array(//如果需要特定排序。
//            array(
//                'field_sort' => array(
//                    'field_name' => 'keyword',
//                    'order' => SortOrderConst::SORT_ORDER_ASC
//                )
//            ),
//        ),
        'token' => null,
    ),
    'columns_to_get' => array(
        'return_type' => ColumnReturnTypeConst::RETURN_SPECIFIED,
        'return_names' => array('col1', 'col2')
    )
);
$response = $otsClient->search($request);