You can perform a prefix query to query data that matches the specified prefix. If the column that is used to match the prefix condition is a TEXT column, the column is tokenized. A row meets the query conditions when at least one token contains the specified prefix.
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. Default value: false. The value of false specifies that the total number of rows that meet the query conditions is not returned. If this parameter is set to true, the query performance is compromised. |
query_type | The query type. To use prefix query, set this parameter to |
field_name | The name of the column that you want to query. |
prefix | The prefix. If the column used to match the prefix condition is a TEXT column, the column is 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
The following sample code shows how to query all rows that contain the prefix "key" in the keyword column in a data table.
$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);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.