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
- An OTSClient instance is initialized. For more information, see Initialize an OTSClient instance.
- A data table is created. Data is written to the table.
- A search index is created for the data table. For more information, see Create a search index.
Parameters
Parameter | Description |
table_name | The name of the data table. |
index_name | The name of the search index. |
offset | The position from which the current query starts. |
limit | The maximum number of rows that you want the current query to return. To query only the number of rows that meet the query conditions without querying specific data of the rows, set this parameter to 0. |
get_total_count | 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_type | The query type. To use range query, set this parameter to |
field_name | The name of the field that you want to match. |
range_from | The value from which the query starts. |
range_to | The value at which the query ends. |
include_lower | Specifies whether to include the value of the range_from parameter in the response. The value of this parameter is of the Boolean type. |
include_upper | Specifies whether to include the value of the range_to parameter in the response. The value of this parameter is of the Boolean type. |
sort | The method that you want to use to sort the rows in the response. For more information, see Sorting and paging. |
columns_to_get | Specifies whether to return all columns of each row that meets the query conditions. You can configure the return_type and column_names fields for this parameter.
|
Examples
The following sample code provides an example on how to query the rows in which the value of the long column is greater than or equal to 100 but less than 101. In this example, the rows in the response is sorted in ascending order based on the value of the keyword column.
$request = array(
'table_name' => 'php_sdk_test',
'index_name' => 'php_sdk_test_search_index',
'search_query' => array(
'offset' => 0,
'limit' => 2,
'get_total_count' => true,
'query' => array(
'query_type' => QueryTypeConst::RANGE_QUERY,
'query' => array(
'field_name' => 'long',
'range_from' => 100,
'include_lower' => true,
'range_to' => 101,
'include_upper' => false
)
),
'sort' => array(
array(
'field_sort' => array(
'field_name' => 'keyword',
'order' => SortOrderConst::SORT_ORDER_ASC
)
),
)
),
'columns_to_get' => array(
'return_type' => ColumnReturnTypeConst::RETURN_SPECIFIED,
'return_names' => array('double', 'long', 'keyword')
)
);
$response = $otsClient->search($request);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.
If you want to sort or paginate the rows that meet the query conditions, you can use the sorting and paging feature. For more information, see Sorting and paging.
If you want to collapse the result set based on a specific column, you can use the collapse (distinct) feature. 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, such as obtaining the extreme values, sum, and total number of rows, you can perform aggregation operations or execute SQL statements. For more information, see Aggregation and SQL query.
If you want to quickly 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.