Documentation ¶
Index ¶
- Variables
- func ComputeGeoRange(term uint64, shift uint, sminLon, sminLat, smaxLon, smaxLat float64, ...) (onBoundary [][]byte, notOnBoundary [][]byte)
- func NewFuzzySearcher(indexReader index.IndexReader, term string, prefix, fuzziness int, ...) (search.Searcher, error)
- func NewGeoBoundingBoxSearcher(indexReader index.IndexReader, minLon, minLat, maxLon, maxLat float64, ...) (search.Searcher, error)
- func NewGeoPointDistanceSearcher(indexReader index.IndexReader, centerLon, centerLat, dist float64, ...) (search.Searcher, error)
- func NewMultiTermSearcher(indexReader index.IndexReader, terms []string, field string, boost float64, ...) (search.Searcher, error)
- func NewMultiTermSearcherBytes(indexReader index.IndexReader, terms [][]byte, field string, boost float64, ...) (search.Searcher, error)
- func NewNumericRangeSearcher(indexReader index.IndexReader, min *float64, max *float64, ...) (search.Searcher, error)
- func NewRegexpSearcher(indexReader index.IndexReader, pattern *regexp.Regexp, field string, ...) (search.Searcher, error)
- func NewTermPrefixSearcher(indexReader index.IndexReader, prefix string, field string, boost float64, ...) (search.Searcher, error)
- func NewTermRangeSearcher(indexReader index.IndexReader, min, max []byte, ...) (search.Searcher, error)
- type BooleanSearcher
- func (s *BooleanSearcher) Advance(ctx *search.SearchContext, ID index.IndexInternalID) (*search.DocumentMatch, error)
- func (s *BooleanSearcher) Close() error
- func (s *BooleanSearcher) Count() uint64
- func (s *BooleanSearcher) DocumentMatchPoolSize() int
- func (s *BooleanSearcher) Min() int
- func (s *BooleanSearcher) Next(ctx *search.SearchContext) (*search.DocumentMatch, error)
- func (s *BooleanSearcher) SetQueryNorm(qnorm float64)
- func (s *BooleanSearcher) Weight() float64
- type ConjunctionSearcher
- func (s *ConjunctionSearcher) Advance(ctx *search.SearchContext, ID index.IndexInternalID) (*search.DocumentMatch, error)
- func (s *ConjunctionSearcher) Close() (rv error)
- func (s *ConjunctionSearcher) Count() uint64
- func (s *ConjunctionSearcher) DocumentMatchPoolSize() int
- func (s *ConjunctionSearcher) Min() int
- func (s *ConjunctionSearcher) Next(ctx *search.SearchContext) (*search.DocumentMatch, error)
- func (s *ConjunctionSearcher) SetQueryNorm(qnorm float64)
- func (s *ConjunctionSearcher) Weight() float64
- type DisjunctionSearcher
- func (s *DisjunctionSearcher) Advance(ctx *search.SearchContext, ID index.IndexInternalID) (*search.DocumentMatch, error)
- func (s *DisjunctionSearcher) Close() (rv error)
- func (s *DisjunctionSearcher) Count() uint64
- func (s *DisjunctionSearcher) DocumentMatchPoolSize() int
- func (s *DisjunctionSearcher) Min() int
- func (s *DisjunctionSearcher) Next(ctx *search.SearchContext) (*search.DocumentMatch, error)
- func (s *DisjunctionSearcher) SetQueryNorm(qnorm float64)
- func (s *DisjunctionSearcher) Weight() float64
- type DocIDSearcher
- func (s *DocIDSearcher) Advance(ctx *search.SearchContext, ID index.IndexInternalID) (*search.DocumentMatch, error)
- func (s *DocIDSearcher) Close() error
- func (s *DocIDSearcher) Count() uint64
- func (s *DocIDSearcher) DocumentMatchPoolSize() int
- func (s *DocIDSearcher) Min() int
- func (s *DocIDSearcher) Next(ctx *search.SearchContext) (*search.DocumentMatch, error)
- func (s *DocIDSearcher) SetQueryNorm(qnorm float64)
- func (s *DocIDSearcher) Weight() float64
- type FilterFunc
- type FilteringSearcher
- func (f *FilteringSearcher) Advance(ctx *search.SearchContext, ID index.IndexInternalID) (*search.DocumentMatch, error)
- func (f *FilteringSearcher) Close() error
- func (f *FilteringSearcher) Count() uint64
- func (f *FilteringSearcher) DocumentMatchPoolSize() int
- func (f *FilteringSearcher) Min() int
- func (f *FilteringSearcher) Next(ctx *search.SearchContext) (*search.DocumentMatch, error)
- func (f *FilteringSearcher) SetQueryNorm(n float64)
- func (f *FilteringSearcher) Weight() float64
- type MatchAllSearcher
- func (s *MatchAllSearcher) Advance(ctx *search.SearchContext, ID index.IndexInternalID) (*search.DocumentMatch, error)
- func (s *MatchAllSearcher) Close() error
- func (s *MatchAllSearcher) Count() uint64
- func (s *MatchAllSearcher) DocumentMatchPoolSize() int
- func (s *MatchAllSearcher) Min() int
- func (s *MatchAllSearcher) Next(ctx *search.SearchContext) (*search.DocumentMatch, error)
- func (s *MatchAllSearcher) SetQueryNorm(qnorm float64)
- func (s *MatchAllSearcher) Weight() float64
- type MatchNoneSearcher
- func (s *MatchNoneSearcher) Advance(ctx *search.SearchContext, ID index.IndexInternalID) (*search.DocumentMatch, error)
- func (s *MatchNoneSearcher) Close() error
- func (s *MatchNoneSearcher) Count() uint64
- func (s *MatchNoneSearcher) DocumentMatchPoolSize() int
- func (s *MatchNoneSearcher) Min() int
- func (s *MatchNoneSearcher) Next(ctx *search.SearchContext) (*search.DocumentMatch, error)
- func (s *MatchNoneSearcher) SetQueryNorm(qnorm float64)
- func (s *MatchNoneSearcher) Weight() float64
- type OrderedSearcherList
- type PhraseSearcher
- func (s *PhraseSearcher) Advance(ctx *search.SearchContext, ID index.IndexInternalID) (*search.DocumentMatch, error)
- func (s *PhraseSearcher) Close() error
- func (s *PhraseSearcher) Count() uint64
- func (s *PhraseSearcher) DocumentMatchPoolSize() int
- func (s *PhraseSearcher) Min() int
- func (s *PhraseSearcher) Next(ctx *search.SearchContext) (*search.DocumentMatch, error)
- func (s *PhraseSearcher) SetQueryNorm(qnorm float64)
- func (s *PhraseSearcher) Weight() float64
- type TermSearcher
- func (s *TermSearcher) Advance(ctx *search.SearchContext, ID index.IndexInternalID) (*search.DocumentMatch, error)
- func (s *TermSearcher) Close() error
- func (s *TermSearcher) Count() uint64
- func (s *TermSearcher) DocumentMatchPoolSize() int
- func (s *TermSearcher) Min() int
- func (s *TermSearcher) Next(ctx *search.SearchContext) (*search.DocumentMatch, error)
- func (s *TermSearcher) SetQueryNorm(qnorm float64)
- func (s *TermSearcher) Weight() float64
Constants ¶
This section is empty.
Variables ¶
var DisjunctionMaxClauseCount = 0
DisjunctionMaxClauseCount is a compile time setting that applications can adjust to non-zero value to cause the DisjunctionSearcher to return an error instead of exeucting searches when the size exceeds this value.
Functions ¶
func ComputeGeoRange ¶
func NewFuzzySearcher ¶
func NewGeoPointDistanceSearcher ¶
func NewGeoPointDistanceSearcher(indexReader index.IndexReader, centerLon, centerLat, dist float64, field string, boost float64, options search.SearcherOptions) (search.Searcher, error)
func NewMultiTermSearcher ¶
func NewNumericRangeSearcher ¶
func NewRegexpSearcher ¶
func NewRegexpSearcher(indexReader index.IndexReader, pattern *regexp.Regexp, field string, boost float64, options search.SearcherOptions) ( search.Searcher, error)
NewRegexpSearcher creates a searcher which will match documents that contain terms which match the pattern regexp. The match must be EXACT matching the entire term. The provided regexp SHOULD NOT start with ^ or end with $ as this can intefere with the implementation. Separately, matches will be checked to ensure they match the entire term.
func NewTermPrefixSearcher ¶
func NewTermPrefixSearcher(indexReader index.IndexReader, prefix string, field string, boost float64, options search.SearcherOptions) ( search.Searcher, error)
func NewTermRangeSearcher ¶
Types ¶
type BooleanSearcher ¶
type BooleanSearcher struct {
// contains filtered or unexported fields
}
func NewBooleanSearcher ¶
func NewBooleanSearcher(indexReader index.IndexReader, mustSearcher search.Searcher, shouldSearcher search.Searcher, mustNotSearcher search.Searcher, options search.SearcherOptions) (*BooleanSearcher, error)
func (*BooleanSearcher) Advance ¶
func (s *BooleanSearcher) Advance(ctx *search.SearchContext, ID index.IndexInternalID) (*search.DocumentMatch, error)
func (*BooleanSearcher) Close ¶
func (s *BooleanSearcher) Close() error
func (*BooleanSearcher) Count ¶
func (s *BooleanSearcher) Count() uint64
func (*BooleanSearcher) DocumentMatchPoolSize ¶
func (s *BooleanSearcher) DocumentMatchPoolSize() int
func (*BooleanSearcher) Min ¶
func (s *BooleanSearcher) Min() int
func (*BooleanSearcher) Next ¶
func (s *BooleanSearcher) Next(ctx *search.SearchContext) (*search.DocumentMatch, error)
func (*BooleanSearcher) SetQueryNorm ¶
func (s *BooleanSearcher) SetQueryNorm(qnorm float64)
func (*BooleanSearcher) Weight ¶
func (s *BooleanSearcher) Weight() float64
type ConjunctionSearcher ¶
type ConjunctionSearcher struct {
// contains filtered or unexported fields
}
func NewConjunctionSearcher ¶
func NewConjunctionSearcher(indexReader index.IndexReader, qsearchers []search.Searcher, options search.SearcherOptions) (*ConjunctionSearcher, error)
func (*ConjunctionSearcher) Advance ¶
func (s *ConjunctionSearcher) Advance(ctx *search.SearchContext, ID index.IndexInternalID) (*search.DocumentMatch, error)
func (*ConjunctionSearcher) Close ¶
func (s *ConjunctionSearcher) Close() (rv error)
func (*ConjunctionSearcher) Count ¶
func (s *ConjunctionSearcher) Count() uint64
func (*ConjunctionSearcher) DocumentMatchPoolSize ¶
func (s *ConjunctionSearcher) DocumentMatchPoolSize() int
func (*ConjunctionSearcher) Min ¶
func (s *ConjunctionSearcher) Min() int
func (*ConjunctionSearcher) Next ¶
func (s *ConjunctionSearcher) Next(ctx *search.SearchContext) (*search.DocumentMatch, error)
func (*ConjunctionSearcher) SetQueryNorm ¶
func (s *ConjunctionSearcher) SetQueryNorm(qnorm float64)
func (*ConjunctionSearcher) Weight ¶
func (s *ConjunctionSearcher) Weight() float64
type DisjunctionSearcher ¶
type DisjunctionSearcher struct {
// contains filtered or unexported fields
}
func NewDisjunctionSearcher ¶
func NewDisjunctionSearcher(indexReader index.IndexReader, qsearchers []search.Searcher, min float64, options search.SearcherOptions) ( *DisjunctionSearcher, error)
func (*DisjunctionSearcher) Advance ¶
func (s *DisjunctionSearcher) Advance(ctx *search.SearchContext, ID index.IndexInternalID) (*search.DocumentMatch, error)
func (*DisjunctionSearcher) Close ¶
func (s *DisjunctionSearcher) Close() (rv error)
func (*DisjunctionSearcher) Count ¶
func (s *DisjunctionSearcher) Count() uint64
func (*DisjunctionSearcher) DocumentMatchPoolSize ¶
func (s *DisjunctionSearcher) DocumentMatchPoolSize() int
func (*DisjunctionSearcher) Min ¶
func (s *DisjunctionSearcher) Min() int
func (*DisjunctionSearcher) Next ¶
func (s *DisjunctionSearcher) Next(ctx *search.SearchContext) ( *search.DocumentMatch, error)
func (*DisjunctionSearcher) SetQueryNorm ¶
func (s *DisjunctionSearcher) SetQueryNorm(qnorm float64)
func (*DisjunctionSearcher) Weight ¶
func (s *DisjunctionSearcher) Weight() float64
type DocIDSearcher ¶
type DocIDSearcher struct {
// contains filtered or unexported fields
}
DocIDSearcher returns documents matching a predefined set of identifiers.
func NewDocIDSearcher ¶
func NewDocIDSearcher(indexReader index.IndexReader, ids []string, boost float64, options search.SearcherOptions) (searcher *DocIDSearcher, err error)
func (*DocIDSearcher) Advance ¶
func (s *DocIDSearcher) Advance(ctx *search.SearchContext, ID index.IndexInternalID) (*search.DocumentMatch, error)
func (*DocIDSearcher) Close ¶
func (s *DocIDSearcher) Close() error
func (*DocIDSearcher) Count ¶
func (s *DocIDSearcher) Count() uint64
func (*DocIDSearcher) DocumentMatchPoolSize ¶
func (s *DocIDSearcher) DocumentMatchPoolSize() int
func (*DocIDSearcher) Min ¶
func (s *DocIDSearcher) Min() int
func (*DocIDSearcher) Next ¶
func (s *DocIDSearcher) Next(ctx *search.SearchContext) (*search.DocumentMatch, error)
func (*DocIDSearcher) SetQueryNorm ¶
func (s *DocIDSearcher) SetQueryNorm(qnorm float64)
func (*DocIDSearcher) Weight ¶
func (s *DocIDSearcher) Weight() float64
type FilterFunc ¶
type FilterFunc func(d *search.DocumentMatch) bool
FilterFunc defines a function which can filter documents returning true means keep the document returning false means do not keep the document
type FilteringSearcher ¶
type FilteringSearcher struct {
// contains filtered or unexported fields
}
FilteringSearcher wraps any other searcher, but checks any Next/Advance call against the supplied FilterFunc
func NewFilteringSearcher ¶
func NewFilteringSearcher(s search.Searcher, filter FilterFunc) *FilteringSearcher
func (*FilteringSearcher) Advance ¶
func (f *FilteringSearcher) Advance(ctx *search.SearchContext, ID index.IndexInternalID) (*search.DocumentMatch, error)
func (*FilteringSearcher) Close ¶
func (f *FilteringSearcher) Close() error
func (*FilteringSearcher) Count ¶
func (f *FilteringSearcher) Count() uint64
func (*FilteringSearcher) DocumentMatchPoolSize ¶
func (f *FilteringSearcher) DocumentMatchPoolSize() int
func (*FilteringSearcher) Min ¶
func (f *FilteringSearcher) Min() int
func (*FilteringSearcher) Next ¶
func (f *FilteringSearcher) Next(ctx *search.SearchContext) (*search.DocumentMatch, error)
func (*FilteringSearcher) SetQueryNorm ¶
func (f *FilteringSearcher) SetQueryNorm(n float64)
func (*FilteringSearcher) Weight ¶
func (f *FilteringSearcher) Weight() float64
type MatchAllSearcher ¶
type MatchAllSearcher struct {
// contains filtered or unexported fields
}
func NewMatchAllSearcher ¶
func NewMatchAllSearcher(indexReader index.IndexReader, boost float64, options search.SearcherOptions) (*MatchAllSearcher, error)
func (*MatchAllSearcher) Advance ¶
func (s *MatchAllSearcher) Advance(ctx *search.SearchContext, ID index.IndexInternalID) (*search.DocumentMatch, error)
func (*MatchAllSearcher) Close ¶
func (s *MatchAllSearcher) Close() error
func (*MatchAllSearcher) Count ¶
func (s *MatchAllSearcher) Count() uint64
func (*MatchAllSearcher) DocumentMatchPoolSize ¶
func (s *MatchAllSearcher) DocumentMatchPoolSize() int
func (*MatchAllSearcher) Min ¶
func (s *MatchAllSearcher) Min() int
func (*MatchAllSearcher) Next ¶
func (s *MatchAllSearcher) Next(ctx *search.SearchContext) (*search.DocumentMatch, error)
func (*MatchAllSearcher) SetQueryNorm ¶
func (s *MatchAllSearcher) SetQueryNorm(qnorm float64)
func (*MatchAllSearcher) Weight ¶
func (s *MatchAllSearcher) Weight() float64
type MatchNoneSearcher ¶
type MatchNoneSearcher struct {
// contains filtered or unexported fields
}
func NewMatchNoneSearcher ¶
func NewMatchNoneSearcher(indexReader index.IndexReader) (*MatchNoneSearcher, error)
func (*MatchNoneSearcher) Advance ¶
func (s *MatchNoneSearcher) Advance(ctx *search.SearchContext, ID index.IndexInternalID) (*search.DocumentMatch, error)
func (*MatchNoneSearcher) Close ¶
func (s *MatchNoneSearcher) Close() error
func (*MatchNoneSearcher) Count ¶
func (s *MatchNoneSearcher) Count() uint64
func (*MatchNoneSearcher) DocumentMatchPoolSize ¶
func (s *MatchNoneSearcher) DocumentMatchPoolSize() int
func (*MatchNoneSearcher) Min ¶
func (s *MatchNoneSearcher) Min() int
func (*MatchNoneSearcher) Next ¶
func (s *MatchNoneSearcher) Next(ctx *search.SearchContext) (*search.DocumentMatch, error)
func (*MatchNoneSearcher) SetQueryNorm ¶
func (s *MatchNoneSearcher) SetQueryNorm(qnorm float64)
func (*MatchNoneSearcher) Weight ¶
func (s *MatchNoneSearcher) Weight() float64
type OrderedSearcherList ¶
func (OrderedSearcherList) Len ¶
func (otrl OrderedSearcherList) Len() int
func (OrderedSearcherList) Less ¶
func (otrl OrderedSearcherList) Less(i, j int) bool
func (OrderedSearcherList) Swap ¶
func (otrl OrderedSearcherList) Swap(i, j int)
type PhraseSearcher ¶
type PhraseSearcher struct {
// contains filtered or unexported fields
}
func NewMultiPhraseSearcher ¶
func NewMultiPhraseSearcher(indexReader index.IndexReader, terms [][]string, field string, options search.SearcherOptions) (*PhraseSearcher, error)
func NewPhraseSearcher ¶
func NewPhraseSearcher(indexReader index.IndexReader, terms []string, field string, options search.SearcherOptions) (*PhraseSearcher, error)
func (*PhraseSearcher) Advance ¶
func (s *PhraseSearcher) Advance(ctx *search.SearchContext, ID index.IndexInternalID) (*search.DocumentMatch, error)
func (*PhraseSearcher) Close ¶
func (s *PhraseSearcher) Close() error
func (*PhraseSearcher) Count ¶
func (s *PhraseSearcher) Count() uint64
func (*PhraseSearcher) DocumentMatchPoolSize ¶
func (s *PhraseSearcher) DocumentMatchPoolSize() int
func (*PhraseSearcher) Min ¶
func (s *PhraseSearcher) Min() int
func (*PhraseSearcher) Next ¶
func (s *PhraseSearcher) Next(ctx *search.SearchContext) (*search.DocumentMatch, error)
func (*PhraseSearcher) SetQueryNorm ¶
func (s *PhraseSearcher) SetQueryNorm(qnorm float64)
func (*PhraseSearcher) Weight ¶
func (s *PhraseSearcher) Weight() float64
type TermSearcher ¶
type TermSearcher struct {
// contains filtered or unexported fields
}
func NewTermSearcher ¶
func NewTermSearcher(indexReader index.IndexReader, term string, field string, boost float64, options search.SearcherOptions) (*TermSearcher, error)
func NewTermSearcherBytes ¶
func NewTermSearcherBytes(indexReader index.IndexReader, term []byte, field string, boost float64, options search.SearcherOptions) (*TermSearcher, error)
func (*TermSearcher) Advance ¶
func (s *TermSearcher) Advance(ctx *search.SearchContext, ID index.IndexInternalID) (*search.DocumentMatch, error)
func (*TermSearcher) Close ¶
func (s *TermSearcher) Close() error
func (*TermSearcher) Count ¶
func (s *TermSearcher) Count() uint64
func (*TermSearcher) DocumentMatchPoolSize ¶
func (s *TermSearcher) DocumentMatchPoolSize() int
func (*TermSearcher) Min ¶
func (s *TermSearcher) Min() int
func (*TermSearcher) Next ¶
func (s *TermSearcher) Next(ctx *search.SearchContext) (*search.DocumentMatch, error)
func (*TermSearcher) SetQueryNorm ¶
func (s *TermSearcher) SetQueryNorm(qnorm float64)
func (*TermSearcher) Weight ¶
func (s *TermSearcher) Weight() float64
Source Files ¶
- ordered_searchers_list.go
- search_boolean.go
- search_conjunction.go
- search_disjunction.go
- search_docid.go
- search_filter.go
- search_fuzzy.go
- search_geoboundingbox.go
- search_geopointdistance.go
- search_match_all.go
- search_match_none.go
- search_multi_term.go
- search_numeric_range.go
- search_phrase.go
- search_regexp.go
- search_term.go
- search_term_prefix.go
- search_term_range.go