接口
范围查询的接口为Search或者ParallelScan,具体的Query类型为RangeQuery。
参数
参数 | 说明 |
fieldName | 要匹配的字段。 |
from | 起始位置的值。 设置范围条件时,大于(>)可以使用greaterThan表示,大于等于(>=)可以使用greaterThanOrEqual表示。 |
to | 结束位置的值。 设置范围条件时,小于(<)可以使用lessThan表示;小于等于(<=)可以使用lessThanOrEqual表示。 |
includeLower | 结果中是否需要包括from值,类型为Boolean。 |
includeUpper | 结果中是否需要包括to值,类型为Boolean。 |
query | 设置查询类型为RangeQuery。 |
sort | 按照指定方式排序,详情请参见排序和翻页。 |
getTotalCount | 是否返回匹配的总行数,默认为false,表示不返回。 返回匹配的总行数会影响查询性能。 |
tableName | 数据表名称。 |
indexName | 多元索引名称。 |
columnsToGet | 是否返回所有列,包含returnAll和columns设置。 returnAll默认为false,表示不返回所有列,此时可以通过columns指定返回的列;如果未通过columns指定返回的列,则只返回主键列。 当设置returnAll为true时,表示返回所有列。 |
使用方式
您可以使用控制台、命令行工具或者SDK进行范围查询。进行范围查询之前,您需要完成如下准备工作。
使用阿里云账号或者使用具有表格存储操作权限的RAM用户进行操作。如果需要为RAM用户授权表格存储操作权限,请参见通过RAM Policy为RAM用户授权进行配置。
使用SDK方式和命令行工具方式进行操作时,如果当前无可用AccessKey,则需要为阿里云账号或者RAM用户创建AccessKey。具体操作,请参见创建AccessKey。
已创建数据表。具体操作,请参见数据表操作。
已为数据表创建多元索引。具体操作,请参见创建多元索引。
使用SDK方式进行操作时,还需要完成初始化Client。具体操作,请参见初始化OTSClient。
使用命令行工具方式进行操作前,还需要完成下载并启动命令行工具,然后配置接入实例信息并选择要操作的表。具体操作,请参见下载命令行工具、启动并配置和数据表操作。
使用控制台
进入索引管理页签。
登录表格存储控制台。
在页面上方,选择资源组和地域。
在概览页面,单击实例名称或在操作列单击实例管理。
在实例详情页签下的数据表列表页签,单击数据表名称或在操作列单击索引管理。
在索引管理页签,单击目标多元索引操作列的搜索。
在查询数据对话框,查询数据。
系统默认返回所有列,如需显示指定属性列,关闭获取所有列并输入需要返回的属性列,多个属性列之间用半角逗号(,)隔开。
根据需要选择逻辑操作符为And、Or或者Not。
当选择逻辑操作符为And时,返回满足指定条件的数据。当选择逻辑操作符为Or时,如果配置了单个条件,则返回满足指定条件的数据;如果配置了多个条件,则返回满足任意一个条件的数据。当选择逻辑操作符为Not时,返回不满足指定条件的数据。
选择索引字段,单击添加。
设置索引字段的查询类型为范围查询(RangeQuery)和输入查询范围。
查询范围为左闭右开的区间,请根据需要配置。
系统默认关闭排序功能,如需根据指定字段对返回结果进行排序,打开是否排序开关后,根据需要添加要进行排序的字段并配置排序方式。
系统默认关闭统计功能,如需对指定字段进行数据统计,打开是否统计开关后,根据需要添加要进行统计的字段和配置统计信息。
单击确定。
符合查询条件的数据会显示在索引管理页签中。
使用命令行工具
通过命令行工具执行search
命令使用多元索引查询数据。更多信息,请参见多元索引。
执行search
命令使用search_index多元索引查询表中数据,并返回所有建立索引的列。
search -n search_index --return_all_indexed
根据系统提示输入查询条件,示例如下:
{
"Offset": -1,
"Limit": 10,
"Collapse": null,
"Sort": null,
"GetTotalCount": true,
"Token": null,
"Query": {
"Name": "RangeQuery",
"Query": {
"FieldName": "col_long",
"From": 1,
"To": 100,
"IncludeLower": true,
"IncludeUpper": false
}
}
}
使用SDK
您可以通过Java SDK、Go SDK、Python SDK、Node.js SDK、.NET SDK和PHP SDK使用范围查询。此处以Java SDK为例介绍范围查询的使用。
以下示例用于查询表中Col_Long列大于3的数据,结果按照Col_Long列的值逆序排序。
/**
* 查询表中Col_Long列大于3的数据,结果按照Col_Long列的值逆序排序。
* @param client
*/
private static void rangeQuery(SyncClient client) {
SearchQuery searchQuery = new SearchQuery();
RangeQuery rangeQuery = new RangeQuery(); //设置查询类型为RangeQuery。
rangeQuery.setFieldName("Col_Long"); //设置要匹配的字段。
rangeQuery.greaterThan(ColumnValue.fromLong(3)); //设置该字段的范围条件为大于3。
searchQuery.setGetTotalCount(true);
searchQuery.setQuery(rangeQuery);
//设置按照Col_Long列逆序排序。
FieldSort fieldSort = new FieldSort("Col_Long");
fieldSort.setOrder(SortOrder.DESC);
searchQuery.setSort(new Sort(Arrays.asList((Sort.Sorter)fieldSort)));
//searchQuery.setGetTotalCount(true); //设置返回匹配的总行数。
SearchRequest searchRequest = new SearchRequest("<TABLE_NAME>", "<SEARCH_INDEX_NAME>", searchQuery);
//通过设置columnsToGet参数可以指定返回的列或返回所有列,如果不设置此参数,则默认只返回主键列。
//SearchRequest.ColumnsToGet columnsToGet = new SearchRequest.ColumnsToGet();
//columnsToGet.setReturnAll(true); //设置为返回所有列。
//columnsToGet.setColumns(Arrays.asList("ColName1","ColName2")); //设置为返回指定列。
//searchRequest.setColumnsToGet(columnsToGet);
SearchResponse resp = client.search(searchRequest);
//System.out.println("TotalCount: " + resp.getTotalCount()); //打印匹配到的总行数,非返回行数。
System.out.println("Row: " + resp.getRows());
}
计费说明
使用VCU模式(原预留模式)时,使用多元索引查询数据会消耗VCU的计算资源。使用CU模式(原按量模式)时,使用多元索引查询数据会消耗读吞吐量。更多信息,请参见多元索引计量计费。
相关文档
多元索引查询类型包括精确查询、多词精确查询、全匹配查询、匹配查询、短语匹配查询、前缀查询、范围查询、通配符查询、模糊查询、多条件组合查询、地理位置查询、嵌套类型查询、向量检索和列存在性查询,您可以选择合适的查询类型进行多维度数据查询。
如果要对结果集进行排序或者翻页,您可以使用排序和翻页功能来实现。具体操作,请参见排序和翻页。
如果要按照某一列对结果集做折叠,使对应类型的数据在结果展示中只出现一次,您可以使用折叠(去重)功能来实现。具体操作,请参见折叠(去重)。
如果要进行数据分析,例如求最值、求和、统计行数等,您可以使用Search接口的统计聚合功能或者SQL查询来实现。具体操作,请参见统计聚合和SQL查询。
如果要快速导出数据,而不关心整个结果集的顺序时,您可以使用ParallelScan接口和ComputeSplits接口实现多并发导出数据。具体操作,请参见并发导出数据。