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

前提条件

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

参数

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

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

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

minimumShouldMatchshouldQueries子查询条件的最小匹配个数。当同级没有其他Query,只有shouldQueries时,默认值为1;当同级已有其他Query,例如mustQueries、mustNotQueries和filterQueries时,默认值为0。
getTotalCount是否返回匹配的总行数,默认为false,表示不返回。

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

tableName数据表名称。
indexName多元索引名称。
columnsToGet是否返回所有列,包含returnAll和columns设置。

returnAll默认为false,表示不返回所有列,此时可以通过columns指定返回的列;如果未通过columns指定返回的列,则只返回主键列。

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

示例

  • 示例1

    通过BoolQuery进行And条件查询。

    /**
     * 通过BoolQuery进行And条件查询。
     * @param client
     */
    public static void andQuery(SyncClient client){
        /**
         * 查询条件一:RangeQuery,Col_Long的列值大于3。
         */
        RangeQuery rangeQuery = new RangeQuery();
        rangeQuery.setFieldName("Col_Long");
        rangeQuery.greaterThan(ColumnValue.fromLong(3));
    
        /**
         * 查询条件二:MatchQuery,Col_Keyword的列值要匹配"hangzhou"。
         */
        MatchQuery matchQuery = new MatchQuery();
        matchQuery.setFieldName("Col_Keyword");
        matchQuery.setText("hangzhou");
    
        SearchQuery searchQuery = new SearchQuery();
        {
            /**
             * 构造一个BoolQuery,设置查询条件为必须同时满足"查询条件一"和"查询条件二"。
             */
            BoolQuery boolQuery = new BoolQuery();
            boolQuery.setMustQueries(Arrays.asList(rangeQuery, matchQuery));
            searchQuery.setQuery(boolQuery);
            //searchQuery.setGetTotalCount(true);//设置返回匹配的总行数。
    
            SearchRequest searchRequest = new SearchRequest("sampleTable", "sampleSearchIndex", searchQuery);
            //通过设置columnsToGet参数可以指定返回的列或返回所有列,如果不设置此参数,则默认只返回主键列。
            //SearchRequest.ColumnsToGet columnsToGet = new SearchRequest.ColumnsToGet();
            //columnsToGet.setReturnAll(true); //设置为返回所有列。
            //columnsToGet.setColumns(Arrays.asList("ColName1","ColName2")); //设置为返回指定列。
            //searchRequest.setColumnsToGet(columnsToGet);
    
            SearchResponse resp = client.search(searchRequest);
            //System.out.println("TotalCount: " + resp.getTotalCount()); //打印匹配到的总行数,非返回行数。
            System.out.println("Row: " + resp.getRows());
        }
    }
  • 示例2

    通过BoolQuery进行Or条件查询。

    /**
     * 通过BoolQuery进行Or条件查询。
     * @param client
     */
    public static void orQuery(SyncClient client) {
    
        /**
         * 查询条件一:RangeQuery,Col_Long的列值大于3。
         */
        RangeQuery rangeQuery = new RangeQuery();
        rangeQuery.setFieldName("Col_Long");
        rangeQuery.greaterThan(ColumnValue.fromLong(3));
    
        /**
         * 查询条件二:MatchQuery,Col_Keyword的列值要匹配"hangzhou"。
         */
        MatchQuery matchQuery = new MatchQuery();
        matchQuery.setFieldName("Col_Keyword");
        matchQuery.setText("hangzhou");
    
        SearchQuery searchQuery = new SearchQuery();
        {
        /**
         * 构造一个BoolQuery,设置查询条件为至少满足"条件一"和"条件二"中的一个条件。
         */
        BoolQuery boolQuery = new BoolQuery();
        boolQuery.setShouldQueries(Arrays.asList(rangeQuery, matchQuery));
        boolQuery.setMinimumShouldMatch(1); //设置至少满足一个条件。
        searchQuery.setQuery(boolQuery);
        //searchQuery.setGetTotalCount(true);//设置返回匹配的总行数。
    
        SearchRequest searchRequest = new SearchRequest("sampleTable", "sampleSearchIndex", searchQuery);
        //通过设置columnsToGet参数可以指定返回的列或返回所有列,如果不设置此参数,则默认只返回主键列。
        //SearchRequest.ColumnsToGet columnsToGet = new SearchRequest.ColumnsToGet();
        //columnsToGet.setReturnAll(true); //设置为返回所有列。
        //columnsToGet.setColumns(Arrays.asList("ColName1","ColName2")); //设置为返回指定列。
        //searchRequest.setColumnsToGet(columnsToGet);
    
        SearchResponse resp = client.search(searchRequest);
        //System.out.println("TotalCount: " + resp.getTotalCount()); //打印匹配到的总行数,非返回行数
        System.out.println("Row: " + resp.getRows());
        }
    }
  • 示例3

    通过BoolQuery进行Not条件查询。

    /**
     * 通过BoolQuery进行Not条件查询。
     * @param client
     */
    public static void notQuery(SyncClient client) {
    
        /**
         * 查询条件一:MatchQuery,Col_Keyword的列值要匹配"hangzhou"。
         */
        MatchQuery matchQuery = new MatchQuery();
        matchQuery.setFieldName("Col_Keyword");
        matchQuery.setText("hangzhou");
    
        SearchQuery searchQuery = new SearchQuery();
        {
            /**
             * 构造一个BoolQuery,设置查询条件为不满足"查询条件一"。
             */
            BoolQuery boolQuery = new BoolQuery();
            boolQuery.setMustNotQueries(Arrays.asList(matchQuery));
            searchQuery.setQuery(boolQuery);
            //searchQuery.setGetTotalCount(true);//设置返回匹配的总行数。
    
            SearchRequest searchRequest = new SearchRequest("sampleTable", "sampleSearchIndex", searchQuery);
            //通过设置columnsToGet参数可以指定返回的列或返回所有列,如果不设置此参数,则默认只返回主键列。
            //SearchRequest.ColumnsToGet columnsToGet = new SearchRequest.ColumnsToGet();
            //columnsToGet.setReturnAll(true); //设置为返回所有列。
            //columnsToGet.setColumns(Arrays.asList("ColName1","ColName2")); //设置为返回指定列。
            //searchRequest.setColumnsToGet(columnsToGet);
    
            SearchResponse resp = client.search(searchRequest);
            //System.out.println("TotalCount: " + resp.getTotalCount()); //打印匹配到的总行数,非返回行数。
            System.out.println("Row: " + resp.getRows());
        }
    }
  • 示例4

    含有子BoolQuery的组合查询。使用多条件组合查询实现(col2<4 or col3<5) or (col2 = 4 and (col3 = 5 or col3 =6)),每个and或or相当于一个BoolQuery,多个表达式的and或or就是多个BoolQuery的组合。

    /**
     * (col2<4 or col3<5) or (col2 = 4 and (col3 = 5 or col3 =6))
     * 使用多条件组合查询上述表达式,每个and或or相当于一个BoolQuery,多个表达式的and或or就是多个BoolQuery的组合。
     * @param client
    */
    private static void boolQuery2(SyncClient client){
            //条件1为col2<4。
            RangeQuery rangeQuery1 = new RangeQuery();
            rangeQuery1.setFieldName("col2");
            rangeQuery1.lessThan(ColumnValue.fromLong(4));
    
            //条件2为col3<5。
            RangeQuery rangeQuery2 = new RangeQuery();
            rangeQuery2.setFieldName("col3");
            rangeQuery2.lessThan(ColumnValue.fromLong(5));
    
            //条件3为col2=4。
            TermQuery termQuery = new TermQuery();
            termQuery.setFieldName("col2");
            termQuery.setTerm(ColumnValue.fromLong(4));
    
            //条件4为col3 = 5 or col3 = 6。
            TermsQuery termsQuery = new TermsQuery();
            termsQuery.setFieldName("col3");
            termsQuery.addTerm(ColumnValue.fromLong(5));
            termsQuery.addTerm(ColumnValue.fromLong(6));
    
            SearchQuery searchQuery = new SearchQuery();
    
            List<Query> queryList1 = new ArrayList<>();
            queryList1.add(rangeQuery1);
            queryList1.add(rangeQuery2);
    
            //组合条件1为col2<4 OR col3<5。
            BoolQuery boolQuery1 = new BoolQuery();
            boolQuery1.setShouldQueries(queryList1);
    
            //组合条件2为col2=4 and (col3=5 or col3=6)。
            List<Query> queryList2 = new ArrayList<>();
            queryList2.add(termQuery);
            queryList2.add(termsQuery);
    
            BoolQuery boolQuery2 = new BoolQuery();
            boolQuery2.setMustQueries(queryList2);
    
            //总组合条件为(col2<4 OR col3<5) or (col2=4 and (col3=5 or col3=6))。
    
            List<Query> queryList3 = new ArrayList<>();
            queryList3.add(boolQuery1);
            queryList3.add(boolQuery2);
    
            BoolQuery boolQuery = new BoolQuery();
            boolQuery.setShouldQueries(queryList3);
    
            searchQuery.setQuery(boolQuery);
            //searchQuery.setGetTotalCount(true);//设置返回匹配的总行数。
    
            SearchRequest searchRequest = new SearchRequest("sampleTable", "sampleSearchIndex", searchQuery);
            //通过设置columnsToGet参数可以指定返回的列或返回所有列,如果不设置此参数,则默认只返回主键列。
            //SearchRequest.ColumnsToGet columnsToGet = new SearchRequest.ColumnsToGet();
            //columnsToGet.setReturnAll(true); //设置为返回所有列。
            //columnsToGet.setColumns(Arrays.asList("ColName1","ColName2")); //设置为返回指定列。
            //searchRequest.setColumnsToGet(columnsToGet);
    
            SearchResponse response = client.search(searchRequest);
            //System.out.println("TotalCount: " + resp.getTotalCount()); //打印匹配到的总行数,非返回行数。
            System.out.println(response.getRows());
    
        }