bleve

Dec 2, 2025

Changes in this version

type FacetRequest

+ TermPattern string

+ TermPrefix string

+ func (fr *FacetRequest) SetPrefixFilter(prefix string)

+ func (fr *FacetRequest) SetRegexFilter(pattern string)

Nov 11, 2025

Changes in this version

+ type InsightsIndex interface

+ CentroidCardinalities func(field string, limit int, desceding bool) ([]index.CentroidCardinality, error)

+ TermFrequencies func(field string, limit int, descending bool) ([]index.TermFreq, error)

Oct 20, 2025

Changes in this version

+ const DefaultScoreRankConstant

+ const ScoreDefault

+ const ScoreNone

+ const ScoreRRF

+ const ScoreRSF

+ var AllowedFusionSort = search.SortOrder

+ func DeletedFields(ori, upd *mapping.IndexMappingImpl) (map[string]*index.UpdateFieldInfo, error)

+ func IsScoreFusionRequested(req *SearchRequest) bool

+ type RequestParams struct

+ ScoreRankConstant int

+ ScoreWindowSize int

+ func NewDefaultParams(from, size int) *RequestParams

+ func ParseParams(r *SearchRequest, input []byte) (*RequestParams, error)

+ func (p *RequestParams) UnmarshalJSON(input []byte) error

+ func (p *RequestParams) Validate(size int) error

type SearchRequest

+ Params *RequestParams

+ func (r *SearchRequest) AddParams(params RequestParams)

Apr 2, 2025

Changes in this version

type Batch

+ func (b *Batch) IndexSynonym(id string, collection string, definition *SynonymDefinition) error

type Error

+ const ErrorSynonymSearchNotSupported

type SearchResult

+ BM25Stats *search.BM25Stats

+ SynonymResult search.FieldTermSynonymMap

+ type SynonymDefinition struct

+ Input []string

+ Synonyms []string

+ func (sd *SynonymDefinition) Validate() error

+ type SynonymIndex interface

+ IndexSynonym func(id string, collection string, definition *SynonymDefinition) error

Dec 17, 2024 GO-2022-0470

  GO-2022-0470: No access control in github.com/blevesearch/bleve and bleve/v2

Nov 13, 2024 GO-2022-0470

  GO-2022-0470: No access control in github.com/blevesearch/bleve and bleve/v2

Jul 26, 2024 GO-2022-0470

  GO-2022-0470: No access control in github.com/blevesearch/bleve and bleve/v2

Jun 13, 2024 GO-2022-0470

  GO-2022-0470: No access control in github.com/blevesearch/bleve and bleve/v2

Mar 20, 2024 GO-2022-0470

  GO-2022-0470: No access control in github.com/blevesearch/bleve and bleve/v2

Changes in this version

type Error

+ const ErrorTwoPhaseSearchInconsistency

type SearchRequest

+ PreSearchData map[string]interface{}

Sep 13, 2023 GO-2022-0470

  GO-2022-0470: No access control in github.com/blevesearch/bleve and bleve/v2

Changes in this version

+ func NewDateRangeInclusiveStringQuery(start, end string, startInclusive, endInclusive *bool) *query.DateRangeStringQuery

+ func NewDateRangeStringQuery(start, end string) *query.DateRangeStringQuery

type FacetRequest

+ func (fr *FacetRequest) AddDateTimeRangeStringWithParser(name string, start, end *string, parser string)

type SearchRequest

+ ClientContextID string

+ func (r *SearchRequest) SetClientContextID(id string)

Jul 12, 2023 GO-2022-0470

  GO-2022-0470: No access control in github.com/blevesearch/bleve and bleve/v2

Changes in this version

+ func NewGeoShapeCircleQuery(coordinates []float64, radius, relation string) (*query.GeoShapeQuery, error)

+ func NewGeoShapeQuery(coordinates [][][][]float64, typ, relation string) (*query.GeoShapeQuery, error)

+ func NewGeometryCollectionQuery(coordinates [][][][][]float64, types []string, relation string) (*query.GeoShapeQuery, error)

type SearchResult

+ Cost uint64

May 4, 2023 GO-2022-0470

  GO-2022-0470: No access control in github.com/blevesearch/bleve and bleve/v2

Mar 17, 2023 GO-2022-0470

  GO-2022-0470: No access control in github.com/blevesearch/bleve and bleve/v2

Dec 15, 2022 GO-2022-0470

  GO-2022-0470: No access control in github.com/blevesearch/bleve and bleve/v2

Changes in this version

type SearchResult

+ BytesRead uint64

Oct 20, 2022 GO-2022-0470

  GO-2022-0470: No access control in github.com/blevesearch/bleve and bleve/v2

Changes in this version

+ func NewGeoShapeFieldMapping() *mapping.FieldMapping

Aug 18, 2022 GO-2022-0470

  GO-2022-0470: No access control in github.com/blevesearch/bleve and bleve/v2

Jun 16, 2022 GO-2022-0470

  GO-2022-0470: No access control in github.com/blevesearch/bleve and bleve/v2

Mar 22, 2022 GO-2022-0470

  GO-2022-0470: No access control in github.com/blevesearch/bleve and bleve/v2

Feb 24, 2022 GO-2022-0470

  GO-2022-0470: No access control in github.com/blevesearch/bleve and bleve/v2

Dec 16, 2021 GO-2022-0470

  GO-2022-0470: No access control in github.com/blevesearch/bleve and bleve/v2

Changes in this version

+ func NewIPFieldMapping() *mapping.FieldMapping

+ func NewIPRangeQuery(cidr string) *query.IPRangeQuery

+ func NewKeywordFieldMapping() *mapping.FieldMapping

Oct 28, 2021 GO-2022-0470

  GO-2022-0470: No access control in github.com/blevesearch/bleve and bleve/v2

Oct 4, 2021 GO-2022-0470

  GO-2022-0470: No access control in github.com/blevesearch/bleve and bleve/v2

Sep 17, 2021 GO-2022-0470

  GO-2022-0470: No access control in github.com/blevesearch/bleve and bleve/v2

Sep 8, 2021 GO-2022-0470

  GO-2022-0470: No access control in github.com/blevesearch/bleve and bleve/v2

Aug 9, 2021 GO-2022-0470

  GO-2022-0470: No access control in github.com/blevesearch/bleve and bleve/v2

Changes in this version

+ type FileSystemDirectory string

+ func (f FileSystemDirectory) GetWriter(filePath string) (io.WriteCloser, error)

+ type IndexCopyable interface

+ CopyTo func(d index.Directory) error

Jul 28, 2021 GO-2022-0470

  GO-2022-0470: No access control in github.com/blevesearch/bleve and bleve/v2

Jun 11, 2021 GO-2022-0470

  GO-2022-0470: No access control in github.com/blevesearch/bleve and bleve/v2

Jun 6, 2021 GO-2022-0470

  GO-2022-0470: No access control in github.com/blevesearch/bleve and bleve/v2

Jun 6, 2021 GO-2022-0470

  GO-2022-0470: No access control in github.com/blevesearch/bleve and bleve/v2

Feb 18, 2021 GO-2022-0470

  GO-2022-0470: No access control in github.com/blevesearch/bleve and bleve/v2

Feb 12, 2021 GO-2022-0470

  GO-2022-0470: No access control in github.com/blevesearch/bleve and bleve/v2

Jan 14, 2021 GO-2022-0470

  GO-2022-0470: No access control in github.com/blevesearch/bleve and bleve/v2

Jan 12, 2021 GO-2022-0470

  GO-2022-0470: No access control in github.com/blevesearch/bleve and bleve/v2

Changes in this version

+ const SearchQueryEndCallbackKey

+ const SearchQueryStartCallbackKey

+ var Config *configuration

+ func LoadAndHighlightFields(hit *search.DocumentMatch, req *SearchRequest, indexName string, ...) error

+ func MemoryNeededForSearchResult(req *SearchRequest) uint64

+ func NewBoolFieldQuery(val bool) *query.BoolFieldQuery

+ func NewBooleanFieldMapping() *mapping.FieldMapping

+ func NewBooleanQuery() *query.BooleanQuery

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

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

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

+ func NewDateTimeFieldMapping() *mapping.FieldMapping

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

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

+ func NewDocumentDisabledMapping() *mapping.DocumentMapping

+ func NewDocumentMapping() *mapping.DocumentMapping

+ func NewDocumentStaticMapping() *mapping.DocumentMapping

+ func NewFuzzyQuery(term string) *query.FuzzyQuery

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

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

+ func NewGeoPointFieldMapping() *mapping.FieldMapping

+ func NewIndexAlias(indexes ...Index) *indexAliasImpl

+ func NewIndexMapping() *mapping.IndexMappingImpl

+ func NewMatchAllQuery() *query.MatchAllQuery

+ func NewMatchNoneQuery() *query.MatchNoneQuery

+ func NewMatchPhraseQuery(matchPhrase string) *query.MatchPhraseQuery

+ func NewMatchQuery(match string) *query.MatchQuery

+ func NewNumericFieldMapping() *mapping.FieldMapping

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

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

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

+ func NewPrefixQuery(prefix string) *query.PrefixQuery

+ func NewQueryStringQuery(q string) *query.QueryStringQuery

+ func NewRegexpQuery(regexp string) *query.RegexpQuery

+ func NewTermQuery(term string) *query.TermQuery

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

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

+ func NewTextFieldMapping() *mapping.FieldMapping

+ func NewWildcardQuery(wildcard string) *query.WildcardQuery

+ func SetLog(l *log.Logger)

+ type Batch struct

+ func (b *Batch) Delete(id string)

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

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

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

+ func (b *Batch) LastDocSize() uint64

+ func (b *Batch) Merge(o *Batch)

+ func (b *Batch) PersistedCallback() index.BatchCallback

+ func (b *Batch) Reset()

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

+ func (b *Batch) SetPersistedCallback(f index.BatchCallback)

+ func (b *Batch) Size() int

+ func (b *Batch) String() string

+ func (b *Batch) TotalDocsSize() uint64

+ type Builder interface

+ Close func() error

+ Index func(id string, data interface{}) error

+ func NewBuilder(path string, mapping mapping.IndexMapping, config map[string]interface{}) (Builder, error)

+ type Error int

+ const ErrorAliasEmpty

+ const ErrorAliasMulti

+ const ErrorEmptyID

+ const ErrorIndexClosed

+ const ErrorIndexMetaCorrupt

+ const ErrorIndexMetaMissing

+ const ErrorIndexPathDoesNotExist

+ const ErrorIndexPathExists

+ const ErrorIndexReadInconsistency

+ const ErrorUnknownIndexType

+ func (e Error) Error() string

+ type FacetRequest struct

+ DateTimeRanges []*dateTimeRange

+ Field string

+ NumericRanges []*numericRange

+ Size int

+ func NewFacetRequest(field string, size int) *FacetRequest

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

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

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

+ func (fr *FacetRequest) Validate() error

+ type FacetsRequest map[string]*FacetRequest

+ func (fr FacetsRequest) Validate() error

+ type HighlightRequest struct

+ Fields []string

+ Style *string

+ func NewHighlight() *HighlightRequest

+ func NewHighlightWithStyle(style string) *HighlightRequest

+ func (h *HighlightRequest) AddField(field string)

+ type Index interface

+ Advanced func() (index.Index, error)

+ Batch func(b *Batch) error

+ Close func() error

+ Delete func(id string) error

+ DeleteInternal func(key []byte) error

+ DocCount func() (uint64, error)

+ Document func(id string) (index.Document, error)

+ FieldDict func(field string) (index.FieldDict, error)

+ FieldDictPrefix func(field string, termPrefix []byte) (index.FieldDict, error)

+ FieldDictRange func(field string, startTerm []byte, endTerm []byte) (index.FieldDict, error)

+ Fields func() ([]string, error)

+ GetInternal func(key []byte) ([]byte, error)

+ Index func(id string, data interface{}) error

+ Mapping func() mapping.IndexMapping

+ Name func() string

+ NewBatch func() *Batch

+ Search func(req *SearchRequest) (*SearchResult, error)

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

+ SetInternal func(key, val []byte) error

+ SetName func(string)

+ Stats func() *IndexStat

+ StatsMap func() map[string]interface{}

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

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

+ func NewUsing(path string, mapping mapping.IndexMapping, indexType string, kvstore string, ...) (Index, error)

+ func Open(path string) (Index, error)

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

+ type IndexAlias interface

+ Add func(i ...Index)

+ Remove func(i ...Index)

+ Swap func(in, out []Index)

+ type IndexErrMap map[string]error

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

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

+ type IndexStat struct

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

+ type IndexStats struct

+ func NewIndexStats() *IndexStats

+ func (i *IndexStats) Register(index Index)

+ func (i *IndexStats) String() string

+ func (i *IndexStats) UnRegister(index Index)

+ type SearchQueryEndCallbackFn func(size uint64) error

+ type SearchQueryStartCallbackFn func(size uint64) error

+ type SearchRequest struct

+ Explain bool

+ Facets FacetsRequest

+ Fields []string

+ From int

+ Highlight *HighlightRequest

+ IncludeLocations bool

+ Query query.Query

+ Score string

+ SearchAfter []string

+ SearchBefore []string

+ Size int

+ Sort search.SortOrder

+ func NewSearchRequest(q query.Query) *SearchRequest

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

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

+ func (r *SearchRequest) SetSearchAfter(after []string)

+ func (r *SearchRequest) SetSearchBefore(before []string)

+ func (r *SearchRequest) SetSortFunc(s func(sort.Interface))

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

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

+ func (r *SearchRequest) SortFunc() func(data sort.Interface)

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

+ func (r *SearchRequest) Validate() error

+ type SearchResult struct

+ Facets search.FacetResults

+ Hits search.DocumentMatchCollection

+ MaxScore float64

+ Request *SearchRequest

+ Status *SearchStatus

+ Took time.Duration

+ Total uint64

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

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

+ func (sr *SearchResult) Size() int

+ func (sr *SearchResult) String() string

+ type SearchStatus struct

+ Errors IndexErrMap

+ Failed int

+ Successful int

+ Total int

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