Use Tablestore SDK for .NET to perform a match phrase query - Tablestore

A match phrase query is similar to a 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 column that you want to query is fuzzy tokenization, a match phrase query is performed at a lower latency than a wildcard query.

Prerequisites

An OTSClient instance is initialized. For more information, see Initialize an OTSClient instance.
A data table is created and data is written to the data table. For more information, see Create data tables and Write data.
A search index is created for the data table. For more information, see Create search indexes.

Parameters

Parameter	Description
FieldName	The name of the column that you want to query. The column can be of the TEXT type.
Text	The keyword that is used to match the value of the column when you perform a match phrase query. If the column that you want to query is of the TEXT type, the keyword is tokenized into multiple tokens based on the analyzer type that you specify when you create the search index. By default, single-word tokenization is performed if you do not specify the analyzer type when you create the search index. For example, if you perform a match phrase query by using the phrase "this is", query results such as "..., this is tablestore" and "this is a table" are returned. "this table is ..." and "is this a table" are not returned.
Query	The type of the query. Set this parameter to MatchPhraseQuery.
TableName	The name of the data table.
IndexName	The name of the search index.
GetTotalCount	Specifies whether to return the total number of rows that meet the query conditions. Default value: 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.
ColumnsToGet	Specifies whether to return all columns in the rows that meet the query conditions. You can specify the ReturnAll, Columns, and ReturnAllFromIndex parameters. The default value of ReturnAll is false, which specifies that not all columns are returned. You can use one of the following methods to specify the columns that you want to return. If you do not use the following methods to specify the columns that you want to return, only the primary key columns are returned. Configure Columns to specify the columns that you want to return. Set ReturnAllFromIndex to true to return all columns from the search index. If you set ReturnAll to true, all columns are returned.

Example

The following sample code shows how to query the rows in which the value of the Text_type_col column matches "Tablestore SearchIndex" in the data table.

/// <summary>
/// Query the rows in which the value of the Text_type_col column matches "Tablestore SearchIndex" in a data table and return the total number of rows that meet the query conditions. 
/// </summary>
/// <param name="otsClient"></param>
public static void MatchPhraseQuery(OTSClient otsClient)
{
    var searchQuery = new SearchQuery();
    // Set the query type to MatchPhraseQuery. 
    searchQuery.Query = new MatchPhraseQuery("Text_type_col", "Tablestore SearchIndex");
    // Return the total number of rows that meet the query conditions. 
    searchQuery.GetTotalCount = true;
    var request = new SearchRequest(TableName, IndexName, searchQuery);
    // You can configure the ColumnsToGet parameter to specify the columns that you want to return, specify that all columns are returned, or specify that all columns in the search index are returned. If you do not configure this parameter, only the primary key columns are returned. 
    request.ColumnsToGet = new ColumnsToGet()
    {
        // Return all columns in the search index. 
        ReturnAllFromIndex = true
        // Return the columns that you specify. 
        //Columns = new List<string>() { Long_type_col, Text_type_col, Keyword_type_col }
        // Return all columns in the rows that meet the query conditions. 
        //ReturnAll = true         
    };

    var response = otsClient.Search(request);

    Console.WriteLine("Total Count:" + response.TotalCount); // Display the total number of rows that meet the query conditions instead of the number of returned rows. 
}

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.
You can sort or paginate rows that meet the query conditions by using the sorting and paging features. For more information, see Sorting and paging.
You can use the collapse (distinct) feature to collapse the result set based on a specific column. 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, you can use the aggregation feature of the Search operation or execute SQL statements. For example, you can obtain the minimum and maximum values, sum, and total number of rows. For more information, see Aggregation and SQL query.
If you want to 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.