短语匹配查询

更新时间:
复制为 MD 格式

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

前提条件

参数

参数

说明

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。设置为 true 时会影响查询性能。

ColumnsToGet

返回的列,通过 ReturnAll、Columns 或 ReturnAllFromIndex 配置。

ReturnAll默认为false,表示不返回所有列。此时可以通过如下任一设置返回所需列。如果未设置ColumnsReturnAllFromIndex,则只返回主键列。

  • 设置Columns指定返回的列。

  • 设置ReturnAllFromIndextrue返回多元索引中的所有列。

当设置ReturnAlltrue时,表示返回所有列。

示例

以下示例查询 Text_type_col 列中与短语"Tablestore SearchIndex"完全匹配(要求词序一致)的数据行。

/// <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);

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

常见问题

相关文档