2014-07-30 18:30:38 +02:00
|
|
|
// 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 (
|
2014-08-20 22:58:20 +02:00
|
|
|
"encoding/json"
|
2014-07-30 18:30:38 +02:00
|
|
|
"fmt"
|
2014-08-20 22:58:20 +02:00
|
|
|
"os"
|
2014-08-25 15:06:53 +02:00
|
|
|
"sync"
|
2014-08-06 19:52:20 +02:00
|
|
|
"time"
|
2014-07-30 18:30:38 +02:00
|
|
|
|
|
|
|
"github.com/couchbaselabs/bleve/document"
|
|
|
|
"github.com/couchbaselabs/bleve/index"
|
|
|
|
"github.com/couchbaselabs/bleve/index/store"
|
|
|
|
"github.com/couchbaselabs/bleve/index/upside_down"
|
2014-08-20 22:58:20 +02:00
|
|
|
"github.com/couchbaselabs/bleve/registry"
|
2014-07-30 18:30:38 +02:00
|
|
|
"github.com/couchbaselabs/bleve/search"
|
|
|
|
)
|
|
|
|
|
|
|
|
type indexImpl struct {
|
2014-08-25 15:06:53 +02:00
|
|
|
path string
|
|
|
|
meta *indexMeta
|
|
|
|
s store.KVStore
|
|
|
|
i index.Index
|
|
|
|
m *IndexMapping
|
|
|
|
mutex sync.RWMutex
|
|
|
|
open bool
|
2014-08-20 22:58:20 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
const storePath = "store"
|
|
|
|
|
|
|
|
var mappingInternalKey = []byte("_mapping")
|
|
|
|
|
|
|
|
func indexStorePath(path string) string {
|
|
|
|
return path + string(os.PathSeparator) + storePath
|
|
|
|
}
|
|
|
|
|
|
|
|
func newMemIndex(mapping *IndexMapping) (*indexImpl, error) {
|
|
|
|
rv := indexImpl{
|
|
|
|
path: "",
|
|
|
|
m: mapping,
|
|
|
|
meta: NewIndexMeta("mem"),
|
|
|
|
}
|
|
|
|
|
|
|
|
storeConstructor := registry.KVStoreConstructorByName(rv.meta.Storage)
|
|
|
|
if storeConstructor == nil {
|
|
|
|
return nil, ERROR_UNKNOWN_STORAGE_TYPE
|
|
|
|
}
|
|
|
|
// now open the store
|
|
|
|
var err error
|
|
|
|
rv.s, err = storeConstructor(nil)
|
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
|
|
|
|
// open open the index
|
|
|
|
rv.i = upside_down.NewUpsideDownCouch(rv.s)
|
|
|
|
err = rv.i.Open()
|
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
|
|
|
|
// now persist the mapping
|
|
|
|
mappingBytes, err := json.Marshal(mapping)
|
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
err = rv.i.SetInternal(mappingInternalKey, mappingBytes)
|
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
2014-08-25 15:06:53 +02:00
|
|
|
|
|
|
|
// mark the index as open
|
|
|
|
rv.mutex.Lock()
|
|
|
|
defer rv.mutex.Unlock()
|
|
|
|
rv.open = true
|
2014-08-20 22:58:20 +02:00
|
|
|
return &rv, nil
|
2014-07-30 18:30:38 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
func newIndex(path string, mapping *IndexMapping) (*indexImpl, error) {
|
2014-08-20 22:58:20 +02:00
|
|
|
// first validate the mapping
|
2014-08-14 03:14:47 +02:00
|
|
|
err := mapping.Validate()
|
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
|
2014-08-20 22:58:20 +02:00
|
|
|
if path == "" {
|
|
|
|
return newMemIndex(mapping)
|
|
|
|
}
|
|
|
|
|
|
|
|
rv := indexImpl{
|
|
|
|
path: path,
|
|
|
|
m: mapping,
|
|
|
|
meta: NewIndexMeta(Config.DefaultKVStore),
|
|
|
|
}
|
|
|
|
storeConstructor := registry.KVStoreConstructorByName(rv.meta.Storage)
|
|
|
|
if storeConstructor == nil {
|
|
|
|
return nil, ERROR_UNKNOWN_STORAGE_TYPE
|
|
|
|
}
|
|
|
|
// at this point there hope we can be successful, so save index meta
|
|
|
|
err = rv.meta.Save(path)
|
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
storeConfig := map[string]interface{}{
|
|
|
|
"path": indexStorePath(path),
|
|
|
|
"create_if_missing": true,
|
|
|
|
"error_if_exists": true,
|
|
|
|
}
|
|
|
|
|
|
|
|
// now open the store
|
|
|
|
rv.s, err = storeConstructor(storeConfig)
|
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
|
|
|
|
// open open the index
|
|
|
|
rv.i = upside_down.NewUpsideDownCouch(rv.s)
|
|
|
|
err = rv.i.Open()
|
2014-07-30 18:30:38 +02:00
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
2014-08-20 22:58:20 +02:00
|
|
|
|
|
|
|
// now persist the mapping
|
|
|
|
mappingBytes, err := json.Marshal(mapping)
|
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
err = rv.i.SetInternal(mappingInternalKey, mappingBytes)
|
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
2014-08-25 15:06:53 +02:00
|
|
|
|
|
|
|
// mark the index as open
|
|
|
|
rv.mutex.Lock()
|
|
|
|
defer rv.mutex.Unlock()
|
|
|
|
rv.open = true
|
2014-08-20 22:58:20 +02:00
|
|
|
return &rv, nil
|
|
|
|
}
|
|
|
|
|
|
|
|
func openIndex(path string) (*indexImpl, error) {
|
|
|
|
|
|
|
|
rv := indexImpl{
|
|
|
|
path: path,
|
|
|
|
}
|
|
|
|
var err error
|
|
|
|
rv.meta, err = OpenIndexMeta(path)
|
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
|
|
|
|
storeConstructor := registry.KVStoreConstructorByName(rv.meta.Storage)
|
|
|
|
if storeConstructor == nil {
|
|
|
|
return nil, ERROR_UNKNOWN_STORAGE_TYPE
|
|
|
|
}
|
|
|
|
|
|
|
|
storeConfig := map[string]interface{}{
|
|
|
|
"path": indexStorePath(path),
|
|
|
|
"create_if_missing": false,
|
|
|
|
"error_if_exists": false,
|
|
|
|
}
|
|
|
|
|
|
|
|
// now open the store
|
|
|
|
rv.s, err = storeConstructor(storeConfig)
|
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
|
|
|
|
// open open the index
|
|
|
|
rv.i = upside_down.NewUpsideDownCouch(rv.s)
|
|
|
|
err = rv.i.Open()
|
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
|
|
|
|
// now load the mapping
|
|
|
|
mappingBytes, err := rv.i.GetInternal(mappingInternalKey)
|
2014-07-30 18:30:38 +02:00
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
2014-08-20 22:58:20 +02:00
|
|
|
|
|
|
|
var im IndexMapping
|
|
|
|
err = json.Unmarshal(mappingBytes, &im)
|
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
|
2014-08-25 15:06:53 +02:00
|
|
|
// mark the index as open
|
|
|
|
rv.mutex.Lock()
|
|
|
|
defer rv.mutex.Unlock()
|
|
|
|
rv.open = true
|
|
|
|
|
2014-08-20 22:58:20 +02:00
|
|
|
// validate the mapping
|
|
|
|
err = im.Validate()
|
|
|
|
if err != nil {
|
2014-08-25 15:06:53 +02:00
|
|
|
// note even if the mapping is invalid
|
|
|
|
// we still return an open usable index
|
|
|
|
return &rv, err
|
2014-08-20 22:58:20 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
rv.m = &im
|
|
|
|
return &rv, nil
|
2014-07-30 18:30:38 +02:00
|
|
|
}
|
|
|
|
|
2014-08-25 15:06:53 +02:00
|
|
|
func (i *indexImpl) Mapping() *IndexMapping {
|
|
|
|
return i.m
|
|
|
|
}
|
|
|
|
|
2014-08-11 18:47:29 +02:00
|
|
|
func (i *indexImpl) Index(id string, data interface{}) error {
|
2014-08-25 15:06:53 +02:00
|
|
|
i.mutex.Lock()
|
|
|
|
defer i.mutex.Unlock()
|
|
|
|
|
|
|
|
if !i.open {
|
|
|
|
return ERROR_INDEX_CLOSED
|
|
|
|
}
|
|
|
|
|
2014-07-30 18:30:38 +02:00
|
|
|
doc := document.NewDocument(id)
|
|
|
|
err := i.m.MapDocument(doc, data)
|
|
|
|
if err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
err = i.i.Update(doc)
|
|
|
|
if err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
2014-08-11 18:47:29 +02:00
|
|
|
func (i *indexImpl) Delete(id string) error {
|
2014-08-25 15:06:53 +02:00
|
|
|
i.mutex.Lock()
|
|
|
|
defer i.mutex.Unlock()
|
|
|
|
|
|
|
|
if !i.open {
|
|
|
|
return ERROR_INDEX_CLOSED
|
|
|
|
}
|
|
|
|
|
2014-07-30 18:30:38 +02:00
|
|
|
err := i.i.Delete(id)
|
|
|
|
if err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
2014-08-11 22:27:18 +02:00
|
|
|
func (i *indexImpl) Batch(b Batch) error {
|
2014-08-25 15:06:53 +02:00
|
|
|
i.mutex.Lock()
|
|
|
|
defer i.mutex.Unlock()
|
|
|
|
|
|
|
|
if !i.open {
|
|
|
|
return ERROR_INDEX_CLOSED
|
|
|
|
}
|
|
|
|
|
2014-08-11 22:27:18 +02:00
|
|
|
ib := make(index.Batch, len(b))
|
|
|
|
for bk, bd := range b {
|
|
|
|
if bd == nil {
|
|
|
|
ib.Delete(bk)
|
|
|
|
} else {
|
|
|
|
doc := document.NewDocument(bk)
|
|
|
|
err := i.m.MapDocument(doc, bd)
|
|
|
|
if err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
ib.Index(bk, doc)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return i.i.Batch(ib)
|
|
|
|
}
|
|
|
|
|
2014-07-30 18:30:38 +02:00
|
|
|
func (i *indexImpl) Document(id string) (*document.Document, error) {
|
2014-08-25 15:06:53 +02:00
|
|
|
i.mutex.RLock()
|
|
|
|
defer i.mutex.RUnlock()
|
|
|
|
|
|
|
|
if !i.open {
|
|
|
|
return nil, ERROR_INDEX_CLOSED
|
|
|
|
}
|
2014-07-30 18:30:38 +02:00
|
|
|
return i.i.Document(id)
|
|
|
|
}
|
|
|
|
|
|
|
|
func (i *indexImpl) DocCount() uint64 {
|
2014-08-25 15:06:53 +02:00
|
|
|
i.mutex.RLock()
|
|
|
|
defer i.mutex.RUnlock()
|
|
|
|
|
|
|
|
if !i.open {
|
|
|
|
return 0
|
|
|
|
}
|
|
|
|
|
2014-07-30 18:30:38 +02:00
|
|
|
return i.i.DocCount()
|
|
|
|
}
|
|
|
|
|
|
|
|
func (i *indexImpl) Search(req *SearchRequest) (*SearchResult, error) {
|
2014-08-25 15:06:53 +02:00
|
|
|
i.mutex.RLock()
|
|
|
|
defer i.mutex.RUnlock()
|
|
|
|
|
|
|
|
if !i.open {
|
|
|
|
return nil, ERROR_INDEX_CLOSED
|
|
|
|
}
|
|
|
|
|
2014-07-30 18:30:38 +02:00
|
|
|
collector := search.NewTopScorerSkipCollector(req.Size, req.From)
|
|
|
|
searcher, err := req.Query.Searcher(i, req.Explain)
|
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
2014-08-25 21:13:15 +02:00
|
|
|
defer searcher.Close()
|
2014-08-11 17:03:29 +02:00
|
|
|
|
|
|
|
if req.Facets != nil {
|
|
|
|
facetsBuilder := search.NewFacetsBuilder(i.i)
|
|
|
|
for facetName, facetRequest := range req.Facets {
|
|
|
|
if facetRequest.NumericRanges != nil {
|
|
|
|
// build numeric range facet
|
|
|
|
facetBuilder := search.NewNumericFacetBuilder(facetRequest.Field, facetRequest.Size)
|
|
|
|
for _, nr := range facetRequest.NumericRanges {
|
|
|
|
facetBuilder.AddRange(nr.Name, nr.Min, nr.Max)
|
|
|
|
}
|
|
|
|
facetsBuilder.Add(facetName, facetBuilder)
|
|
|
|
} else if facetRequest.DateTimeRanges != nil {
|
|
|
|
// build date range facet
|
|
|
|
facetBuilder := search.NewDateTimeFacetBuilder(facetRequest.Field, facetRequest.Size)
|
2014-08-14 03:14:47 +02:00
|
|
|
dateTimeParser := i.m.DateTimeParserNamed(i.m.DefaultDateTimeParser)
|
2014-08-11 17:03:29 +02:00
|
|
|
for _, dr := range facetRequest.DateTimeRanges {
|
2014-08-14 03:14:47 +02:00
|
|
|
dr.ParseDates(dateTimeParser)
|
2014-08-11 17:03:29 +02:00
|
|
|
facetBuilder.AddRange(dr.Name, dr.Start, dr.End)
|
|
|
|
}
|
|
|
|
facetsBuilder.Add(facetName, facetBuilder)
|
|
|
|
} else {
|
|
|
|
// build terms facet
|
|
|
|
facetBuilder := search.NewTermsFacetBuilder(facetRequest.Field, facetRequest.Size)
|
|
|
|
facetsBuilder.Add(facetName, facetBuilder)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
collector.SetFacetsBuilder(facetsBuilder)
|
|
|
|
}
|
|
|
|
|
2014-07-30 18:30:38 +02:00
|
|
|
err = collector.Collect(searcher)
|
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
|
|
|
|
hits := collector.Results()
|
|
|
|
|
|
|
|
if req.Highlight != nil {
|
|
|
|
// get the right highlighter
|
2014-07-30 20:29:26 +02:00
|
|
|
highlighter := Config.Highlight.Highlighters[*Config.DefaultHighlighter]
|
2014-07-30 18:30:38 +02:00
|
|
|
if req.Highlight.Style != nil {
|
2014-07-30 20:29:26 +02:00
|
|
|
highlighter = Config.Highlight.Highlighters[*req.Highlight.Style]
|
2014-07-30 18:30:38 +02:00
|
|
|
if highlighter == nil {
|
2014-07-30 18:43:05 +02:00
|
|
|
return nil, fmt.Errorf("no highlighter named `%s` registered", *req.Highlight.Style)
|
2014-07-30 18:30:38 +02:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
for _, hit := range hits {
|
|
|
|
doc, err := i.Document(hit.ID)
|
|
|
|
if err == nil {
|
|
|
|
highlightFields := req.Highlight.Fields
|
|
|
|
if highlightFields == nil {
|
|
|
|
// add all fields with matches
|
|
|
|
highlightFields = make([]string, 0, len(hit.Locations))
|
|
|
|
for k, _ := range hit.Locations {
|
|
|
|
highlightFields = append(highlightFields, k)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
for _, hf := range highlightFields {
|
2014-08-28 20:45:51 +02:00
|
|
|
highlighter.BestFragmentsInField(hit, doc, hf, 1)
|
2014-07-30 18:30:38 +02:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2014-08-06 19:52:20 +02:00
|
|
|
if len(req.Fields) > 0 {
|
|
|
|
for _, hit := range hits {
|
|
|
|
// FIXME avoid loading doc second time
|
|
|
|
// if we already loaded it for highlighting
|
|
|
|
doc, err := i.Document(hit.ID)
|
|
|
|
if err == nil {
|
|
|
|
for _, f := range req.Fields {
|
|
|
|
for _, docF := range doc.Fields {
|
|
|
|
if docF.Name() == f {
|
|
|
|
var value interface{}
|
|
|
|
switch docF := docF.(type) {
|
|
|
|
case *document.TextField:
|
|
|
|
value = string(docF.Value())
|
|
|
|
case *document.NumericField:
|
|
|
|
num, err := docF.Number()
|
|
|
|
if err == nil {
|
|
|
|
value = num
|
|
|
|
}
|
|
|
|
case *document.DateTimeField:
|
|
|
|
datetime, err := docF.DateTime()
|
|
|
|
if err == nil {
|
|
|
|
value = datetime.Format(time.RFC3339)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
if value != nil {
|
|
|
|
hit.AddFieldValue(f, value)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2014-07-30 18:30:38 +02:00
|
|
|
return &SearchResult{
|
|
|
|
Request: req,
|
|
|
|
Hits: hits,
|
|
|
|
Total: collector.Total(),
|
|
|
|
MaxScore: collector.MaxScore(),
|
|
|
|
Took: collector.Took(),
|
2014-08-11 17:03:29 +02:00
|
|
|
Facets: collector.FacetResults(),
|
2014-07-30 18:30:38 +02:00
|
|
|
}, nil
|
|
|
|
}
|
|
|
|
|
2014-08-15 19:12:55 +02:00
|
|
|
func (i *indexImpl) DumpAll() chan interface{} {
|
2014-08-25 15:06:53 +02:00
|
|
|
i.mutex.RLock()
|
|
|
|
defer i.mutex.RUnlock()
|
|
|
|
|
|
|
|
if !i.open {
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
2014-08-15 19:12:55 +02:00
|
|
|
return i.i.DumpAll()
|
2014-07-30 20:29:26 +02:00
|
|
|
}
|
|
|
|
|
2014-07-31 17:47:36 +02:00
|
|
|
func (i *indexImpl) Fields() ([]string, error) {
|
2014-08-25 15:06:53 +02:00
|
|
|
i.mutex.RLock()
|
|
|
|
defer i.mutex.RUnlock()
|
|
|
|
|
|
|
|
if !i.open {
|
|
|
|
return nil, ERROR_INDEX_CLOSED
|
|
|
|
}
|
2014-07-31 17:47:36 +02:00
|
|
|
return i.i.Fields()
|
|
|
|
}
|
|
|
|
|
2014-08-15 19:12:55 +02:00
|
|
|
func (i *indexImpl) DumpFields() chan interface{} {
|
2014-08-25 15:06:53 +02:00
|
|
|
i.mutex.RLock()
|
|
|
|
defer i.mutex.RUnlock()
|
|
|
|
|
|
|
|
if !i.open {
|
|
|
|
return nil
|
|
|
|
}
|
2014-08-15 19:12:55 +02:00
|
|
|
return i.i.DumpFields()
|
2014-07-30 20:29:26 +02:00
|
|
|
}
|
|
|
|
|
2014-08-15 19:12:55 +02:00
|
|
|
func (i *indexImpl) DumpDoc(id string) chan interface{} {
|
2014-08-25 15:06:53 +02:00
|
|
|
i.mutex.RLock()
|
|
|
|
defer i.mutex.RUnlock()
|
|
|
|
|
|
|
|
if !i.open {
|
|
|
|
return nil
|
|
|
|
}
|
2014-07-30 18:30:38 +02:00
|
|
|
return i.i.DumpDoc(id)
|
|
|
|
}
|
|
|
|
|
|
|
|
func (i *indexImpl) Close() {
|
2014-08-25 15:06:53 +02:00
|
|
|
i.mutex.Lock()
|
|
|
|
defer i.mutex.Unlock()
|
|
|
|
|
|
|
|
i.open = false
|
2014-07-30 18:30:38 +02:00
|
|
|
i.i.Close()
|
|
|
|
}
|