A term query returns rows whose field values exactly match the specified keyword. The keyword is not analyzed—Tablestore compares it as-is against indexed values. For TEXT columns, Tablestore matches the keyword against each token in the column; a row matches if at least one token equals the keyword.
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. For more information, see Create a data table and Write data.
-
A search index is created for the data table. For more information, see Create a search index.
Warning: Do not use a term query on TEXT columns when you want to match the original string. Tablestore tokenizes TEXT column values at index time, so stored tokens may not match your original string. Use a match query instead when querying TEXT columns by their full content.
Parameters
|
Parameter |
Description |
|
table_name |
The name of the data table. |
|
index_name |
The name of the search index. |
|
offset |
The starting position in the result set for the current query. |
|
limit |
The maximum number of rows to return. To get only the row count without returning row data, set this to 0. |
|
get_total_count |
Specifies whether to return the total number of rows that match the query. Default value: false. Setting this to true reduces query performance. |
|
query_type |
The query type. Set this to |
|
field_name |
The name of the field to query. |
|
term |
The keyword to match against field values. The keyword is not tokenized—Tablestore uses it as-is for comparison. For TEXT columns, Tablestore tokenizes the column value at index time and checks whether any token exactly equals the keyword. For example, the TEXT value |
|
sort |
The sort order for returned rows. For more information, see Sorting and paging. |
|
columns_to_get |
The columns to return for each matching row. Configure return_type and return_names for this parameter.
|
Examples
The following example queries all rows where the keyword column exactly matches the term "keyword".
$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::TERM_QUERY,
'query' => array(
'field_name' => 'keyword',
'term' => 'keyword'
)
),
'sort' => array(
array(
'field_sort' => array(
'field_name' => 'keyword',
'order' => SortOrderConst::SORT_ORDER_ASC
)
),
)
),
'columns_to_get' => array(
'return_type' => ColumnReturnTypeConst::RETURN_ALL,
'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.