Use Tablestore SDK for PHP to perform a match phrase query - Tablestore

A match phrase query is similar to match query, except that a match phrase query evaluates the positions of tokens. A row meets the query condition only when the order and positions of the tokens in the row match the order and positions of the tokens that are contained in the keyword. If the tokenization method for the field that you want to query is fuzzy tokenization, match phrase query is performed at a lower latency than wildcard query.

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 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. Default value: false. The value of false 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 match phrase query, set this parameter to `QueryTypeConst::MATCH_PHRASE_QUERY`.
field_name	The name of the field that you want to match. Match phrase query applies to TEXT fields.
text	The keyword that is used to match the value of the field when you perform a match phrase query. If the field that you want to match is a TEXT field, the keyword is tokenized into multiple tokens based on the analyzer type that you specify when you create the search index. If you do not specify the analyzer type when you create the search index, single-word tokenization is performed. For example, if you perform a match phrase query by using the phrase "this is", "..., this is tablestore" and "this is a table" are returned. "this table is ..." or "is this a table" is not returned.
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. If you set the return_type parameter to `ColumnReturnTypeConst::RETURN_SPECIFIED`, you can use return_names to specify the columns that you want to return. If you set the return_type parameter to `ColumnReturnTypeConst::RETURN_ALL`, all columns are returned. If you set the return_type parameter to `ColumnReturnTypeConst::RETURN_ALL_FROM_INDEX`, all columns in the search index are returned. If you set the return_type parameter to `ColumnReturnTypeConst::RETURN_NONE`, only the primary key columns are returned.

Examples

The following sample code provides an example on how to use match phrase query to query the rows in which the value of the text column matches "text 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::MATCH_PHRASE_QUERY,
            'query' => array(
                'field_name' => 'text',
                'text' => 'text keyword'
            )
        ),
        '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('text')
    )
);
$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.