index

Jan 9, 2026

Changes in this version

+ type AncestorID uint64

+ func NewAncestorID(val uint64) AncestorID

+ func (a AncestorID) Add(n uint64) AncestorID

+ func (a AncestorID) Compare(b AncestorID) int

+ func (a AncestorID) Equals(b AncestorID) bool

+ func (a AncestorID) ToIndexInternalID(prealloc IndexInternalID) IndexInternalID

+ type EligibleDocumentIterator interface

+ Next func() (id uint64, ok bool)

+ type EligibleDocumentList interface

+ Count func() uint64

+ Iterator func() EligibleDocumentIterator

type EligibleDocumentSelector

+ SegmentEligibleDocuments func(segmentID int) EligibleDocumentList

type IndexInternalID

+ func NewIndexInternalID(buf []byte, in uint64) IndexInternalID

+ func NewIndexInternalIDFrom(buf IndexInternalID, other IndexInternalID) IndexInternalID

+ func (id IndexInternalID) Value() (uint64, error)

+ type NestedDocument interface

+ VisitNestedDocuments func(visitor func(doc Document))

+ type NestedReader interface

+ Ancestors func(id IndexInternalID, prealloc []AncestorID) ([]AncestorID, error)

Nov 7, 2025

Changes in this version

+ type CentroidCardinality struct

+ Cardinality uint64

+ Centroid []float32

+ Index string

+ type IndexInsightsReader interface

+ CentroidCardinalities func(field string, limit int, descending bool) (cenCards []CentroidCardinality, err error)

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

+ type TermFreq struct

+ Frequency uint64

+ Term string

Aug 11, 2025

Changes in this version

type UpdateIndex

+ OpenMeta func() error

Apr 16, 2025

Changes in this version

+ type BM25Reader interface

+ FieldCardinality func(field string) (int, error)

Apr 1, 2025

Changes in this version

type EligibleDocumentSelector

+ AddEligibleDocumentMatch func(id IndexInternalID) error

Mar 24, 2025

Changes in this version

+ type EligibleDocumentSelector interface

+ SegmentEligibleDocs func(segmentID int) []uint64

Mar 11, 2025

Changes in this version

type GeoShapeField

+ EncodedShape func() []byte

Mar 5, 2025

Changes in this version

type Document

+ Indexed func() bool

Feb 20, 2025

Changes in this version

+ type IPField interface

+ IP func() (net.IP, error)

+ type UpdateFieldInfo struct

+ Deleted bool

+ DocValues bool

+ Index bool

+ Store bool

+ type UpdateIndex interface

+ UpdateFields func(fieldInfo map[string]*UpdateFieldInfo, updatedMapping []byte) error

Jan 7, 2025

Changes in this version

+ const BM25Scoring

+ const DefaultScoringModel

+ const TFIDFScoring

+ var SupportedScoringModels = map[string]struct

type FieldDict

+ Cardinality func() int

Dec 11, 2024

Changes in this version

+ type FuzzyAutomaton interface

+ MatchAndDistance func(term string) (bool, uint8)

type IndexReaderFuzzy

+ FieldDictFuzzyAutomaton func(field string, term string, fuzziness int, prefix string) (FieldDict, FuzzyAutomaton, error)

type IndexReaderRegexp

+ FieldDictRegexpAutomaton func(field string, regex string) (FieldDict, RegexAutomaton, error)

+ type RegexAutomaton interface

+ MatchesRegex func(string) bool

+ type SynonymDocument interface

+ VisitSynonymFields func(visitor SynonymFieldVisitor)

+ type SynonymField interface

+ IterateSynonyms func(visitor func(term string, synonyms []string))

+ type SynonymFieldVisitor func(SynonymField)

+ type ThesaurusEntry struct

+ Term string

+ type ThesaurusKeys interface

+ Close func() error

+ Next func() (*ThesaurusEntry, error)

+ type ThesaurusReader interface

+ ThesaurusKeys func(name string) (ThesaurusKeys, error)

+ ThesaurusKeysFuzzy func(name string, term string, fuzziness int, prefix string) (ThesaurusKeys, error)

+ ThesaurusKeysPrefix func(name string, termPrefix []byte) (ThesaurusKeys, error)

+ ThesaurusKeysRegexp func(name string, regex string) (ThesaurusKeys, error)

+ ThesaurusTermReader func(ctx context.Context, name string, term []byte) (ThesaurusTermReader, error)

+ type ThesaurusTermReader interface

+ Close func() error

+ Next func() (string, error)

+ Size func() int

Nov 18, 2024

Changes in this version

type DictEntry

+ EditDistance uint8

Aug 5, 2024

Changes in this version

+ type EventIndex interface

+ FireIndexEvent func()

May 14, 2024

Changes in this version

+ type CopyIndex interface

+ CopyReader func() CopyReader

+ type CopyReader interface

+ CloseCopyReader func() error

+ CopyTo func(d Directory) error

Nov 7, 2022

Changes in this version

type DocValueReader

+ BytesRead func() uint64

type Document

+ StoredFieldsBytes func() uint64

type FieldDict

+ BytesRead func() uint64

type FieldDictContains

+ BytesRead func() uint64

Oct 18, 2022

Changes in this version

type TermFieldDoc

+ BytesRead uint64

Jul 22, 2022

Changes in this version

type GeoJSON

+ Value func() ([]byte, error)

+ type GeoShapeField interface

+ GeoShape func() (GeoJSON, error)

Mar 28, 2022

Changes in this version

+ type GeoJSON interface

+ Contains func(GeoJSON) (bool, error)

+ Intersects func(GeoJSON) (bool, error)

+ Type func() string

+ type SpatialAnalyzerPlugin interface

+ GetIndexTokens func(GeoJSON) []string

+ GetQueryTokens func(GeoJSON) []string

+ Type func() string

+ type SpatialIndexPlugin interface

+ GetSpatialAnalyzerPlugin func(typ string) (SpatialAnalyzerPlugin, error)

+ type TokenizableSpatialField interface

+ SetSpatialAnalyzerPlugin func(SpatialAnalyzerPlugin)

Aug 5, 2021

Changes in this version

+ type Directory interface

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

Dec 31, 2020

Changes in this version

type FieldIndexingOptions

+ const SkipFreqNorm

+ func (o FieldIndexingOptions) SkipFreqNorm() bool

Dec 21, 2020

Changes in this version

+ type DocValueVisitor func(field string, term []byte)

Dec 18, 2020

Changes in this version

+ type BooleanField interface

+ Boolean func() (bool, error)

+ type DateTimeField interface

+ DateTime func() (time.Time, error)

+ type GeoPointField interface

+ Lat func() (float64, error)

+ Lon func() (float64, error)

+ type NumericField interface

+ Number func() (float64, error)

+ type TextField interface

+ Text func() string

Dec 16, 2020

Changes in this version

type Field

+ Options func() FieldIndexingOptions

+ type FieldIndexingOptions int

+ const DocValues

+ const IncludeTermVectors

+ const IndexField

+ const StoreField

+ func (o FieldIndexingOptions) IncludeDocValues() bool

+ func (o FieldIndexingOptions) IncludeTermVectors() bool

+ func (o FieldIndexingOptions) IsIndexed() bool

+ func (o FieldIndexingOptions) IsStored() bool

+ func (o FieldIndexingOptions) String() string

Nov 9, 2020

Changes in this version

+ var ErrorUnknownStorageType = fmt.Errorf("unknown storage type")

+ var SizeOfBool int

+ var SizeOfFloat32 int

+ var SizeOfFloat64 int

+ var SizeOfInt int

+ var SizeOfMap int

+ var SizeOfPtr int

+ var SizeOfSlice int

+ var SizeOfString int

+ var SizeOfUint16 int

+ var SizeOfUint32 int

+ var SizeOfUint64 int

+ var SizeOfUint8 int

+ func AnalysisWorker(q AnalysisQueue)

+ type AnalysisQueue struct

+ func NewAnalysisQueue(numWorkers int) *AnalysisQueue

+ func (q *AnalysisQueue) Close()

+ func (q *AnalysisQueue) Queue(work *AnalysisWork)

+ type AnalysisResult struct

+ DocID string

+ Document Document

+ Rows []IndexRow

+ func (a *AnalysisResult) Size() int

+ type AnalysisWork struct

+ func NewAnalysisWork(i Index, d Document, rc chan *AnalysisResult) *AnalysisWork

+ type Batch struct

+ IndexOps map[string]Document

+ InternalOps map[string][]byte

+ func NewBatch() *Batch

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

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

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

+ func (b *Batch) PersistedCallback() BatchCallback

+ func (b *Batch) Reset()

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

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

+ func (b *Batch) String() string

+ func (b *Batch) TotalDocSize() int

+ func (b *Batch) Update(doc Document)

+ type BatchCallback func(error)

+ type CompositeField interface

+ Compose func(field string, length int, freq TokenFrequencies)

+ type CompositeFieldVisitor func(field CompositeField)

+ type DictEntry struct

+ Count uint64

+ Term string

+ type DocIDReader interface

+ Advance func(ID IndexInternalID) (IndexInternalID, error)

+ Close func() error

+ Next func() (IndexInternalID, error)

+ Size func() int

+ type DocValueReader interface

+ VisitDocValues func(id IndexInternalID, visitor DocumentFieldTermVisitor) error

+ type Document interface

+ AddIDField func()

+ HasComposite func() bool

+ ID func() string

+ NumPlainTextBytes func() uint64

+ Size func() int

+ VisitComposite func(visitor CompositeFieldVisitor)

+ VisitFields func(visitor FieldVisitor)

+ type DocumentFieldTermVisitor func(field string, term []byte)

+ type Field interface

+ Analyze func()

+ AnalyzedLength func() int

+ AnalyzedTokenFrequencies func() TokenFrequencies

+ ArrayPositions func() []uint64

+ EncodedFieldType func() byte

+ IncludeDocValues func() bool

+ IncludeTermVectors func() bool

+ IsIndexed func() bool

+ IsStored func() bool

+ Name func() string

+ NumPlainTextBytes func() uint64

+ Value func() []byte

+ type FieldCache struct

+ func NewFieldCache() *FieldCache

+ func (f *FieldCache) AddExisting(field string, index uint16)

+ func (f *FieldCache) FieldIndexed(index uint16) (field string)

+ func (f *FieldCache) FieldNamed(field string, createIfMissing bool) (uint16, bool)

+ type FieldDict interface

+ Close func() error

+ Next func() (*DictEntry, error)

+ type FieldDictContains interface

+ Contains func(key []byte) (bool, error)

+ type FieldTerms map[string][]string

+ func (f FieldTerms) FieldsNotYetCached(fields []string) []string

+ func (f FieldTerms) Merge(other FieldTerms)

+ type FieldVisitor func(Field)

+ type Index interface

+ Advanced func() (store.KVStore, error)

+ Analyze func(d Document) *AnalysisResult

+ Batch func(batch *Batch) error

+ Close func() error

+ Delete func(id string) error

+ DeleteInternal func(key []byte) error

+ Open func() error

+ Reader func() (IndexReader, error)

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

+ Stats func() json.Marshaler

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

+ Update func(doc Document) error

+ type IndexBuilder interface

+ Close func() error

+ Index func(doc Document) error

+ type IndexInternalID []byte

+ func (id IndexInternalID) Compare(other IndexInternalID) int

+ func (id IndexInternalID) Equals(other IndexInternalID) bool

+ type IndexReader interface

+ Close func() error

+ DocCount func() (uint64, error)

+ DocIDReaderAll func() (DocIDReader, error)

+ DocIDReaderOnly func(ids []string) (DocIDReader, error)

+ DocValueReader func(fields []string) (DocValueReader, error)

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

+ DocumentVisitFieldTerms func(id IndexInternalID, fields []string, visitor DocumentFieldTermVisitor) error

+ DumpAll func() chan interface{}

+ DumpDoc func(id string) chan interface{}

+ DumpFields func() chan interface{}

+ ExternalID func(id IndexInternalID) (string, error)

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

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

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

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

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

+ InternalID func(id string) (IndexInternalID, error)

+ TermFieldReader func(term []byte, field string, includeFreq, includeNorm, includeTermVectors bool) (TermFieldReader, error)

+ type IndexReaderContains interface

+ FieldDictContains func(field string) (FieldDictContains, error)

+ type IndexReaderFuzzy interface

+ FieldDictFuzzy func(field string, term string, fuzziness int, prefix string) (FieldDict, error)

+ type IndexReaderOnly interface

+ FieldDictOnly func(field string, onlyTerms [][]byte, includeCount bool) (FieldDict, error)

+ type IndexReaderRegexp interface

+ FieldDictRegexp func(field string, regex string) (FieldDict, error)

+ type IndexRow interface

+ Key func() []byte

+ KeySize func() int

+ KeyTo func([]byte) (int, error)

+ Value func() []byte

+ ValueSize func() int

+ ValueTo func([]byte) (int, error)

+ type Optimizable interface

+ Optimize func(kind string, octx OptimizableContext) (OptimizableContext, error)

+ type OptimizableContext interface

+ Finish func() (Optimized, error)

+ type Optimized interface

+ type Regexp interface

+ FindStringIndex func(s string) (loc []int)

+ LiteralPrefix func() (prefix string, complete bool)

+ String func() string

+ type TermFieldDoc struct

+ Freq uint64

+ ID IndexInternalID

+ Norm float64

+ Term string

+ Vectors []*TermFieldVector

+ func (tfd *TermFieldDoc) Reset() *TermFieldDoc

+ func (tfd *TermFieldDoc) Size() int

+ type TermFieldReader interface

+ Advance func(ID IndexInternalID, preAlloced *TermFieldDoc) (*TermFieldDoc, error)

+ Close func() error

+ Count func() uint64

+ Next func(preAlloced *TermFieldDoc) (*TermFieldDoc, error)

+ Size func() int

+ type TermFieldVector struct

+ ArrayPositions []uint64

+ End uint64

+ Field string

+ Pos uint64

+ Start uint64

+ func (tfv *TermFieldVector) Size() int

+ type TokenFreq struct

+ Locations []*TokenLocation

+ Term []byte

+ func (tf *TokenFreq) Frequency() int

+ func (tf *TokenFreq) SetFrequency(frequency int)

+ func (tf *TokenFreq) Size() int

+ type TokenFrequencies map[string]*TokenFreq

+ func (tfs TokenFrequencies) MergeAll(remoteField string, other TokenFrequencies)

+ func (tfs TokenFrequencies) Size() int

+ type TokenLocation struct

+ ArrayPositions []uint64

+ End int

+ Field string

+ Position int

+ Start int

+ func (tl *TokenLocation) Size() int