2014-04-17 22:55:53 +02:00
|
|
|
// Copyright (c) 2014 Couchbase, Inc.
|
2016-10-02 16:13:14 +02:00
|
|
|
//
|
|
|
|
// 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.
|
2014-09-02 16:54:50 +02:00
|
|
|
|
2014-04-17 22:55:53 +02:00
|
|
|
package search
|
|
|
|
|
2016-08-12 20:23:55 +02:00
|
|
|
import (
|
|
|
|
"fmt"
|
|
|
|
|
|
|
|
"github.com/blevesearch/bleve/document"
|
|
|
|
"github.com/blevesearch/bleve/index"
|
|
|
|
)
|
2016-07-31 19:46:18 +02:00
|
|
|
|
2017-02-10 02:02:12 +01:00
|
|
|
type ArrayPositions []uint64
|
2014-04-17 22:55:53 +02:00
|
|
|
|
2017-02-09 21:59:51 +01:00
|
|
|
func (ap ArrayPositions) Equals(other ArrayPositions) bool {
|
|
|
|
if len(ap) != len(other) {
|
2015-12-06 21:55:00 +01:00
|
|
|
return false
|
|
|
|
}
|
2017-02-09 21:59:51 +01:00
|
|
|
for i := range ap {
|
|
|
|
if ap[i] != other[i] {
|
2015-12-06 21:55:00 +01:00
|
|
|
return false
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return true
|
|
|
|
}
|
|
|
|
|
2017-02-09 21:59:51 +01:00
|
|
|
type Location struct {
|
2017-02-10 02:02:12 +01:00
|
|
|
Pos uint64 `json:"pos"`
|
|
|
|
Start uint64 `json:"start"`
|
|
|
|
End uint64 `json:"end"`
|
2017-02-09 21:59:51 +01:00
|
|
|
ArrayPositions ArrayPositions `json:"array_positions"`
|
|
|
|
}
|
|
|
|
|
2014-04-17 22:55:53 +02:00
|
|
|
type Locations []*Location
|
|
|
|
|
|
|
|
type TermLocationMap map[string]Locations
|
|
|
|
|
2014-07-03 20:53:44 +02:00
|
|
|
func (t TermLocationMap) AddLocation(term string, location *Location) {
|
2016-10-11 21:14:48 +02:00
|
|
|
t[term] = append(t[term], location)
|
2014-07-03 20:53:44 +02:00
|
|
|
}
|
|
|
|
|
2014-04-17 22:55:53 +02:00
|
|
|
type FieldTermLocationMap map[string]TermLocationMap
|
|
|
|
|
2014-07-03 20:53:44 +02:00
|
|
|
type FieldFragmentMap map[string][]string
|
|
|
|
|
2014-04-17 22:55:53 +02:00
|
|
|
type DocumentMatch struct {
|
2016-08-01 20:58:02 +02:00
|
|
|
Index string `json:"index,omitempty"`
|
|
|
|
ID string `json:"id"`
|
|
|
|
IndexInternalID index.IndexInternalID `json:"-"`
|
|
|
|
Score float64 `json:"score"`
|
|
|
|
Expl *Explanation `json:"explanation,omitempty"`
|
|
|
|
Locations FieldTermLocationMap `json:"locations,omitempty"`
|
|
|
|
Fragments FieldFragmentMap `json:"fragments,omitempty"`
|
improved implementation to address perf regressions
primary change is going back to sort values be []string
and not []interface{}, this avoid allocatiosn converting
into the interface{}
that sounds obvious, so why didn't we just do that first?
because a common (default) sort is score, which is naturally
a number, not a string (like terms). converting into the
number was also expensive, and the common case.
so, this solution also makes the change to NOT put the score
into the sort value list. instead you see the dummy value
"_score". this is just a placeholder, the actual sort impl
knows that field of the sort is the score, and will sort
using the actual score.
also, several other aspets of the benchmark were cleaned up
so that unnecessary allocations do not pollute the cpu profiles
Here are the updated benchmarks:
$ go test -run=xxx -bench=. -benchmem -cpuprofile=cpu.out
BenchmarkTop10of100000Scores-4 3000 465809 ns/op 2548 B/op 33 allocs/op
BenchmarkTop100of100000Scores-4 2000 626488 ns/op 21484 B/op 213 allocs/op
BenchmarkTop10of1000000Scores-4 300 5107658 ns/op 2560 B/op 33 allocs/op
BenchmarkTop100of1000000Scores-4 300 5275403 ns/op 21624 B/op 213 allocs/op
PASS
ok github.com/blevesearch/bleve/search/collectors 7.188s
Prior to this PR, master reported:
$ go test -run=xxx -bench=. -benchmem
BenchmarkTop10of100000Scores-4 3000 453269 ns/op 360161 B/op 42 allocs/op
BenchmarkTop100of100000Scores-4 2000 519131 ns/op 388275 B/op 219 allocs/op
BenchmarkTop10of1000000Scores-4 200 7459004 ns/op 4628236 B/op 52 allocs/op
BenchmarkTop100of1000000Scores-4 200 8064864 ns/op 4656596 B/op 232 allocs/op
PASS
ok github.com/blevesearch/bleve/search/collectors 7.385s
So, we're pretty close on the smaller datasets, and we scale better on the larger datasets.
We also show fewer allocations and bytes in all cases (some of this is artificial due to test cleanup).
2016-08-25 21:47:07 +02:00
|
|
|
Sort []string `json:"sort,omitempty"`
|
2015-10-04 11:25:58 +02:00
|
|
|
|
|
|
|
// Fields contains the values for document fields listed in
|
|
|
|
// SearchRequest.Fields. Text fields are returned as strings, numeric
|
|
|
|
// fields as float64s and date fields as time.RFC3339 formatted strings.
|
|
|
|
Fields map[string]interface{} `json:"fields,omitempty"`
|
2016-08-12 20:23:55 +02:00
|
|
|
|
|
|
|
// if we load the document for this hit, remember it so we dont load again
|
|
|
|
Document *document.Document `json:"-"`
|
|
|
|
|
|
|
|
// used to maintain natural index order
|
|
|
|
HitNumber uint64 `json:"-"`
|
2014-08-06 19:52:20 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
func (dm *DocumentMatch) AddFieldValue(name string, value interface{}) {
|
|
|
|
if dm.Fields == nil {
|
|
|
|
dm.Fields = make(map[string]interface{})
|
|
|
|
}
|
2014-11-19 21:55:09 +01:00
|
|
|
existingVal, ok := dm.Fields[name]
|
2015-09-21 20:46:33 +02:00
|
|
|
if !ok {
|
|
|
|
dm.Fields[name] = value
|
|
|
|
return
|
|
|
|
}
|
|
|
|
|
|
|
|
valSlice, ok := existingVal.([]interface{})
|
2014-11-19 21:55:09 +01:00
|
|
|
if ok {
|
2015-09-21 20:46:33 +02:00
|
|
|
// already a slice, append to it
|
|
|
|
valSlice = append(valSlice, value)
|
2014-11-19 21:55:09 +01:00
|
|
|
} else {
|
2015-09-21 20:46:33 +02:00
|
|
|
// create a slice
|
|
|
|
valSlice = []interface{}{existingVal, value}
|
2014-11-19 21:55:09 +01:00
|
|
|
}
|
2015-09-21 20:46:33 +02:00
|
|
|
dm.Fields[name] = valSlice
|
2014-04-17 22:55:53 +02:00
|
|
|
}
|
|
|
|
|
2016-08-03 23:16:15 +02:00
|
|
|
// Reset allows an already allocated DocumentMatch to be reused
|
2016-07-21 01:29:20 +02:00
|
|
|
func (dm *DocumentMatch) Reset() *DocumentMatch {
|
2016-08-03 23:16:15 +02:00
|
|
|
// remember the []byte used for the IndexInternalID
|
2016-08-25 01:02:22 +02:00
|
|
|
indexInternalID := dm.IndexInternalID
|
|
|
|
// remember the []interface{} used for sort
|
|
|
|
sort := dm.Sort
|
2016-08-03 23:16:15 +02:00
|
|
|
// idiom to copy over from empty DocumentMatch (0 allocations)
|
2016-07-21 01:29:20 +02:00
|
|
|
*dm = DocumentMatch{}
|
2016-08-03 23:16:15 +02:00
|
|
|
// reuse the []byte already allocated (and reset len to 0)
|
2016-08-25 01:02:22 +02:00
|
|
|
dm.IndexInternalID = indexInternalID[:0]
|
|
|
|
// reuse the []interface{} already allocated (and reset len to 0)
|
|
|
|
dm.Sort = sort[:0]
|
2016-07-21 01:29:20 +02:00
|
|
|
return dm
|
|
|
|
}
|
|
|
|
|
2016-08-12 20:23:55 +02:00
|
|
|
func (dm *DocumentMatch) String() string {
|
|
|
|
return fmt.Sprintf("[%s-%f]", string(dm.IndexInternalID), dm.Score)
|
|
|
|
}
|
|
|
|
|
2014-04-17 22:55:53 +02:00
|
|
|
type DocumentMatchCollection []*DocumentMatch
|
|
|
|
|
2014-10-29 14:22:11 +01:00
|
|
|
func (c DocumentMatchCollection) Len() int { return len(c) }
|
|
|
|
func (c DocumentMatchCollection) Swap(i, j int) { c[i], c[j] = c[j], c[i] }
|
|
|
|
func (c DocumentMatchCollection) Less(i, j int) bool { return c[i].Score > c[j].Score }
|
|
|
|
|
2014-04-17 22:55:53 +02:00
|
|
|
type Searcher interface {
|
2016-08-09 04:21:47 +02:00
|
|
|
Next(ctx *SearchContext) (*DocumentMatch, error)
|
|
|
|
Advance(ctx *SearchContext, ID index.IndexInternalID) (*DocumentMatch, error)
|
2015-03-06 20:46:29 +01:00
|
|
|
Close() error
|
2014-04-17 22:55:53 +02:00
|
|
|
Weight() float64
|
|
|
|
SetQueryNorm(float64)
|
|
|
|
Count() uint64
|
2014-08-30 00:14:12 +02:00
|
|
|
Min() int
|
2016-08-09 04:21:47 +02:00
|
|
|
|
|
|
|
DocumentMatchPoolSize() int
|
|
|
|
}
|
|
|
|
|
2017-01-06 02:49:45 +01:00
|
|
|
type SearcherOptions struct {
|
|
|
|
Explain bool
|
|
|
|
IncludeTermVectors bool
|
|
|
|
}
|
|
|
|
|
2016-08-09 04:21:47 +02:00
|
|
|
// SearchContext represents the context around a single search
|
|
|
|
type SearchContext struct {
|
|
|
|
DocumentMatchPool *DocumentMatchPool
|
2014-04-17 22:55:53 +02:00
|
|
|
}
|