Perform a match phrase query by using Tablestore SDK for Node.js - 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 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 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 a search index.

Parameters

Parameter	Description
tableName	The name of the data table.
indexName	The name of the search index.
offset	The position from which the query starts.
limit	The maximum number of rows that you want the query to return. To query only the number of rows that meet the query conditions without querying specific data of the rows, set the limit parameter to 0.
queryType	The query type. To use match phrase query, set this parameter to TableStore.QueryType.MATCH_PHRASE_QUERY.
fieldName	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. By default, single-word tokenization is performed if you do not specify the analyzer type when you create the search index. For more information, see Tokenization. For example, a match phrase query based on the phrase "this is" matches "..., this is tablestore" and "this is a table" and does not match the "this table is ..." or "is this a table" value.
getTotalCount	Specifies whether to return the total number of rows that meet the query conditions. Default value: false. If this parameter is set to true, the query performance is compromised.
columnToGet	Specifies whether to return all columns of each row that meets the query conditions. You can configure returnType and returnNames for this parameter. If you set returnType to TableStore.ColumnReturnType.RETURN_SPECIFIED, you need to configure returnNames to specify the columns that you want to return. If you set the returnType parameter to TableStore.ColumnReturnType.RETURN_ALL, all columns are returned. If you set the returnType parameter to TableStore.ColumnReturnType.RETURN_ALL_FROM_INDEX, all columns in the search index are returned. . If you set the returnType parameter to TableStore.ColumnReturnType.RETURN_NONE, only the primary key columns are returned.

Examples

The following sample code provides an example on how to perform a match phase query to find rows in which the value of Col_Text matches the "hangzhou shanghai" phase:

/**
 * Search the table for rows in which the value of Col_Text matches the entire phase "hangzhou shanghai" in order. 
 * Tablestore returns the number of rows that match the phrase and part of the matched rows in this query. 
 */
client.search({
    tableName: TABLE_NAME,
    indexName: INDEX_NAME,
    searchQuery: {
        offset: 0,
        limit: 10, // To query only the number of rows that meet the query conditions without returning specific data, set the limit parameter to 0. 
        query: {// Set the query type to TableStore.QueryType.MATCH_PHRASE_QUERY. 
            queryType: TableStore.QueryType.MATCH_PHRASE_QUERY,
            query: {
                fieldName: "Col_Text", // Specify the column that you want to match. 
                text: "hangzhou shanghai" // Specify the phase that you want to match. 
            }
        },
        getTotalCount: true // Specify whether to return the total number of rows that meet the query conditions. Default value: false. 
    },
    columnToGet: { // Specify the columns that you want to return. You can set the parameter to RETURN_SPECIFIED to return specified columns, RETURN_ALL to return all columns, RETURN_ALL_FROM_INDEX to return all columns in the search index, or RETURN_NONE to return only the primary key columns. 
        returnType: TableStore.ColumnReturnType.RETURN_ALL
    }
}, function (err, data) {
    if (err) {
        console.log('error:', err);
        return;
    }
    console.log('success:', JSON.stringify(data, null, 2));
});

FAQ

References

The following query types are supported by search indexes: term query, terms query, match all query, match query, match phrase query, prefix query, range query, wildcard query, Boolean query, geo query, nested query, vector query, and exists query. You can select a query type to query data 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.