A terms query is similar to a term query except that a terms query supports multiple terms. A row of data is returned if at least one of the keywords matches the value of the specified column. Terms queries can be used in the same manner as the IN operator in SQL statements.
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 the limit parameter to 0. |
get_total_count | Specifies whether to return the total number of rows that meet the query conditions. Default value: 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 type of the query. Set this parameter to |
field_name | The name of the column that you want to query. |
terms | The keywords that are used to match the value of the column when you perform a terms query. A row of data is returned if at least one of the keywords matches the value of the column. |
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 in the rows that meet the query conditions. You can specify the return_type and return_names parameters.
|
Example
The following sample code shows how to query the rows in which the value of the keyword column is "keyword" or "php" in the data table.
$request = array(
'table_name' => 'php_sdk_test',
'index_name' => 'php_sdk_test_search_index',
'search_query' => array(
'offset' => 0,
'limit' => 5,
'get_total_count' => true,
'query' => array(
'query_type' => QueryTypeConst::TERMS_QUERY,
'query' => array(
'field_name' => 'keyword',
'terms' => array(
"keyword",
"php"
)
)
),
'sort' => array(
array(
'field_sort' => array(
'field_name' => 'long',
'order' => SortOrderConst::SORT_ORDER_DESC,
'mode' => SortModeConst::SORT_MODE_AVG
)
)
)
),
'columns_to_get' => array(
'return_type' => ColumnReturnTypeConst::RETURN_SPECIFIED,
'return_names' => array('keyword', 'long')
)
);
$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.