All Products
Search
Document Center

Tablestore:Range query

Last Updated:Aug 05, 2024

You can perform a range query to query data that falls within the specified range. If the type of a field 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

TableName

The name of the data table.

IndexName

The name of the search index.

Query

The type of the query. Set the query type to RangeQuery.

FieldName

The name of the field that you want to match.

From

The value from which the query starts.

You can use GT or GTE to specify a range. GT indicates that the values within the range are greater than the specified value. GTE indicates that the values within the range are greater than or equal to the specified value.

To

The value to which the query ends.

You can use LT or LTE to specify a range. LT indicates that the values within the range are smaller than the specified value. LTE indicates that the values within the range are smaller than or equal to the specified value.

IncludeLower

Specifies whether to include the value of the From parameter in the response. The value of this parameter is of the BOOLEAN data type.

IncludeUpper

Specifies whether to include the value of the To parameter in the response. The value of this parameter is of the BOOLEAN data type.

Sort

The sorting method. For more information, see Perform sorting and paging.

ColumnsToGet

Specifies whether to return all columns of each row that meets the query conditions. You can specify the ReturnAll and Columns parameters.

By default, the ReturnAll parameter is set to false, which indicates that not all columns are returned. If the ReturnAll parameter is set to false, you can use the Columns parameter to specify the columns that you want to return. If you do not specify the Columns parameter, only the primary key columns are returned.

If you set ReturnAll 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 Col_Long 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 in a table. Tablestore sorts the query results based on the value of the Col_Long column in descending order. 
 */
func RangeQuery(client *tablestore.TableStoreClient, tableName string, indexName string) {
    searchRequest := &tablestore.SearchRequest{}
    searchRequest.SetTableName(tableName)
    searchRequest.SetIndexName(indexName)
    searchQuery := search.NewSearchQuery()
    rangeQuery := &search.RangeQuery{} // Set the query type to RangeQuery. 
    rangeQuery.FieldName = "Col_Long" // Specify the name of the column that you want to query.
    rangeQuery.GT(3) // Specify the range of the column value, which is greater than 3. 
    searchQuery.SetQuery(rangeQuery)
    // Sort the query results based on the value of the Col_Long column in descending order. 
    searchQuery.SetSort(&search.Sort{
        []search.Sorter{
            &search.FieldSort{
                FieldName: "Col_Long",
                Order:     search.SortOrder_DESC.Enum(),
            },
        },
    })
    searchRequest.SetSearchQuery(searchQuery)
    searchRequest.SetColumnsToGet(&tablestore.ColumnsToGet{
        ReturnAll:true,
    })
    searchResponse, err := client.Search(searchRequest)
    if err != nil {
        fmt.Printf("%#v", err)
        return
    }
    fmt.Println("IsAllSuccess: ", searchResponse.IsAllSuccess) // Check whether all rows that meet the query conditions are returned. 
    fmt.Println("RowCount: ", len(searchResponse.Rows))
    for _, row := range searchResponse.Rows {
        jsonBody, err := json.Marshal(row)
        if err != nil {
            panic(err)
        }
        fmt.Println("Row: ", string(jsonBody))
    }
}

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