LevenshteinDistanceMax same as LevenshteinDistance but attempts to bail early once we know the distance will be greater than max in which case the first return val will be the max and the second will be true, indicating max was exceeded.

NewDocumentMatchPool will build a DocumentMatchPool with memory pre-allocated to accommodate the requested number of DocumentMatch instances.

NewSortGeoDistance creates SearchSort instance for sorting documents by their distance from the specified point.

FieldTermSynonymMapKey is used to store and transport the synonym definitions data to the actual search phase which would use the synonyms to perform the search.

GetScoringModelCallbackKey is used to help the underlying searcher identify which scoring mechanism to use based on index mapping.

*PreSearchDataKey are used to store the data gathered during the presearch phase which would be use in the actual search phase.

Assigning the size of the largest buffer in the pool to 24KB and the smallest buffer to 24 bytes.

PreSearchKey indicates whether to perform a preliminary search to gather necessary information which would be used in the actual search down the line.

The following keys are used to invoke the callbacks at the start and end stages of optimizing the disjunction/conjunction searcher creation.

SearchTypeKey is used to identify type of the search being performed.

SortFieldAsDate forces sort as string (prefix coded terms with shift > 0 removed).

SortFieldAsNumber forces sort as string (prefix coded terms with shift > 0 removed).

SortFieldAsString forces sort as string (no prefix coded terms removed).

SortFieldAuto applies heuristics attempt to automatically sort correctly.

FIXME name is confusing.

SortFieldMax uses the maximum value.

SortFieldMin uses the minimum value.

SortFieldMissingFirst sorts documents missing a field at the beginning.

SortFieldMissingLast sorts documents missing a field at the end.

BM25 specific multipliers which control the scoring of a document.

DocumentMatchPool manages use/re-use of DocumentMatch instances it pre-allocates space from a single large block with the expected number of instances.

SearchContext represents the context around a single search.

SortDocID will sort results by the document identifier.

SortField will sort results by the value of a stored field Field is the name of the field Descending reverse the sort order (default false) Type allows forcing of string/number/date behavior (default auto) Mode controls behavior for multi-values fields (default first) Missing controls behavior of missing values (default last).

SortGeoDistance will sort results by the distance of an indexed geo point, from the provided location.

SortScore will sort results by the document match score.

DocumentMatchHandler is the type of document match callback bleve will invoke during the search.

DocumentMatchPoolTooSmall is a callback function that can be executed when the DocumentMatchPool does not have sufficient capacity By default we just perform just-in-time allocation, but you could log a message, or panic, etc.

field -> term -> synonyms.

MakeDocumentMatchHandler is an optional DocumentMatchHandler builder function which the applications can pass to bleve.

Implementation of SearchIncrementalCostCallbackFn should handle the following messages - add: increment the cost of a search operation (which can be specific to a query type as well) - abort: query was aborted due to a cancel of search's context (for eg), which can be handled differently as well - done: indicates that a search was complete and the tracked cost can be handled safely by the implementation.

SortFieldMissing controls where documents missing a field value should be sorted.

SortFieldMode describes the behavior if the field has multiple values.

SortFieldType lets you control some internal sort behavior normally leaving this to the zero-value of SortFieldAuto is fine.