bleve: github.com/blevesearch/bleve Index | Examples | Files | Directories

package bleve

import "github.com/blevesearch/bleve"

Package bleve is a library for indexing and searching text.

Example Opening New Index, Indexing Data

message := struct{
    Id:   "example"
    From: "marty.schoch@gmail.com",
    Body: "bleve indexing is easy",
}

mapping := bleve.NewIndexMapping()
index, _ := bleve.New("example.bleve", mapping)
index.Index(message.Id, message)

Example Opening Existing Index, Searching Data

index, _ := bleve.Open("example.bleve")
query := bleve.NewQueryStringQuery("bleve")
searchRequest := bleve.NewSearchRequest(query)
searchResult, _ := index.Search(searchRequest)

Index

Examples

Package Files

config.go config_disk.go doc.go error.go index.go index_alias.go index_alias_impl.go index_impl.go index_meta.go index_stats.go mapping.go query.go search.go

Variables

var Config *configuration

Config contains library level configuration

func NewBoolFieldQuery Uses

func NewBoolFieldQuery(val bool) *query.BoolFieldQuery

NewBoolFieldQuery creates a new Query for boolean fields

func NewBooleanFieldMapping Uses

func NewBooleanFieldMapping() *mapping.FieldMapping

NewBooleanFieldMapping returns a default field mapping for booleans

func NewBooleanQuery Uses

func NewBooleanQuery() *query.BooleanQuery

NewBooleanQuery creates a compound Query composed of several other Query objects. These other query objects are added using the AddMust() AddShould() and AddMustNot() methods. 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.

Code:

must := NewMatchQuery("one")
mustNot := NewMatchQuery("great")
query := NewBooleanQuery()
query.AddMust(must)
query.AddMustNot(mustNot)
searchRequest := NewSearchRequest(query)
searchResults, err := exampleIndex.Search(searchRequest)
if err != nil {
    panic(err)
}

fmt.Println(searchResults.Hits[0].ID)

Output:

document id 1

func NewConjunctionQuery Uses

func NewConjunctionQuery(conjuncts ...query.Query) *query.ConjunctionQuery

NewConjunctionQuery creates a new compound Query. Result documents must satisfy all of the queries.

Code:

conjunct1 := NewMatchQuery("great")
conjunct2 := NewMatchQuery("one")
query := NewConjunctionQuery(conjunct1, conjunct2)
searchRequest := NewSearchRequest(query)
searchResults, err := exampleIndex.Search(searchRequest)
if err != nil {
    panic(err)
}

fmt.Println(searchResults.Hits[0].ID)

Output:

document id 2

func NewDateRangeInclusiveQuery Uses

func NewDateRangeInclusiveQuery(start, end time.Time, startInclusive, endInclusive *bool) *query.DateRangeQuery

NewDateRangeInclusiveQuery creates a new Query for ranges of date values. Date strings are parsed using the DateTimeParser configured in the

top-level config.QueryDateTimeParser

Either, but not both endpoints can be nil. startInclusive and endInclusive control inclusion of the endpoints.

func NewDateRangeQuery Uses

func NewDateRangeQuery(start, end time.Time) *query.DateRangeQuery

NewDateRangeQuery creates a new Query for ranges of date values. Date strings are parsed using the DateTimeParser configured in the

top-level config.QueryDateTimeParser

Either, but not both endpoints can be nil.

func NewDateTimeFieldMapping Uses

func NewDateTimeFieldMapping() *mapping.FieldMapping

NewDateTimeFieldMapping returns a default field mapping for dates

func NewDisjunctionQuery Uses

func NewDisjunctionQuery(disjuncts ...query.Query) *query.DisjunctionQuery

NewDisjunctionQuery creates a new compound Query. Result documents satisfy at least one Query.

Code:

disjunct1 := NewMatchQuery("great")
disjunct2 := NewMatchQuery("named")
query := NewDisjunctionQuery(disjunct1, disjunct2)
searchRequest := NewSearchRequest(query)
searchResults, err := exampleIndex.Search(searchRequest)
if err != nil {
    panic(err)
}

fmt.Println(len(searchResults.Hits))

Output:

2

func NewDocIDQuery Uses

func NewDocIDQuery(ids []string) *query.DocIDQuery

NewDocIDQuery creates a new Query object returning indexed documents among the specified set. Combine it with ConjunctionQuery to restrict the scope of other queries output.

func NewDocumentDisabledMapping Uses

func NewDocumentDisabledMapping() *mapping.DocumentMapping

NewDocumentDisabledMapping returns a new document mapping that will not perform any indexing.

func NewDocumentMapping Uses

func NewDocumentMapping() *mapping.DocumentMapping

NewDocumentMapping returns a new document mapping with all the default values.

func NewDocumentStaticMapping Uses

func NewDocumentStaticMapping() *mapping.DocumentMapping

NewDocumentStaticMapping returns a new document mapping that will not automatically index parts of a document without an explicit mapping.

func NewFuzzyQuery Uses

func NewFuzzyQuery(term string) *query.FuzzyQuery

NewFuzzyQuery creates a new Query which finds documents containing terms within a specific fuzziness of the specified term. The default fuzziness is 1.

The current implementation uses Levenshtein edit distance as the fuzziness metric.

func NewGeoBoundingBoxQuery Uses

func NewGeoBoundingBoxQuery(topLeftLon, topLeftLat, bottomRightLon, bottomRightLat float64) *query.GeoBoundingBoxQuery

NewGeoBoundingBoxQuery creates a new Query for performing geo bounding box searches. The arguments describe the position of the box and documents which have an indexed geo point inside the box will be returned.

func NewGeoDistanceQuery Uses

func NewGeoDistanceQuery(lon, lat float64, distance string) *query.GeoDistanceQuery

NewGeoDistanceQuery creates a new Query for performing geo bounding box searches. The arguments describe a position and a distance. Documents which have an indexed geo point which is less than or equal to the provided distance from the given position will be returned.

func NewGeoPointFieldMapping Uses

func NewGeoPointFieldMapping() *mapping.FieldMapping

func NewIndexAlias Uses

func NewIndexAlias(indexes ...Index) *indexAliasImpl

NewIndexAlias creates a new IndexAlias over the provided Index objects.

func NewIndexMapping Uses

func NewIndexMapping() *mapping.IndexMappingImpl

NewIndexMapping creates a new IndexMapping that will use all the default indexing rules

func NewMatchAllQuery Uses

func NewMatchAllQuery() *query.MatchAllQuery

NewMatchAllQuery creates a Query which will match all documents in the index.

Code:

// finds all documents in the index
query := NewMatchAllQuery()
searchRequest := NewSearchRequest(query)
searchResults, err := exampleIndex.Search(searchRequest)
if err != nil {
    panic(err)
}

fmt.Println(len(searchResults.Hits))

Output:

2

func NewMatchNoneQuery Uses

func NewMatchNoneQuery() *query.MatchNoneQuery

NewMatchNoneQuery creates a Query which will not match any documents in the index.

Code:

// matches no documents in the index
query := NewMatchNoneQuery()
searchRequest := NewSearchRequest(query)
searchResults, err := exampleIndex.Search(searchRequest)
if err != nil {
    panic(err)
}

fmt.Println(len(searchResults.Hits))

Output:

0

func NewMatchPhraseQuery Uses

func NewMatchPhraseQuery(matchPhrase string) *query.MatchPhraseQuery

NewMatchPhraseQuery creates a new Query object for matching phrases in the index. An Analyzer is chosen based on the field. Input text is analyzed using this analyzer. Token terms resulting from this analysis are used to build a search phrase. Result documents must match this phrase. Queried field must have been indexed with IncludeTermVectors set to true.

Code:

// finds all documents with the given phrase in the index
query := NewMatchPhraseQuery("nameless one")
searchRequest := NewSearchRequest(query)
searchResults, err := exampleIndex.Search(searchRequest)
if err != nil {
    panic(err)
}

fmt.Println(searchResults.Hits[0].ID)

Output:

document id 2

func NewMatchQuery Uses

func NewMatchQuery(match string) *query.MatchQuery

NewMatchQuery creates a Query for matching text. An Analyzer is chosen based on the field. Input text is analyzed using this analyzer. Token terms resulting from this analysis are used to perform term searches. Result documents must satisfy at least one of these term searches.

Code:

// finds documents with fields fully matching the given query text
query := NewMatchQuery("named one")
searchRequest := NewSearchRequest(query)
searchResults, err := exampleIndex.Search(searchRequest)
if err != nil {
    panic(err)
}

fmt.Println(searchResults.Hits[0].ID)

Output:

document id 1

func NewNumericFieldMapping Uses

func NewNumericFieldMapping() *mapping.FieldMapping

NewNumericFieldMapping returns a default field mapping for numbers

func NewNumericRangeInclusiveQuery Uses

func NewNumericRangeInclusiveQuery(min, max *float64, minInclusive, maxInclusive *bool) *query.NumericRangeQuery

NewNumericRangeInclusiveQuery creates a new Query for ranges of numeric values. Either, but not both endpoints can be nil. Control endpoint inclusion with inclusiveMin, inclusiveMax.

Code:

value1 := float64(10)
value2 := float64(100)
v1incl := false
v2incl := false

query := NewNumericRangeInclusiveQuery(&value1, &value2, &v1incl, &v2incl)
searchRequest := NewSearchRequest(query)
searchResults, err := exampleIndex.Search(searchRequest)
if err != nil {
    panic(err)
}

fmt.Println(searchResults.Hits[0].ID)

Output:

document id 3

func NewNumericRangeQuery Uses

func NewNumericRangeQuery(min, max *float64) *query.NumericRangeQuery

NewNumericRangeQuery creates a new Query for ranges of numeric values. Either, but not both endpoints can be nil. The minimum value is inclusive. The maximum value is exclusive.

Code:

value1 := float64(11)
value2 := float64(100)
data := struct{ Priority float64 }{Priority: float64(15)}
data2 := struct{ Priority float64 }{Priority: float64(10)}

err = exampleIndex.Index("document id 3", data)
if err != nil {
    panic(err)
}
err = exampleIndex.Index("document id 4", data2)
if err != nil {
    panic(err)
}

query := NewNumericRangeQuery(&value1, &value2)
searchRequest := NewSearchRequest(query)
searchResults, err := exampleIndex.Search(searchRequest)
if err != nil {
    panic(err)
}

fmt.Println(searchResults.Hits[0].ID)

Output:

document id 3

func NewPhraseQuery Uses

func NewPhraseQuery(terms []string, field string) *query.PhraseQuery

NewPhraseQuery creates a new Query for finding exact term phrases in the index. The provided terms must exist in the correct order, at the correct index offsets, in the specified field. Queried field must have been indexed with IncludeTermVectors set to true.

Code:

// finds all documents with the given phrases in the given field in the index
query := NewPhraseQuery([]string{"nameless", "one"}, "Name")
searchRequest := NewSearchRequest(query)
searchResults, err := exampleIndex.Search(searchRequest)
if err != nil {
    panic(err)
}

fmt.Println(searchResults.Hits[0].ID)

Output:

document id 2

func NewPrefixQuery Uses

func NewPrefixQuery(prefix string) *query.PrefixQuery

NewPrefixQuery creates a new Query which finds documents containing terms that start with the specified prefix.

Code:

// finds all documents with terms having the given prefix in the index
query := NewPrefixQuery("name")
searchRequest := NewSearchRequest(query)
searchResults, err := exampleIndex.Search(searchRequest)
if err != nil {
    panic(err)
}

fmt.Println(len(searchResults.Hits))

Output:

2

func NewQueryStringQuery Uses

func NewQueryStringQuery(q string) *query.QueryStringQuery

NewQueryStringQuery creates a new Query used for finding documents that satisfy a query string. The query string is a small query language for humans.

Code:

query := NewQueryStringQuery("+one -great")
searchRequest := NewSearchRequest(query)
searchResults, err := exampleIndex.Search(searchRequest)
if err != nil {
    panic(err)
}

fmt.Println(searchResults.Hits[0].ID)

Output:

document id 1

func NewRegexpQuery Uses

func NewRegexpQuery(regexp string) *query.RegexpQuery

NewRegexpQuery creates a new Query which finds documents containing terms that match the specified regular expression.

func NewTermQuery Uses

func NewTermQuery(term string) *query.TermQuery

NewTermQuery creates a new Query for finding an exact term match in the index.

Code:

query := NewTermQuery("great")
searchRequest := NewSearchRequest(query)
searchResults, err := exampleIndex.Search(searchRequest)
if err != nil {
    panic(err)
}

fmt.Println(searchResults.Hits[0].ID)

Output:

document id 2

func NewTermRangeInclusiveQuery Uses

func NewTermRangeInclusiveQuery(min, max string, minInclusive, maxInclusive *bool) *query.TermRangeQuery

NewTermRangeInclusiveQuery creates a new Query for ranges of text terms. Either, but not both endpoints can be "". Control endpoint inclusion with inclusiveMin, inclusiveMax.

func NewTermRangeQuery Uses

func NewTermRangeQuery(min, max string) *query.TermRangeQuery

NewTermRangeQuery creates a new Query for ranges of text terms. Either, but not both endpoints can be "". The minimum value is inclusive. The maximum value is exclusive.

func NewTextFieldMapping Uses

func NewTextFieldMapping() *mapping.FieldMapping

NewTextFieldMapping returns a default field mapping for text

func NewWildcardQuery Uses

func NewWildcardQuery(wildcard string) *query.WildcardQuery

NewWildcardQuery creates a new Query which finds documents containing terms that match the specified wildcard. In the wildcard pattern '*' will match any sequence of 0 or more characters, and '?' will match any single character.

func SetLog Uses

func SetLog(l *log.Logger)

SetLog sets the logger used for logging by default log messages are sent to ioutil.Discard

type Batch Uses

type Batch struct {
    // contains filtered or unexported fields
}

A Batch groups together multiple Index and Delete operations you would like performed at the same time. The Batch structure is NOT thread-safe. You should only perform operations on a batch from a single thread at a time. Once batch execution has started, you may not modify it.

func (*Batch) Delete Uses

func (b *Batch) Delete(id string)

Delete adds the specified delete operation to the batch. NOTE: the bleve Index is not updated until the batch is executed.

func (*Batch) DeleteInternal Uses

func (b *Batch) DeleteInternal(key []byte)

SetInternal adds the specified delete internal operation to the batch. NOTE: the bleve Index is not updated until the batch is executed.

func (*Batch) Index Uses

func (b *Batch) Index(id string, data interface{}) error

Index adds the specified index operation to the batch. NOTE: the bleve Index is not updated until the batch is executed.

func (*Batch) IndexAdvanced Uses

func (b *Batch) IndexAdvanced(doc *document.Document) (err error)

IndexAdvanced adds the specified index operation to the batch which skips the mapping. NOTE: the bleve Index is not updated until the batch is executed.

func (*Batch) Reset Uses

func (b *Batch) Reset()

Reset returns a Batch to the empty state so that it can be re-used in the future.

func (*Batch) SetInternal Uses

func (b *Batch) SetInternal(key, val []byte)

SetInternal adds the specified set internal operation to the batch. NOTE: the bleve Index is not updated until the batch is executed.

func (*Batch) Size Uses

func (b *Batch) Size() int

Size returns the total number of operations inside the batch including normal index operations and internal operations.

func (*Batch) String Uses

func (b *Batch) String() string

String prints a user friendly string representation of what is inside this batch.

type Error Uses

type Error int

Error represents a more strongly typed bleve error for detecting and handling specific types of errors.

const (
    ErrorIndexPathExists Error = iota
    ErrorIndexPathDoesNotExist
    ErrorIndexMetaMissing
    ErrorIndexMetaCorrupt
    ErrorUnknownStorageType
    ErrorIndexClosed
    ErrorAliasMulti
    ErrorAliasEmpty
    ErrorUnknownIndexType
    ErrorEmptyID
    ErrorIndexReadInconsistency
)

Constant Error values which can be compared to determine the type of error

func (Error) Error Uses

func (e Error) Error() string

type FacetRequest Uses

type FacetRequest struct {
    Size           int              `json:"size"`
    Field          string           `json:"field"`
    NumericRanges  []*numericRange  `json:"numeric_ranges,omitempty"`
    DateTimeRanges []*dateTimeRange `json:"date_ranges,omitempty"`
}

A FacetRequest describes a facet or aggregation of the result document set you would like to be built.

func NewFacetRequest Uses

func NewFacetRequest(field string, size int) *FacetRequest

NewFacetRequest creates a facet on the specified field that limits the number of entries to the specified size.

Code:

facet := NewFacetRequest("Name", 1)
query := NewMatchAllQuery()
searchRequest := NewSearchRequest(query)
searchRequest.AddFacet("facet name", facet)
searchResults, err := exampleIndex.Search(searchRequest)
if err != nil {
    panic(err)
}

// total number of terms
fmt.Println(searchResults.Facets["facet name"].Total)
// numer of docs with no value for this field
fmt.Println(searchResults.Facets["facet name"].Missing)
// term with highest occurrences in field name
fmt.Println(searchResults.Facets["facet name"].Terms[0].Term)

Output:

5
2
one

func (*FacetRequest) AddDateTimeRange Uses

func (fr *FacetRequest) AddDateTimeRange(name string, start, end time.Time)

AddDateTimeRange adds a bucket to a field containing date values. Documents with a date value falling into this range are tabulated as part of this bucket/range.

Code:

facet := NewFacetRequest("Created", 1)
facet.AddDateTimeRange("range name", time.Unix(0, 0), time.Now())
query := NewMatchAllQuery()
searchRequest := NewSearchRequest(query)
searchRequest.AddFacet("facet name", facet)
searchResults, err := exampleIndex.Search(searchRequest)
if err != nil {
    panic(err)
}

// dates in field Created since starting of unix time till now
fmt.Println(searchResults.Facets["facet name"].DateRanges[0].Count)

Output:

2

func (*FacetRequest) AddDateTimeRangeString Uses

func (fr *FacetRequest) AddDateTimeRangeString(name string, start, end *string)

AddDateTimeRangeString adds a bucket to a field containing date values.

func (*FacetRequest) AddNumericRange Uses

func (fr *FacetRequest) AddNumericRange(name string, min, max *float64)

AddNumericRange adds a bucket to a field containing numeric values. Documents with a numeric value falling into this range are tabulated as part of this bucket/range.

Code:

value1 := float64(11)

facet := NewFacetRequest("Priority", 1)
facet.AddNumericRange("range name", &value1, nil)
query := NewMatchAllQuery()
searchRequest := NewSearchRequest(query)
searchRequest.AddFacet("facet name", facet)
searchResults, err := exampleIndex.Search(searchRequest)
if err != nil {
    panic(err)
}

// number documents with field Priority in the given range
fmt.Println(searchResults.Facets["facet name"].NumericRanges[0].Count)

Output:

1

func (*FacetRequest) Validate Uses

func (fr *FacetRequest) Validate() error

type FacetsRequest Uses

type FacetsRequest map[string]*FacetRequest

FacetsRequest groups together all the FacetRequest objects for a single query.

func (FacetsRequest) Validate Uses

func (fr FacetsRequest) Validate() error

type HighlightRequest Uses

type HighlightRequest struct {
    Style  *string  `json:"style"`
    Fields []string `json:"fields"`
}

HighlightRequest describes how field matches should be highlighted.

func NewHighlight Uses

func NewHighlight() *HighlightRequest

NewHighlight creates a default HighlightRequest.

Code:

query := NewMatchQuery("nameless")
searchRequest := NewSearchRequest(query)
searchRequest.Highlight = NewHighlight()
searchResults, err := exampleIndex.Search(searchRequest)
if err != nil {
    panic(err)
}

fmt.Println(searchResults.Hits[0].Fragments["Name"][0])

Output:

great <mark>nameless</mark> one

func NewHighlightWithStyle Uses

func NewHighlightWithStyle(style string) *HighlightRequest

NewHighlightWithStyle creates a HighlightRequest with an alternate style.

Code:

query := NewMatchQuery("nameless")
searchRequest := NewSearchRequest(query)
searchRequest.Highlight = NewHighlightWithStyle(ansi.Name)
searchResults, err := exampleIndex.Search(searchRequest)
if err != nil {
    panic(err)
}

fmt.Println(searchResults.Hits[0].Fragments["Name"][0])

Output:

great nameless one

func (*HighlightRequest) AddField Uses

func (h *HighlightRequest) AddField(field string)

type Index Uses

type Index interface {
    // Index analyzes, indexes or stores mapped data fields. Supplied
    // identifier is bound to analyzed data and will be retrieved by search
    // requests. See Index interface documentation for details about mapping
    // rules.
    Index(id string, data interface{}) error
    Delete(id string) error

    NewBatch() *Batch
    Batch(b *Batch) error

    // Document returns specified document or nil if the document is not
    // indexed or stored.
    Document(id string) (*document.Document, error)
    // DocCount returns the number of documents in the index.
    DocCount() (uint64, error)

    Search(req *SearchRequest) (*SearchResult, error)
    SearchInContext(ctx context.Context, req *SearchRequest) (*SearchResult, error)

    Fields() ([]string, error)

    FieldDict(field string) (index.FieldDict, error)
    FieldDictRange(field string, startTerm []byte, endTerm []byte) (index.FieldDict, error)
    FieldDictPrefix(field string, termPrefix []byte) (index.FieldDict, error)

    Close() error

    Mapping() mapping.IndexMapping

    Stats() *IndexStat
    StatsMap() map[string]interface{}

    GetInternal(key []byte) ([]byte, error)
    SetInternal(key, val []byte) error
    DeleteInternal(key []byte) error

    // Name returns the name of the index (by default this is the path)
    Name() string
    // SetName lets you assign your own logical name to this index
    SetName(string)

    // Advanced returns the indexer and data store, exposing lower level
    // methods to enumerate records and access data.
    Advanced() (index.Index, store.KVStore, error)
}

An Index implements all the indexing and searching capabilities of bleve. An Index can be created using the New() and Open() methods.

Index() takes an input value, deduces a DocumentMapping for its type, assigns string paths to its fields or values then applies field mappings on them.

The DocumentMapping used to index a value is deduced by the following rules: 1) If value implements mapping.bleveClassifier interface, resolve the mapping

from BleveType().

2) If value implements mapping.Classifier interface, resolve the mapping

from Type().

3) If value has a string field or value at IndexMapping.TypeField. (defaulting to "_type"), use it to resolve the mapping. Fields addressing is described below. 4) If IndexMapping.DefaultType is registered, return it. 5) Return IndexMapping.DefaultMapping.

Each field or nested field of the value is identified by a string path, then mapped to one or several FieldMappings which extract the result for analysis.

Struct values fields are identified by their "json:" tag, or by their name. Nested fields are identified by prefixing with their parent identifier, separated by a dot.

Map values entries are identified by their string key. Entries not indexed by strings are ignored. Entry values are identified recursively like struct fields.

Slice and array values are identified by their field name. Their elements are processed sequentially with the same FieldMapping.

String, float64 and time.Time values are identified by their field name. Other types are ignored.

Each value identifier is decomposed in its parts and recursively address SubDocumentMappings in the tree starting at the root DocumentMapping. If a mapping is found, all its FieldMappings are applied to the value. If no mapping is found and the root DocumentMapping is dynamic, default mappings are used based on value type and IndexMapping default configurations.

Finally, mapped values are analyzed, indexed or stored. See FieldMapping.Analyzer to know how an analyzer is resolved for a given field.

Examples:

type Date struct {
  Day string `json:"day"`
  Month string
  Year string
}

type Person struct {
  FirstName string `json:"first_name"`
  LastName string
  BirthDate Date `json:"birth_date"`
}

A Person value FirstName is mapped by the SubDocumentMapping at "first_name". Its LastName is mapped by the one at "LastName". The day of BirthDate is mapped to the SubDocumentMapping "day" of the root SubDocumentMapping "birth_date". It will appear as the "birth_date.day" field in the index. The month is mapped to "birth_date.Month".

Code:

data := struct {
    Name    string
    Created time.Time
    Age     int
}{Name: "named one", Created: time.Now(), Age: 50}
data2 := struct {
    Name    string
    Created time.Time
    Age     int
}{Name: "great nameless one", Created: time.Now(), Age: 25}

// index some data
err = exampleIndex.Index("document id 1", data)
if err != nil {
    panic(err)
}
err = exampleIndex.Index("document id 2", data2)
if err != nil {
    panic(err)
}

// 2 documents have been indexed
count, err := exampleIndex.DocCount()
if err != nil {
    panic(err)
}

fmt.Println(count)

Output:

2

func New Uses

func New(path string, mapping mapping.IndexMapping) (Index, error)

New index at the specified path, must not exist. The provided mapping will be used for all Index/Search operations.

Code:

indexMapping = NewIndexMapping()
exampleIndex, err = New("path_to_index", indexMapping)
if err != nil {
    panic(err)
}
count, err := exampleIndex.DocCount()
if err != nil {
    panic(err)
}

fmt.Println(count)

Output:

0

func NewMemOnly Uses

func NewMemOnly(mapping mapping.IndexMapping) (Index, error)

NewMemOnly creates a memory-only index. The contents of the index is NOT persisted, and will be lost once closed. The provided mapping will be used for all Index/Search operations.

func NewUsing Uses

func NewUsing(path string, mapping mapping.IndexMapping, indexType string, kvstore string, kvconfig map[string]interface{}) (Index, error)

NewUsing creates index at the specified path, which must not already exist. The provided mapping will be used for all Index/Search operations. The specified index type will be used. The specified kvstore implementation will be used and the provided kvconfig will be passed to its constructor. Note that currently the values of kvconfig must be able to be marshaled and unmarshaled using the encoding/json library (used when reading/writing the index metadata file).

func Open Uses

func Open(path string) (Index, error)

Open index at the specified path, must exist. The mapping used when it was created will be used for all Index/Search operations.

func OpenUsing Uses

func OpenUsing(path string, runtimeConfig map[string]interface{}) (Index, error)

OpenUsing opens index at the specified path, must exist. The mapping used when it was created will be used for all Index/Search operations. The provided runtimeConfig can override settings persisted when the kvstore was created.

type IndexAlias Uses

type IndexAlias interface {
    Index

    Add(i ...Index)
    Remove(i ...Index)
    Swap(in, out []Index)
}

An IndexAlias is a wrapper around one or more Index objects. It has two distinct modes of operation. 1. When it points to a single index, ALL index operations are valid and will be passed through to the underlying index. 2. When it points to more than one index, the only valid operation is Search. In this case the search will be performed across all the underlying indexes and the results merged. Calls to Add/Remove/Swap the underlying indexes are atomic, so you can safely change the underlying Index objects while other components are performing operations.

type IndexErrMap Uses

type IndexErrMap map[string]error

IndexErrMap tracks errors with the name of the index where it occurred

func (IndexErrMap) MarshalJSON Uses

func (iem IndexErrMap) MarshalJSON() ([]byte, error)

MarshalJSON seralizes the error into a string for JSON consumption

func (IndexErrMap) UnmarshalJSON Uses

func (iem IndexErrMap) UnmarshalJSON(data []byte) error

type IndexStat Uses

type IndexStat struct {
    // contains filtered or unexported fields
}

func (*IndexStat) MarshalJSON Uses

func (is *IndexStat) MarshalJSON() ([]byte, error)

type IndexStats Uses

type IndexStats struct {
    // contains filtered or unexported fields
}

func NewIndexStats Uses

func NewIndexStats() *IndexStats

func (*IndexStats) Register Uses

func (i *IndexStats) Register(index Index)

func (*IndexStats) String Uses

func (i *IndexStats) String() string

func (*IndexStats) UnRegister Uses

func (i *IndexStats) UnRegister(index Index)

type SearchRequest Uses

type SearchRequest struct {
    Query            query.Query       `json:"query"`
    Size             int               `json:"size"`
    From             int               `json:"from"`
    Highlight        *HighlightRequest `json:"highlight"`
    Fields           []string          `json:"fields"`
    Facets           FacetsRequest     `json:"facets"`
    Explain          bool              `json:"explain"`
    Sort             search.SortOrder  `json:"sort"`
    IncludeLocations bool              `json:"includeLocations"`
}

A SearchRequest describes all the parameters needed to search the index. Query is required. Size/From describe how much and which part of the result set to return. Highlight describes optional search result highlighting. Fields describes a list of field values which should be retrieved for result documents, provided they were stored while indexing. Facets describe the set of facets to be computed. Explain triggers inclusion of additional search result score explanations. Sort describes the desired order for the results to be returned.

A special field named "*" can be used to return all fields.

func NewSearchRequest Uses

func NewSearchRequest(q query.Query) *SearchRequest

NewSearchRequest creates a new SearchRequest for the Query, using default values for all other search parameters.

Code:

// finds documents with fields fully matching the given query text
query := NewMatchQuery("named one")
searchRequest := NewSearchRequest(query)
searchResults, err := exampleIndex.Search(searchRequest)
if err != nil {
    panic(err)
}

fmt.Println(searchResults.Hits[0].ID)

Output:

document id 1

func NewSearchRequestOptions Uses

func NewSearchRequestOptions(q query.Query, size, from int, explain bool) *SearchRequest

NewSearchRequestOptions creates a new SearchRequest for the Query, with the requested size, from and explanation search parameters. By default results are ordered by score, descending.

func (*SearchRequest) AddFacet Uses

func (r *SearchRequest) AddFacet(facetName string, f *FacetRequest)

AddFacet adds a FacetRequest to this SearchRequest

Code:

facet := NewFacetRequest("Name", 1)
query := NewMatchAllQuery()
searchRequest := NewSearchRequest(query)
searchRequest.AddFacet("facet name", facet)
searchResults, err := exampleIndex.Search(searchRequest)
if err != nil {
    panic(err)
}

// total number of terms
fmt.Println(searchResults.Facets["facet name"].Total)
// numer of docs with no value for this field
fmt.Println(searchResults.Facets["facet name"].Missing)
// term with highest occurrences in field name
fmt.Println(searchResults.Facets["facet name"].Terms[0].Term)

Output:

5
2
one

func (*SearchRequest) SortBy Uses

func (r *SearchRequest) SortBy(order []string)

SortBy changes the request to use the requested sort order this form uses the simplified syntax with an array of strings each string can either be a field name or the magic value _id and _score which refer to the doc id and search score any of these values can optionally be prefixed with - to reverse the order

Code:

// find docs containing "one", order by Age instead of score
query := NewMatchQuery("one")
searchRequest := NewSearchRequest(query)
searchRequest.SortBy([]string{"Age"})
searchResults, err := exampleIndex.Search(searchRequest)
if err != nil {
    panic(err)
}

fmt.Println(searchResults.Hits[0].ID)
fmt.Println(searchResults.Hits[1].ID)

Output:

document id 2
document id 1

func (*SearchRequest) SortByCustom Uses

func (r *SearchRequest) SortByCustom(order search.SortOrder)

SortByCustom changes the request to use the requested sort order

Code:

// find all docs, order by Age, with docs missing Age field first
query := NewMatchAllQuery()
searchRequest := NewSearchRequest(query)
searchRequest.SortByCustom(search.SortOrder{
    &search.SortField{
        Field:   "Age",
        Missing: search.SortFieldMissingFirst,
    },
})
searchResults, err := exampleIndex.Search(searchRequest)
if err != nil {
    panic(err)
}

fmt.Println(searchResults.Hits[0].ID)
fmt.Println(searchResults.Hits[1].ID)
fmt.Println(searchResults.Hits[2].ID)
fmt.Println(searchResults.Hits[3].ID)

Output:

document id 3
document id 4
document id 2
document id 1

func (*SearchRequest) UnmarshalJSON Uses

func (r *SearchRequest) UnmarshalJSON(input []byte) error

UnmarshalJSON deserializes a JSON representation of a SearchRequest

func (*SearchRequest) Validate Uses

func (r *SearchRequest) Validate() error

type SearchResult Uses

type SearchResult struct {
    Status   *SearchStatus                  `json:"status"`
    Request  *SearchRequest                 `json:"request"`
    Hits     search.DocumentMatchCollection `json:"hits"`
    Total    uint64                         `json:"total_hits"`
    MaxScore float64                        `json:"max_score"`
    Took     time.Duration                  `json:"took"`
    Facets   search.FacetResults            `json:"facets"`
}

A SearchResult describes the results of executing a SearchRequest.

func MultiSearch Uses

func MultiSearch(ctx context.Context, req *SearchRequest, indexes ...Index) (*SearchResult, error)

MultiSearch executes a SearchRequest across multiple Index objects, then merges the results. The indexes must honor any ctx deadline.

func (*SearchResult) Merge Uses

func (sr *SearchResult) Merge(other *SearchResult)

Merge will merge together multiple SearchResults during a MultiSearch

func (*SearchResult) String Uses

func (sr *SearchResult) String() string

type SearchStatus Uses

type SearchStatus struct {
    Total      int         `json:"total"`
    Failed     int         `json:"failed"`
    Successful int         `json:"successful"`
    Errors     IndexErrMap `json:"errors,omitempty"`
}

SearchStatus is a secion in the SearchResult reporting how many underlying indexes were queried, how many were successful/failed and a map of any errors that were encountered

func (*SearchStatus) Merge Uses

func (ss *SearchStatus) Merge(other *SearchStatus)

Merge will merge together multiple SearchStatuses during a MultiSearch

Directories

PathSynopsis
analysis
analysis/analyzer/custom
analysis/analyzer/keyword
analysis/analyzer/simple
analysis/analyzer/standard
analysis/analyzer/web
analysis/char/html
analysis/char/regexp
analysis/char/zerowidthnonjoiner
analysis/datetime/flexible
analysis/datetime/optional
analysis/lang/ar
analysis/lang/bg
analysis/lang/ca
analysis/lang/cjk
analysis/lang/ckb
analysis/lang/cs
analysis/lang/de
analysis/lang/el
analysis/lang/enPackage en implements an analyzer with reasonable defaults for processing English text.
analysis/lang/es
analysis/lang/eu
analysis/lang/fa
analysis/lang/fr
analysis/lang/ga
analysis/lang/gl
analysis/lang/hi
analysis/lang/hy
analysis/lang/id
analysis/lang/in
analysis/lang/it
analysis/lang/pt
analysis/token/apostrophe
analysis/token/camelcase
analysis/token/compound
analysis/token/edgengram
analysis/token/elision
analysis/tokenizer/character
analysis/tokenizer/exceptionpackage exception implements a Tokenizer which extracts pieces matched by a regular expression from the input data, delegates the rest to another tokenizer, then insert back extracted parts in the token stream.
analysis/tokenizer/letter
analysis/tokenizer/regexp
analysis/tokenizer/single
analysis/tokenizer/unicode
analysis/tokenizer/web
analysis/tokenizer/whitespace
analysis/token/keyword
analysis/token/length
analysis/token/lowercasePackage lowercase implements a TokenFilter which converts tokens to lower case according to unicode rules.
analysis/tokenmappackage token_map implements a generic TokenMap, often used in conjunction with filters to remove or process specific tokens.
analysis/token/ngram
analysis/token/porter
analysis/token/shingle
analysis/token/stopPackage stop implements a TokenFilter removing tokens found in a TokenMap.
analysis/token/truncate
analysis/token/unicodenorm
cmd/bleve
cmd/bleve/cmd
config
document
geo
http
index
index/store
index/store/boltdbPackage boltdb implements a store.KVStore on top of BoltDB.
index/store/goleveldb
index/store/gtreapPackage gtreap provides an in-memory implementation of the KVStore interfaces using the gtreap balanced-binary treap, copy-on-write data structure.
index/store/metricsPackage metrics provides a bleve.store.KVStore implementation that wraps another, real KVStore implementation, and uses go-metrics to track runtime performance metrics.
index/store/moss
index/store/null
index/store/test
index/upsidedownPackage upsidedown is a generated protocol buffer package.
mapping
numeric
registry
search
search/collector
search/facet
search/highlight
search/highlight/format/ansi
search/highlight/format/html
search/highlight/fragmenter/simple
search/highlight/highlighter/ansi
search/highlight/highlighter/html
search/highlight/highlighter/simple
search/query
search/scorer
search/searcher
test

Package bleve imports 27 packages (graph) and is imported by 146 packages. Updated 2017-12-14. Refresh now. Tools for package owners.