You can use prefix query to query data that matches a specified prefix. If the type of a field is TEXT, Tablestore tokenizes the string and matches tokens by using the specified prefix.
Prerequisites
- An OTSClient instance is initialized. For more information, see Initialization.
- 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 search indexes.
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 returning specific data, you can set limit to 0. This way, Tablestore returns the number of rows that meet the query conditions without specific data from the table. |
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 indicates 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 prefix query, set this parameter to QueryTypeConst::PREFIX_QUERY . |
field_name | The name of the field that you want to match. |
prefix | The prefix. If the field used to match the prefix is a TEXT field, the field values are tokenized. A row meets the query conditions when at least one token contains the specified prefix. |
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 return_type and return_names for this parameter.
|
Examples
$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::PREFIX_QUERY,
'query' => array(
'field_name' => 'keyword',
'prefix' => 'key'
)
),
'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')
)
);
$response = $otsClient->search($request);