All Products
Search
Document Center

Tablestore:Range query

Last Updated:Aug 19, 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

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.

Query

The query type. To use range query, set this parameter to RangeQuery.

FieldName

The name of the field that you want to match.

From

The value from which the query starts.

To

The value at which the query ends.

IncludeLower

Specifies whether to include the rows in which the value of the column that you want to match is equal to the value of the From parameter in the response. The value type of this parameter is Boolean.

IncludeUpper

Specifies whether to include the rows in which the value of the column that you want to match is equal to the value of the To parameter in the response. The value type of this parameter is Boolean.

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 configure ReturnAll, Columns, and ReturnAllFromIndex for this parameter.

The default value of ReturnAll is false, which indicates that not all columns are returned. You can use one of the following methods to specify the columns that you want to return. If you do not use the following methods to specify the columns that you want to return, only the primary key columns are returned.
  • Configure Columns to specify the columns that you want to return.
  • Set ReturnAllFromIndex to true to return all columns from the search index.

If you set ReturnAll to true, all columns are returned.

Examples

The following sample code provides an example on how to query the rows in which the value of the Long_type_col column is greater than or equal to 0 and less than 6. In this example, the total number of rows that meet the query conditions is returned.

/// <summary>
/// Search the table for rows in which the value of the Long_type_col column is greater than or equal to 0 and less than 6. 
/// </summary>
/// <param name="otsClient"></param>
public static void RangeQuery(OTSClient otsClient)
{
    var searchQuery = new SearchQuery();
    // Specify that the total number of rows that meet the query conditions is returned. 
    searchQuery.GetTotalCount = true;
    var rangeQuery = new RangeQuery(Long_type_col, new ColumnValue(0), new ColumnValue(6));
    // Specify that the rows in which the value of the column that you want to match is equal to the value of the From parameter are included in the response. 
    rangeQuery.IncludeLower = true;
    searchQuery.Query = rangeQuery;
    var request = new SearchRequest(TableName, IndexName, searchQuery);
    // You can configure the ColumnsToGet parameter to specify the columns that you want to return, specify that all columns are returned, or specify that all columns in the search index are returned. If you do not configure this parameter, only the primary key columns are returned. 
    request.ColumnsToGet = new ColumnsToGet()
    {
        // Specify that all columns in the search index are returned. 
        ReturnAllFromIndex = true
        // Specify the columns that you want to return. 
        //Columns = new List<string>() { Long_type_col, Text_type_col, Keyword_type_col }
        // Specify that all columns are returned. 
        //ReturnAll = true
    };

    var response = otsClient.Search(request);

    Console.WriteLine("Total Count:" + response.TotalCount); // Specify that the total number of rows that meet the query conditions instead of the number of rows that are returned is displayed. 
}

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, Boolean query, geo query, nested query, and exists query. You can use different query methods 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 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.