类似于MatchQuery,但是分词后多个词的位置关系会被考虑,只有分词后的多个词在行数据中以同样的顺序和位置存在时,才表示行数据满足查询条件。如果查询列的分词类型为模糊分词,则使用MatchPhraseQuery可以实现比WildcardQuery更快的模糊查询。

前提条件

  • 已初始化OTSClient。具体操作,请参见初始化
  • 已创建数据表并写入数据。
  • 已在数据表上创建多元索引。具体操作,请参见创建多元索引

参数

参数说明
FieldName要匹配的列。

匹配查询可应用于Text类型。

Text查询关键词,即要匹配的值。

当要匹配的列为Text类型时,查询关键词会被分词成多个词,分词类型为创建多元索引时设置的分词器类型。如果创建多元索引时未设置分词器类型,则默认分词类型为单字分词。

例如查询的值为“this is”,可以匹配到“...,this is tablestore”、“this is a table”,但是无法匹配到“this table is ...”以及“is this a table”。

Query设置查询类型为MatchPhraseQuery。
TableName数据表名称。
IndexName多元索引名称。
GetTotalCount 是否返回匹配的总行数,默认为false,表示不返回。

返回匹配的总行数会影响查询性能。

ColumnsToGet是否返回所有列。包含ReturnAll和Columns以及ReturnAllFromIndex设置。
ReturnAll默认为false,表示不返回所有列。此时可以通过如下任一设置返回所需列。如果未设置Columns和ReturnAllFromIndex,则只返回主键列。
  • 设置Columns指定返回的列。
  • 设置ReturnAllFromIndex为true返回多元索引中的所有列。

当设置ReturnAll为true时,表示返回所有列。

示例

/// <summary>
/// 查询表中Text_type_col列的值能够匹配"Tablestore SearchIndex"的数据,匹配条件为短语匹配(要求短语完整的按照顺序匹配),返回匹配到的总行数。
/// </summary>
/// <param name="otsClient"></param>
public static void MatchPhraseQuery(OTSClient otsClient)
{
    var searchQuery = new SearchQuery();
    //设置查询类型为MatchPhraseQuery。
    searchQuery.Query = new MatchPhraseQuery(Text_type_col, "Tablestore SearchIndex");
    //设置返回匹配的总行数。
    searchQuery.GetTotalCount = true;
    var request = new SearchRequest(TableName, IndexName, searchQuery);
    //通过ColumnsToGet参数可以设置返回多元索引中所有列、返回指定列或返回所有列,如果不设置此参数,则默认只返回主键列。
    request.ColumnsToGet = new ColumnsToGet()
    {
        //设置为返回多元索引中所有列。
        ReturnAllFromIndex = true
        //设置为返回指定列。
        //Columns = new List<string>() { Long_type_col, Text_type_col, Keyword_type_col }
        //设置为返回所有列。
        //ReturnAll = true         
    };

    var response = otsClient.Search(request);

    Console.WriteLine("Total Count:" + response.TotalCount); //打印匹配到的总行数,非返回行数。
}