PrefixQuery根据前缀条件查询表中的数据。对于Text类型字段,只要分词后的词条中有词条满足前缀条件即可。

前提条件

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

参数

参数 说明
FieldName 要匹配的字段。
Prefix 前缀值。

对于Text类型字段,只要分词后的词条中有词条满足前缀条件即可。

GetTotalCount 是否返回匹配的总行数,默认为false,表示不返回。

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

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

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

示例

/// <summary>
/// 查询表中Keyword_type_col列中前缀为"Search"的数据。
/// </summary>
/// <param name="otsClient"></param>
public static void PrefixQuery(OTSClient otsClient)
{
    var searchQuery = new SearchQuery();
    //设置查询类型为PrefixQuery,匹配字段为Keyword_type_col,前缀值为"Search"。
    searchQuery.Query = new PrefixQuery(Keyword_type_col, "Search");
    //设置返回匹配的总行数。
    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); //打印匹配到的总行数,非返回行数。
}