BoolQuery查询条件包含一个或者多个子查询条件,根据子查询条件来判断一行数据是否满足查询条件。每个子查询条件可以是任意一种Query类型,包括BoolQuery。

前提条件

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

参数

参数 说明
MustQueries 多个Query列表,行数据必须满足所有的子查询条件才算匹配,等价于And操作符。
MustNotQueries 多个Query列表,行数据必须不能满足任何的子查询条件才算匹配,等价于Not操作符。
FilterQueries 多个Query列表,行数据必须满足所有的子Filter才算匹配,Filter类似于Query,区别是Filter不会根据满足的Filter个数进行相关性算分。
ShouldQueries 多个Query列表,可以满足,也可以不满足,等价于Or操作符。

行数据应该至少满足ShouldQueries子查询条件的最小匹配个数才算匹配。

如果满足的ShouldQueries子查询条件个数越多,则整体的相关性分数更高。

MinimumShouldMatch ShouldQueries子查询条件的最小匹配个数。当同级没有其他Query,只有ShouldQueries时,默认值为1;当同级已有其他Query,例如MustQueries、MustNotQueries和FilterQueries时,默认值为0。
TableName 数据表名称。
IndexName 多元索引名称。
ColumnsToGet 是否返回所有列。包含ReturnAll和Columns以及ReturnAllFromIndex设置。
ReturnAll默认为false,表示不返回所有列。此时可以通过如下任一设置返回所需列。如果未设置Columns和ReturnAllFromIndex,则只返回主键列。
  • 设置Columns指定返回的列。
  • 设置ReturnAllFromIndex为true返回多元索引中的所有列。

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

示例

/// <summary>
///多条件组合查询BoolQuery由一个或者多个子查询条件组成,每个子查询条件都有特定的类型。
///MustQueries: 行数据必须完全匹配条件。
///ShouldQueries: ShouldQueries中会带有一个以上的条件,至少满足一个条件,此行数据就符合查询条件。
///MustNotQueries: 行数据必须不匹配条件。
///MinimumShouldMatch: should查询的条件至少满足的个数。
/// </summary>
/// <param name="otsClient"></param>
public static void BoolQuery(OTSClient otsClient)
{
    Console.WriteLine("\n Start bool query...");

    var searchQuery = new SearchQuery();
    //设置返回匹配的总行数。
    searchQuery.GetTotalCount = true;
    var boolQuery = new BoolQuery();
    var shouldQuerys = new List<IQuery>();
    shouldQuerys.Add(new TermQuery(Keyword_type_col, new ColumnValue("SearchIndex")));
    shouldQuerys.Add(new TermQuery(Keyword_type_col, new ColumnValue("TableStore")));
    boolQuery.ShouldQueries = shouldQuerys;
    boolQuery.MinimumShouldMatch = 1;

    searchQuery.Query = boolQuery;

    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); //打印匹配到的总行数,非返回行数。
    foreach (var row in response.Rows)
    {
        PrintRow(row);
    }
}