Parameters
Parameter | Description |
fieldName | The name of the field that you want to match. |
from | The value from which the query starts. When you specify range conditions, you can use greaterThan to specify the greater than (>) sign and greaterThanOrEqual to specify the greater than or equal to (≥) sign. |
to | The value at which the query ends. When you specify range conditions, you can use lessThan to specify the less than (<) sign and lessThanOrEqual to specify the less than or equal to (≤) sign. |
includeLower | Specifies whether to include the value of the from parameter in the response. Type: BOOLEAN. |
includeUpper | Specifies whether to include the value of the to parameter in the response. Type: BOOLEAN. |
query | The type of the query. Set the query parameter to RangeQuery. |
sort | The sorting method. For more information, see Perform sorting and paging. |
getTotalCount | Specifies whether to return the total number of rows that meet the query conditions. The default value of this parameter is false, which specifies that the total number of rows that meet the query conditions is not returned. If you set this parameter to true, the query performance is compromised. |
tableName | The name of the data table. |
indexName | The name of the search index. |
columnsToGet | Specifies whether to return all columns of each row that meets the query conditions. You can specify the returnAll and columns fields for this parameter. The default value of the returnAll field is false, which specifies that not all columns are returned. In this case, you can use the columns field to specify the columns that you want to return. If you do not specify the columns that you want to return, only the primary key columns are returned. If you set the returnAll field to true, all columns are returned. |
Methods
You can use the Tablestore console, Tablestore CLI, or Tablestore SDKs to perform a range query. Before you perform a range query, make sure that the following preparations are made:
You have an Alibaba Cloud account or a RAM user that has permissions to perform operations on Tablestore. For information about how to grant Tablestore operation permissions to a RAM user, see Use a RAM policy to grant permissions to a RAM user.
If you want to use Tablestore SDKs or the Tablestore CLI to perform a query, an AccessKey pair is created for your Alibaba Cloud account or RAM user. For more information, see Create an AccessKey pair.
A data table is created. For more information, see Operations on tables.
A search index is created for the data table. For more information, see Create a search index.
If you want to use Tablestore SDKs to perform a query, an OTSClient instance is initialized. For more information, see Initialize an OTSClient instance.
If you want to use the Tablestore CLI to perform a query, the Tablestore CLI is downloaded and started, and information about the instance that you want to access and the data table are configured. For more information, see Download the Tablestore CLI, Start the Tablestore CLI and configure access information, and Operations on data tables.
Use the Tablestore console
Go to the Indexes tab.
Log on to the Tablestore console.
In the top navigation bar, select a resource group and a region.
On the Overview page, click the name of the instance that you want to manage or click Manage Instance in the Actions column of the instance.
On the Tables tab of the Instance Details tab, click the name of the data table or click Indexes in the Actions column of the data table.
On the Indexes tab, find the search index that you want to use to query data and click Manage Data in the Actions column.
In the Search dialog box, specify query conditions.
By default, the system returns all attribute columns. To return specific attribute columns, turn off All Columns and specify the attribute columns that you want to return. Separate multiple attribute columns with commas (,).
Note By default, the system returns all primary key columns of the data table.
Select the And, Or, or Not logical operator based on your business requirements.
If you select the And logical operator, data that meets the query conditions is returned. If you select the Or operator and specify a single query condition, data that meets the query condition is returned. If you select the Or logical operator and specify multiple query conditions, data that meets one of the query conditions is returned. If you select the Not logical operator, data that does not meet the query conditions is returned.
Select a field and click Add.
Set the Query Type parameter to RangeQuery(RangeQuery) and specify the range that you want to query.
The range is a left-closed, right-open interval. Specify the range based on your business requirements.
By default, the sorting feature is disabled. If you want to sort the query results based on specific fields, turn on Sort and specify the fields based on which you want to sort the query results and the sorting order.
By default, the aggregation feature is disabled. If you want to collect statistics on a specific field, turn on Collect Statistics, specify the field based on which you want to collect statistics, and then configure the information that is required to collect statistics.
Click OK.
Data that meets the query conditions is displayed in the specified order on the Indexes tab.
Use the Tablestore CLI
You can run the search
command in the Tablestore CLI to query data by using search indexes. For more information, see Search index.
Run the search
command to use the search_index search index to query data and return all indexed columns of each row that meets the query conditions.
search -n search_index --return_all_indexed
Enter the query conditions as prompted by the system:
{
"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
}
}
}
Use Tablestore SDKs
You can perform a range query by using the following Tablestore SDKs: Tablestore SDK for Java, Tablestore SDK for Go, Tablestore SDK for Python, Tablestore SDK for Node.js, Tablestore SDK for .NET, and Tablestore SDK for PHP. In this example, Tablestore SDK for Java is used.
private static void rangeQuery(SyncClient client) {
SearchQuery searchQuery = new SearchQuery();
RangeQuery rangeQuery = new RangeQuery(); // Set the query type to RangeQuery.
/**
* Example 1: Query the rows in which the value of the Col_Long column is greater than 3.
*/
rangeQuery.setFieldName("Col_Long");
rangeQuery.greaterThan(ColumnValue.fromLong(3));
/**
* //Example 2: Query the rows in which the value of the Col_Date_String column is greater than or equal to 2020-01-01 10:55:12 and less than 2021-03-03 08:20:50.
* //The type of the Col_Date_String column is String in the data table and Date in the search index to which the data table is mapped. The values of the Col_Date_String column in the search index are in the yyyy-MM-dd HH:mm:ss format.
* rangeQuery.setFieldName("Col_Date_String");
* rangeQuery.greaterThanOrEqual(ColumnValue.fromString("2020-01-01 10:55:12"));
* rangeQuery.lessThan(ColumnValue.fromString("2021-03-03 08:20:50"));
*/
/**
* //Example 3: Query the rows in which the value of the Col_Date_Long column is greater than 1731036722.
* //The type of the Col_Date_Long column is Integer in the data table and Date in the search index to which the data table is mapped. The values of the Col_Date_Long column in the search index are timestamps in seconds.
* rangeQuery.setFieldName("Col_Date_Long");
* rangeQuery.greaterThan(ColumnValue.fromLong(1731036722));
*/
searchQuery.setQuery(rangeQuery);
searchQuery.setGetTotalCount(true); // Specify that the total number of rows that meet the query condition is returned.
SearchRequest searchRequest = new SearchRequest("<TABLE_NAME>", "<SEARCH_INDEX_NAME>", searchQuery);
//Configure the columnsToGet parameter to specify that specific columns or all columns are returned. If you do not configure the columnsToGet parameter, only the primary key columns are returned.
//SearchRequest.ColumnsToGet columnsToGet = new SearchRequest.ColumnsToGet();
// Specify that all columns are returned.
//columnsToGet.setReturnAll(true);
// Specify that specific columns are returned.
//columnsToGet.setColumns(Arrays.asList("ColName1","ColName2"));
//searchRequest.setColumnsToGet(columnsToGet);
SearchResponse resp = client.search(searchRequest);
//System.out.println("TotalCount: " + resp.getTotalCount());// Display the total number of matched rows instead of the number of returned rows is returned.
System.out.println("Row: " + resp.getRows());
}
Billing rules
When you use a search index to query data, you are charged for the read throughput that is consumed. For more information, see Billable items of search indexes.
References
When you use a search index to query data, you can use the following query methods: term query, terms query, match all query, match query, match phrase query, prefix query, range query, wildcard query, fuzzy query, Boolean query, geo query, nested query, KNN vector query, and exists query. You can select query methods based on your business requirements to query data from multiple dimensions.
You can sort or paginate rows that meet the query conditions by using the sorting and paging features. For more information, see Perform sorting and paging.
You can use the collapse (distinct) feature to collapse the result set based on a specific column. This way, data of the specified type appears only once in the query results. For more information, see Collapse (distinct).
If you want to analyze data in a data table, you can use the aggregation feature of the Search operation or execute SQL statements. For example, you can obtain the minimum and maximum values, sum, and total number of rows. For more information, see Aggregation and SQL query.
If you want to obtain all rows that meet the query conditions without the need to sort the rows, you can call the ParallelScan and ComputeSplits operations to use the parallel scan feature. For more information, see Parallel scan.