All Products
Search
Document Center

Tablestore:MatchPhraseQuery

Last Updated:Apr 30, 2026

MatchPhraseQuery configures a match phrase query. It returns rows where a column's tokens match the query keyword in the same order and at adjacent positions, based on approximate matching.

Data structure

message MatchPhraseQuery {
    optional string field_name = 1;
    optional string text = 2;
    optional float weight = 3;
}

Parameter

Type

Required

Description

field_name

string

Yes

The name of the column to query. Only TEXT columns support match phrase queries.

text

string

Yes

The keyword to match against column values. For TEXT columns, the keyword is tokenized using the analyzer configured when you created the search index. If no analyzer is specified, single-word tokenization applies by default.

For example, querying with "this is" matches "..., this is tablestore" and "this is a table", but not "this table is ..." or "is this a table".

weight

float

No

The weight of this query condition in relevance scoring.