全部产品
Search
文档中心

表格存储:范围查询

更新时间:Jul 22, 2024

RangeQuery根据范围条件查询表中的数据。对于Text类型字段,只要Text类型字段值分词后的词条中有词条满足范围条件即可。

前提条件

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

参数

参数

说明

table_name

数据表名称。

index_name

多元索引名称。

offset

本次查询的开始位置。

limit

本次查询需要返回的最大数量。

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

get_total_count

是否返回匹配的总行数,默认为False,表示不返回。

返回匹配的总行数会影响查询性能。

query_type

设置查询类型为QueryTypeConst::RANGE_QUERY

field_name

要匹配的字段。

range_from

起始位置的值。

range_to

结束位置的值。

include_lower

结果中是否需要包括range_from值,类型为Boolean。

include_upper

结果中是否需要包括range_to值,类型为Boolean。

sort

按照指定方式排序。更多信息,请参见排序和翻页

columns_to_get

是否返回所有列,包含return_type和column_names设置。

  • 当设置return_type为ColumnReturnTypeConst::RETURN_SPECIFIED时,可以通过return_names指定返回的列。
  • 当设置return_type为ColumnReturnTypeConst::RETURN_ALL时,表示返回所有列。
  • 当设置return_type为ColumnReturnTypeConst::RETURN_ALL_FROM_INDEX时,表示返回多元索引中的所有列。
  • 当设置return_type为ColumnReturnTypeConst::RETURN_NONE时,表示不返回所有列,只返回主键列。

示例

以下示例用于查询表中long列大于等于100但小于101的数据,结果按照keyword列的值升序排序。

$request = array(
    'table_name' => 'php_sdk_test',
    'index_name' => 'php_sdk_test_search_index',
    'search_query' => array(
        'offset' => 0,
        'limit' => 2,
        'get_total_count' => true,
        'query' => array(
            'query_type' => QueryTypeConst::RANGE_QUERY,
            'query' => array(
                'field_name' => 'long',
                'range_from' => 100,
                'include_lower' => true,
                'range_to' => 101,
                'include_upper' => false
            )
        ),
        'sort' => array(
            array(
                'field_sort' => array(
                    'field_name' => 'keyword',
                    'order' => SortOrderConst::SORT_ORDER_ASC
                )
            ),
        )
    ),
    'columns_to_get' => array(
        'return_type' => ColumnReturnTypeConst::RETURN_SPECIFIED,
        'return_names' => array('double', 'long', 'keyword')
    )
);
$response = $otsClient->search($request);

常见问题

相关文档