You can use range query to query data that falls within a specified range. If the type of a field is TEXT, Tablestore tokenizes the string and matches any of the tokens that fall within the specified range.

Prerequisites

  • The OTSClient instance is initialized. For more information, see Initialization.
  • A data table is created and data is written to the table.
  • A search index is created for the table. For more information, see Create search indexes.

Parameters

Parameter Description
field_name The name of the field used to match the query conditions.
range_from The value from which the query starts.
range_to The value with which the query ends.
include_lower Specifies whether to include the value of range_from in the response. The parameter is of the Boolean type.
include_upper Specifies whether to include the value of range_to in the response. The parameter is of the Boolean type.
table_name The name of the table.
index_name The name of the search index.
query The query type. To use range query, set this parameter to RangeQuery.
limit The maximum number of rows that the current query returns.

To query just the number of matched rows without any detailed data, you can set limit to 0. In this case, Tablestore returns the number of matched rows without data from the table.

get_total_count Specifies whether to return the total number of rows that match the query conditions. By default, this parameter is set to False, which indicates that the total number of rows that match the query conditions is not returned.

Query performance is affected when this parameter is set to True.

columns_to_get Specifies whether to return all columns of each matched row. You can configure return_type and column_names for this parameter.
  • If you set return_type to ColumnReturnType.SPECIFIED, you can use column_names to specify the columns to return.
  • If you set return_type to ColumnReturnType.ALL, all columns are returned.
  • If you set return_type to ColumnReturnType.NONE, only the primary key columns are returned.

Examples

Use range query to query the rows whose k column values range from 'key100' to 'key200'.

  • Perform range query by using Tablestore SDK for Python V5.2.1 or later
    By default, if you use Tablestore SDK for Python V5.2.1 or later to perform a range query, SearchResponse objects are returned. The following code provides a request sample:
    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)
    )
    You can use the following sample request to return results of the Tuple type:
    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()
  • Perform range query by using Tablestore SDK for Python of a version earlier than 5.2.1

    By default, if you use Tablestore SDK for Python of a version earlier than 5.2.1 to perform a range query, results of the Tuple type are returned. The following code provides a request sample:

    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)
    )