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

前提条件

  • 已初始化Client,详情请参见初始化
  • 已创建数据表并写入数据。
  • 已在数据表上创建多元索引,详情请参见创建多元索引

参数

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

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

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

minimumShouldMatch shouldQueries的最小匹配个数。当同级没有其他Query,只有shouldQuery时,默认值为1;当同级已有其他Query,例如mustQuery、mustNotQuery和filterQuery时,默认值为0。

示例

通过构造一个BoolQuery进行多条件组合查询。

var client = require('../client');
var TableStore = require('../../index.js');
var Long = TableStore.Long;
/**
 * 使用多条件组合查询实现(col2<4 or col3<5) or (col2 = 4 and (col3 = 5 or col3 =6))。逻辑如下:
 * boolQuery1 = rangeQuery(col2<4) or rangeQuery(col3<5)
 * boolQuery2 = termQuery(col3=5) or (col3=6)
 * boolQuery3 = termQuery(col2=4) and boolquery2
 * boolQuery4 = boolQuery1 or boolQuery3
 */
client.search({
    tableName: "sampleTable",
    indexName: "sampleSearchIndex",
    searchQuery: {
        offset: 0, //查询偏移量。
        limit: 10, //如果只为了获取行数,无需获取具体数据,可以设置limit=0,即不返回任意一行数据。
        getTotalCount: false, //结果中的TotalCount可以表示表中数据的总行数,默认为false,表示不返回。
        query: { //构造boolQuery4,设置查询条件为至少满足boolQuery1和boolQuery3中的一个条件。
            queryType: TableStore.QueryType.BOOL_QUERY,
            query: {
                shouldQueries: [ //可选mustQueries、shouldQueries和mustNotQueries。
                    { //构造boolQuery1,设置查询条件为至少满足“查询条件一”和“查询条件二”中的一个条件。
                        queryType: TableStore.QueryType.BOOL_QUERY,
                        query: {
                            //shouldQueries,查询条件为col2的列值小于4或者col3的列值小于5。
                            shouldQueries:[
                                {
                                    //查询条件一:rangeQuery,col2的列值小于4。
                                    queryType: TableStore.QueryType.RANGE_QUERY,
                                    query:{
                                        fieldName: "col2",
                                        rangeTo: 4
                                    }
                                },
                                {
                                    //查询条件二:rangeQuery,col3的列值小于5。                                    queryType: TableStore.QueryType.RANGE_QUERY,
                                    query:{
                                        fieldName: "col3",
                                        rangeTo: 5
                                    }
                                }
                            ],
                            minimumShouldMatch:1

                        }
                    },
                    { //构造boolQuery3,设置查询条件为必须同时满足“查询条件三”和boolQuery2。
                        queryType: TableStore.QueryType.BOOL_QUERY,
                        query: {
                            mustQueries: [
                                //mustQueries,查询条件为col2的列值等于4,且col3的列值等于5或者6。
                                {
                                    //查询条件三:termQuery,col2的列值等于4。
                                    queryType:TableStore.QueryType.TERM_QUERY,
                                    query: {
                                        fieldName : "col2",
                                        term: 4
                                    }
                                },
                                { //构造boolQuery2:设置查询条件为至少满足“查询条件四”和“查询条件五”中的一个条件。
                                    queryType: TableStore.QueryType.BOOL_QUERY,
                                    query: {
                      TERM                  //shouldQueries,查询条件为col3的列值等于5或者6。
                                        shouldQueries:[
                                            {
                                                //查询条件四:termQuery,col3的列值等于5。
                                                queryType: TableStore.QueryType.TERM_QUERY,
                                                query:{
                                                    fieldName:"col3",
                                                    term: 5
                                                }
                                            },
                                            {
                                                //查询条件五:termQuery,col3的列值等于6。                                                queryType: TableStore.QueryType.TERM_QUERY,
                                                query:{
                                                    fieldName:"col3",
                                                    term: 6
                                                }
                                            }
                                        ],
                                        minimumShouldMatch:1
                                    }
                                }
                            ]
                        }
                    }
                ],
                minimumShouldMatch: 1 //仅shouldQueries时有效,至少满足的条件个数。
            }
        },
    },
    columnToGet: { //返回列设置RETURN_SPECIFIED表示自定义返回列,RETURN_ALL表示返回所有列,RETURN_NONE表示不返回。       
        returnType: TableStore.ColumnReturnType.RETURN_SPECIFIED,
        returnNames: ["col2", "col3", "col4"]
    }
}, function (err, data) {
    if (err) {
        console.log('error:', err);
        return;
    }
    console.log('success:', JSON.stringify(data, null, 2));
});