You can use match query (MatchQuery) to query data in a table based on approximate matches. Tablestore tokenizes the values in TEXT columns and the keywords you use to perform match queries based on the analyzer that you specify. Therefore, Tablestore can perform match queries based on the tokens. We recommend that you use match phase query (MatchPhraseQuery) for columns for which fuzzy tokenization is used to ensure high performance in fuzzy queries.

Prerequisites

  • A Tablestore client 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
tableName The name of the data table.
indexName 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.

queryType The query type. To use match query, set this parameter to TableStore.QueryType.MATCH_QUERY.
fieldName The name of the column that you want to match.

You can perform match queries on TEXT columns.

text The keyword that is used to match the column values when you perform a match query.

If the column used for the match query is a TEXT column, the keyword is tokenized into multiple keywords based on the analyzer you specified when you create the search index. By default, single-word tokenization is performed if you do not specify the analyzer when you create the search index.

For example, if you set the tokenization method to single-word tokenization and use "this is" as a search keyword, you can obtain query results such as "..., this is tablestore", "is this tablestore", "tablestore is cool", "this", and "is".

operator The logical operator. By default, OR is used as the logical operator, which indicates that a row meets the query conditions when the column value contains at least the minimum number of tokens.

If you set the operator to AND, the row meets the query conditions only when the column value contains all tokens.

minimumShouldMatch The minimum number of matched tokens contained in a column value.

A row is returned only when the value of the fieldName column in the row contains at least the minimum number of matched tokens.

Note minimumShouldMatch must be used together with the OR logical operator.
getTotalCount 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.

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

/**
 * Search the table for rows in which the value in Col_Keyword matches "hangzhou". Tablestore returns part of the matched rows and the total number of 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, 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. 
        query: { // Set the query type to MatchQuery. 
            queryType: TableStore.QueryType.MATCH_QUERY,
            query: {
                fieldName: "Col_Keyword", // Specify the column used to match the query conditions. 
                text: "hangzhou" // Set the keyword used for the query to match the column values. 
            }
        },
        getTotalCount: true // Specify 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. 
    },
    columnToGet: { // Specify the columns that you want to return. You can configure the RETURN_SPECIFIED parameter to return specified columns, the RETURN_ALL parameter to return all columns, the RETURN_ALL_FROM_INDEX parameter to return all columns in the search index, or the RETURN_NONE parameter 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));
});