All Products
Search
Document Center

Tablestore:Range query

Last Updated:Aug 02, 2024

You can perform a range query to query data that falls within the specified range. If the type of the field that you want to query is TEXT, the field values are tokenized. A row meets the query conditions when at least one of the tokens in the row matches the query range.

Prerequisites

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.

Sample code

The following sample code provides an example on how to query the rows in which the value of the Col_Long column is greater than 3. Tablestore sorts the query results based on the value of the Col_Long column in descending order.

/**
 * Query the rows in which the value of the Col_Long column is greater than 3. Tablestore sorts these rows based on the values of the Col_Long column in descending order. 
 * @param client
 */
private static void rangeQuery(SyncClient client) {
    SearchQuery searchQuery = new SearchQuery();
    RangeQuery rangeQuery = new RangeQuery(); // Set the query type to RangeQuery. 
    rangeQuery.setFieldName("Col_Long");  // Set the name of the field that you want to match. 
    rangeQuery.greaterThan(ColumnValue.fromLong(3));  // Specify the range of the values of the column. The rows in which the value of the Col_Long column is greater than 3 are returned. 
    searchQuery.setGetTotalCount(true);
    searchQuery.setQuery(rangeQuery);
    // Sort the query results based on the values of the Col_Long column in descending order. 
    FieldSort fieldSort = new FieldSort("Col_Long");
    fieldSort.setOrder(SortOrder.DESC);
    searchQuery.setSort(new Sort(Arrays.asList((Sort.Sorter)fieldSort)));
    //searchQuery.setGetTotalCount(true); // Specify that the total number of matched rows is returned. 

    SearchRequest searchRequest = new SearchRequest("<TABLE_NAME>", "<SEARCH_INDEX_NAME>", searchQuery);
    // You can configure the columnsToGet parameter to specify the columns to return or specify that all columns are returned. If you do not configure this parameter, only the primary key columns are returned. 
    //SearchRequest.ColumnsToGet columnsToGet = new SearchRequest.ColumnsToGet();
    //columnsToGet.setReturnAll(true); // Specify that all columns are returned. 
    //columnsToGet.setColumns(Arrays.asList("ColName1","ColName2")); // Specify the columns that you want to return. 
    //searchRequest.setColumnsToGet(columnsToGet);

    SearchResponse resp = client.search(searchRequest);
    //System.out.println("TotalCount: " + resp.getTotalCount()); // Specify that the total number of matched rows instead of the number of returned rows is displayed. 
    System.out.println("Row: " + resp.getRows());
}

FAQ

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, geo query, Boolean query, KNN vector query, nested query, and exists query. You can use the query methods provided by the search index to query data from multiple dimensions based on your business requirements.

    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.