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

前提条件

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

参数

参数 说明
field_name 要匹配的字段。
range_from 起始位置的值。
range_to 结束位置的值。
include_lower 结果中是否需要包括range_from值，类型为Boolean。
include_upper 结果中是否需要包括range_to值，类型为Boolean。
table_name 数据表名称。
index_name 多元索引名称。
query 设置查询类型为RangeQuery。
limit 本次查询需要返回的最大数量。

如果只为了获取行数，无需获取具体数据，可以设置limit=0，即不返回任意一行数据。
get_total_count 是否返回匹配的总行数，默认为False，表示不返回。

返回匹配的总行数会影响查询性能。
columns_to_get 是否返回所有列，包含return_type和column_names设置。
  • 当设置return_type为ColumnReturnType.SPECIFIED时，可以通过column_names指定返回的列。
  • 当设置return_type为ColumnReturnType.ALL时，表示返回所有列。
  • 当设置return_type为ColumnReturnType.NONE时，表示不返回所有列，只返回主键列。

示例

查询表中k列的值在'key100'到'key200'之间的数据。

  • 5.2.1及之后版本
    使用5.2.1及之后的SDK版本时，默认的返回结果为SearchResponse对象，请求示例如下：
    query = RangeQuery('k', 'key100', 'key200', include_lower=False, include_upper=False)
search_response = client.search(
    table_name, index_name, 
    SearchQuery(query, limit=100, get_total_count=True), 
    ColumnsToGet(return_type=ColumnReturnType.ALL)
)
    如果需要返回Tuple类型结果，您可以使用如下请求示例实现。
    query = RangeQuery('k', 'key100', 'key200', include_lower=False, include_upper=False)
rows, next_token, total_count, is_all_succeed, agg_results, group_by_results = client.search(
    table_name, index_name, 
    SearchQuery(query, limit=100, get_total_count=True), 
    ColumnsToGet(return_type=ColumnReturnType.ALL)
).v1_response()
  • 5.2.1之前版本

    使用5.2.1之前的SDK版本时，默认的返回结果为Tuple类型，请求示例如下：

    query = RangeQuery('k', 'key100', 'key200', include_lower=False, include_upper=False)
rows, next_token, total_count, is_all_succeed = client.search(
    table_name, index_name, 
    SearchQuery(query, limit=100, get_total_count=True), 
    ColumnsToGet(return_type=ColumnReturnType.ALL)
)