16dac98f71
A common search case is when a user performs a query-string query, such as for "the lazy dog". That would be parsed into a boolean query with a nil Must child, a nil MustNot child, and a non-nil Should child (a disjunction query for "the", "lazy", "dog"). The optimization in this case is to return just the Should child directly, skipping any additional Must and MustNot overhead. On a dev box bleve-query benchmark on a wiki index with a query string of "text:afternoon text:coffee", the throughput was previously 873qps and with this change hits 940qps.
218 lines
5.3 KiB
Go
218 lines
5.3 KiB
Go
// Copyright (c) 2014 Couchbase, Inc.
|
|
// Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file
|
|
// except in compliance with the License. You may obtain a copy of the License at
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
// Unless required by applicable law or agreed to in writing, software distributed under the
|
|
// License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
|
|
// either express or implied. See the License for the specific language governing permissions
|
|
// and limitations under the License.
|
|
|
|
package bleve
|
|
|
|
import (
|
|
"encoding/json"
|
|
"fmt"
|
|
|
|
"github.com/blevesearch/bleve/index"
|
|
"github.com/blevesearch/bleve/search"
|
|
"github.com/blevesearch/bleve/search/searchers"
|
|
)
|
|
|
|
type booleanQuery struct {
|
|
Must Query `json:"must,omitempty"`
|
|
Should Query `json:"should,omitempty"`
|
|
MustNot Query `json:"must_not,omitempty"`
|
|
BoostVal float64 `json:"boost,omitempty"`
|
|
}
|
|
|
|
// NewBooleanQuery creates a compound Query composed
|
|
// of several other Query objects.
|
|
// Result documents must satisfy ALL of the
|
|
// must Queries.
|
|
// Result documents must satisfy NONE of the must not
|
|
// Queries.
|
|
// Result documents that ALSO satisfy any of the should
|
|
// Queries will score higher.
|
|
func NewBooleanQuery(must []Query, should []Query, mustNot []Query) *booleanQuery {
|
|
return NewBooleanQueryMinShould(must, should, mustNot, 0.0)
|
|
}
|
|
|
|
// NewBooleanQueryMinShould is the same as
|
|
// NewBooleanQuery, only it offers control of the
|
|
// minimum number of should queries that must be
|
|
// satisfied.
|
|
func NewBooleanQueryMinShould(must []Query, should []Query, mustNot []Query, minShould float64) *booleanQuery {
|
|
|
|
rv := booleanQuery{
|
|
BoostVal: 1.0,
|
|
}
|
|
if len(must) > 0 {
|
|
rv.Must = NewConjunctionQuery(must)
|
|
}
|
|
if len(should) > 0 {
|
|
rv.Should = NewDisjunctionQueryMin(should, minShould)
|
|
}
|
|
if len(mustNot) > 0 {
|
|
rv.MustNot = NewDisjunctionQuery(mustNot)
|
|
}
|
|
|
|
return &rv
|
|
}
|
|
|
|
// SetMinShould requires that at least minShould of the
|
|
// should Queries must be satisfied.
|
|
func (q *booleanQuery) SetMinShould(minShould float64) {
|
|
q.Should.(*disjunctionQuery).SetMin(minShould)
|
|
}
|
|
|
|
func (q *booleanQuery) AddMust(m Query) {
|
|
if q.Must == nil {
|
|
q.Must = NewConjunctionQuery([]Query{})
|
|
}
|
|
q.Must.(*conjunctionQuery).AddQuery(m)
|
|
}
|
|
|
|
func (q *booleanQuery) AddShould(m Query) {
|
|
if q.Should == nil {
|
|
q.Should = NewDisjunctionQuery([]Query{})
|
|
}
|
|
q.Should.(*disjunctionQuery).AddQuery(m)
|
|
}
|
|
|
|
func (q *booleanQuery) AddMustNot(m Query) {
|
|
if q.MustNot == nil {
|
|
q.MustNot = NewDisjunctionQuery([]Query{})
|
|
}
|
|
q.MustNot.(*disjunctionQuery).AddQuery(m)
|
|
}
|
|
|
|
func (q *booleanQuery) Boost() float64 {
|
|
return q.BoostVal
|
|
}
|
|
|
|
func (q *booleanQuery) SetBoost(b float64) Query {
|
|
q.BoostVal = b
|
|
return q
|
|
}
|
|
|
|
func (q *booleanQuery) Searcher(i index.IndexReader, m *IndexMapping, explain bool) (search.Searcher, error) {
|
|
var err error
|
|
var mustNotSearcher search.Searcher
|
|
if q.MustNot != nil {
|
|
mustNotSearcher, err = q.MustNot.Searcher(i, m, explain)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
if q.Must == nil && q.Should == nil {
|
|
q.Must = NewMatchAllQuery()
|
|
}
|
|
}
|
|
|
|
var mustSearcher search.Searcher
|
|
if q.Must != nil {
|
|
mustSearcher, err = q.Must.Searcher(i, m, explain)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
}
|
|
|
|
var shouldSearcher search.Searcher
|
|
if q.Should != nil {
|
|
shouldSearcher, err = q.Should.Searcher(i, m, explain)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
}
|
|
|
|
if mustSearcher == nil && shouldSearcher != nil && mustNotSearcher == nil {
|
|
return shouldSearcher, nil
|
|
}
|
|
|
|
return searchers.NewBooleanSearcher(i, mustSearcher, shouldSearcher, mustNotSearcher, explain)
|
|
}
|
|
|
|
func (q *booleanQuery) Validate() error {
|
|
if q.Must != nil {
|
|
err := q.Must.Validate()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
}
|
|
if q.Should != nil {
|
|
err := q.Should.Validate()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
}
|
|
if q.MustNot != nil {
|
|
err := q.MustNot.Validate()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
}
|
|
if q.Must == nil && q.Should == nil && q.MustNot == nil {
|
|
return ErrorBooleanQueryNeedsMustOrShouldOrNotMust
|
|
}
|
|
return nil
|
|
}
|
|
|
|
func (q *booleanQuery) UnmarshalJSON(data []byte) error {
|
|
tmp := struct {
|
|
Must json.RawMessage `json:"must,omitempty"`
|
|
Should json.RawMessage `json:"should,omitempty"`
|
|
MustNot json.RawMessage `json:"must_not,omitempty"`
|
|
BoostVal float64 `json:"boost,omitempty"`
|
|
}{}
|
|
err := json.Unmarshal(data, &tmp)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
if tmp.Must != nil {
|
|
q.Must, err = ParseQuery(tmp.Must)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
_, isConjunctionQuery := q.Must.(*conjunctionQuery)
|
|
if !isConjunctionQuery {
|
|
return fmt.Errorf("must clause must be conjunction")
|
|
}
|
|
}
|
|
|
|
if tmp.Should != nil {
|
|
q.Should, err = ParseQuery(tmp.Should)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
_, isDisjunctionQuery := q.Should.(*disjunctionQuery)
|
|
if !isDisjunctionQuery {
|
|
return fmt.Errorf("should clause must be disjunction")
|
|
}
|
|
}
|
|
|
|
if tmp.MustNot != nil {
|
|
q.MustNot, err = ParseQuery(tmp.MustNot)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
_, isDisjunctionQuery := q.MustNot.(*disjunctionQuery)
|
|
if !isDisjunctionQuery {
|
|
return fmt.Errorf("must not clause must be disjunction")
|
|
}
|
|
}
|
|
|
|
q.BoostVal = tmp.BoostVal
|
|
if q.BoostVal == 0 {
|
|
q.BoostVal = 1
|
|
}
|
|
return nil
|
|
}
|
|
|
|
func (q *booleanQuery) Field() string {
|
|
return ""
|
|
}
|
|
|
|
func (q *booleanQuery) SetField(f string) Query {
|
|
return q
|
|
}
|