package
0.0.0-20240905174813-5b86810c7bc7
Repository: https://github.com/geange/lucene-go.git
Documentation: pkg.go.dev

# Functions

No description provided by the author
No description provided by the author
BuildTermStates Creates a TermStates from a top-level IndexReaderContext and the given Term.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
FeatureRequested Returns true if the given feature is requested in the flags, false otherwise.
No description provided by the author
GenerationFromSegmentsFileName Parse the generation off the segments file name and return it.
No description provided by the author
No description provided by the author
GetLastCommitGeneration Get the generation of the most recent commit to the list of index files (N in the segments_N file).
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
IsCacheable Returns true if the specified docvalues fields have not been updated.
IsIndexExists Returns true if an index likely exists at the specified directory.
MergeFromReaders Merges in the fields from the readers in mergeState.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NewFrozenBufferedUpdates TODO: fix it.
No description provided by the author
NewIndexFileDeleter Initialize the deleter: find all previous commits in the Directory, incref the files they reference, call the policy to let it delete commits.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NewMergeSpecification Sole constructor.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NewSegmentReader Constructs a new SegmentReader with a new core.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NewStandardDirectoryReader package private constructor, called only from static open() methods.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
OpenDirectoryReader called from DirectoryReader.open(...) methods.
OpenStandardDirectoryReader Used by near real-time search.
ParseGeneration Returns the generation from this file name, or 0 if there is no generation.
ParseSegmentName Parses the segment name out of the given file name.
Partition points around mid.
No description provided by the author
No description provided by the author
ReadCommitFromChecksumIndexInput Read the commit from the provided ChecksumIndexInput.
ReadLatestCommit Find the latest commit (segments_N file) and load all SegmentCommitInfos.
No description provided by the author
No description provided by the author
SegmentFileName Returns a file name that includes the given segment name, your own custom name and extension.
No description provided by the author
No description provided by the author
No description provided by the author
SortByDim Sort points on the given dimension.
SortCodecReader Does a merge sort of the leaves of the incoming reader, returning MergeState.DocMap to map each leaf's documents into the merged segment.
No description provided by the author
No description provided by the author
StripExtension Removes the extension (anything after the first '.'), otherwise returns the original filename.
StripSegmentName Strips the segment name out of the given file name.
SubIndex Returns index of the searcher/reader for document n in the array used to construct this searcher/reader.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Constants

ACCEPT_STATUS_END Reject the term and stop enumerating.
ACCEPT_STATUS_NO Reject the term and position the enum at the next term.
ACCEPT_STATUS_NO_AND_SEEK Reject the term and advance (nextSeekTerm(BytesRef)) to the next term.
ACCEPT_STATUS_YES Accept the term and position the enum at the next term.
ACCEPT_STATUS_YES_AND_SEEK Accept the term and advance (nextSeekTerm(BytesRef)) to the next term.
APPEND Opens an existing index.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
CREATE Creates a new index or overwrites an existing one.
CREATE_OR_APPEND Creates a new index if one does not exist, otherwise it opens the index and documents will be appended.
DEFAULT_COMMIT_ON_CLOSE Default item for whether calls to IndexWriter.close() include a commit.
DEFAULT_MAX_BUFFERED_DELETE_TERMS Disabled by default (because IndexWriter flushes by RAM usage by default).
DEFAULT_MAX_BUFFERED_DOCS Disabled by default (because IndexWriter flushes by RAM usage by default).
No description provided by the author
DEFAULT_MAX_FULL_FLUSH_MERGE_WAIT_MILLIS Default item for time to wait for merges on commit or getReader (when using a MergePolicy that implements MergePolicy.findFullFlushMerges).
No description provided by the author
DEFAULT_RAM_BUFFER_SIZE_MB Default item is 16 MB (which means Flush when buffered docs consume approximately 16 MB RAM).
DEFAULT_RAM_PER_THREAD_HARD_LIMIT_MB Default item is 1945.
DEFAULT_READER_POOLING Default setting (true) for setReaderPooling.
DEFAULT_USE_COMPOUND_FILE_SYSTEM Default item for compound file system for newly written segments (set to true).
DISABLE_AUTO_FLUSH Denotes a Flush trigger is disabled.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Selects the maximum item in the set.
MAX_DOCS Hard limit on maximum number of documents that may be added to the index.
MAX_POSITION Maximum item of the token position in an indexed field.
No description provided by the author
MAX_TERM_LENGTH Absolute hard maximum length for a term, in bytes once encoded as UTF8.
MERGE_TRIGGER_CLOSING Merge was triggered by a closing IndexWriter.
MERGE_TRIGGER_COMMIT Merge was triggered on commit.
MERGE_TRIGGER_EXPLICIT Merge has been triggered explicitly by the user.
MERGE_TRIGGER_FULL_FLUSH Merge was triggered by a full Flush.
MERGE_TRIGGER_GET_READER Merge was triggered on opening NRT readers.
MERGE_TRIGGER_MERGE_FINISHED Merge was triggered by a successfully finished merge.
MERGE_TRIGGER_SEGMENT_FLUSH Merge was triggered by a segment Flush.
Selects the middle item in the set.
Selects the middle item in the set.
Selects the minimum item in the set.
No description provided by the author
OLD_SEGMENTS_GEN Name of the generation reference file name.
Other reason.
Temporarily paused because of exceeded throughput rate.
PENDING_SEGMENTS Name of pending index segment file.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
SegmentInfoNO Used by some member fields to mean not present (e.g., norms, deletions).
SegmentInfoYES Used by some member fields to mean present (e.g., norms, deletions).
SEGMENTS Name of the index segment file.
No description provided by the author
SOURCE key for the source of a segment in the diagnostics.
SOURCE_ADDINDEXES_READERS Source of a segment which results from a call to addIndexes(CodecReader...).
SOURCE_FLUSH Source of a segment which results from a Flush.
SOURCE_MERGE Source of a segment which results from a merge of other segments.
Stopped (because of throughput rate set to 0, typically).
No description provided by the author
No description provided by the author
No description provided by the author
VERBOSE_REF_COUNTS Change to true to see details of reference counts when infoStream is enabled.
VERSION_70 The version that added information about the Lucene version at the time when the index has been created.
VERSION_72 The version that updated segment name counter to be long instead of int.
VERSION_74 The version that recorded softDelCount.
VERSION_86 The version that recorded SegmentCommitInfo IDs.
No description provided by the author
WRITE_LOCK_NAME Name of the write lock in the index.

# Variables

CODEC_FILE_PATTERN All files created by codecs much match this pattern (checked in SegmentInfo).
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Structs

AutomatonTermsEnum A FilteredTermsEnum that enumerates terms based upon what is accepted by a DFA.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
BaseSortField Stores information about how to sort documents by terms in an individual field.
No description provided by the author
BaseTermsEnum A base TermsEnum that adds default implementations for * attributes() * termState() * seekExact(BytesRef) * seekExact(BytesRef, TermState) In some cases, the default implementation may be slow and consume huge memory, so subclass SHOULD have its own implementation if possible.
No description provided by the author
No description provided by the author
BinaryDocValuesFieldUpdates A DocValuesFieldUpdates which holds updates of documents, of a single BinaryDocValuesField.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
BufferedUpdatesStream Tracks the stream of FrozenBufferedUpdates.
ByteSliceReader IndexInput that knows how to read the byte slices written by Posting and PostingVector.
CommitPoint Holds details for each commit point.
CompetitiveImpactAccumulator This class accumulates the (freq, norm) pairs that may produce competitive scores.
No description provided by the author
CompositeReaderContext IndexReaderContext for CompositeReader instance.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
DefaultIndexingChain Default general purpose indexing chain, which handles indexing all types of fields.
No description provided by the author
No description provided by the author
DocsWithFieldSet Accumulator for documents that have a value for a field.
DocumentsWriter This class accepts multiple added documents and directly writes segment files.
DocumentsWriterDeleteQueue is a non-blocking linked pending deletes queue.
DocumentsWriterFlushControl This class controls DocumentsWriterPerThread flushing during indexing.
DocumentsWriterFlushQueue lucene.internal.
No description provided by the author
DocumentsWriterPerThreadPool controls DocumentsWriterPerThread instances and their thread assignments during indexing.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
DoubleSorter Sorts documents based on double values from a NumericDocValues instance.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
FindSegmentsFile Utility class for executing code that needs to do something with the current segments file.
FinishedSegments Tracks the contiguous range of packets that have finished resolving.
No description provided by the author
No description provided by the author
FloatSorter Sorts documents based on float values from a NumericDocValues instance.
No description provided by the author
No description provided by the author
FreqProxFields Implements limited (iterators only, no stats) Fields interface over the in-RAM buffered fields/terms/postings, to flush postings through the PostingsFormat.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
FreqProxTermsWriterPerField TODO: break into separate freq and prox writers as codecs; make separate container (tii/tis/skip/*) that can be configured as any number of files 1..N.
FrozenBufferedUpdates Holds buffered deletes and updates by term or query, once pushed.
IndexFileDeleter This class keeps track of each SegmentInfos instance that is still "live", either because it corresponds to a segments_N file in the Directory (a "commit", i.e.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
IntSorter Sorts documents based on integer values from a NumericDocValues instance.
KeepOnlyLastCommitDeletionPolicy This IndexDeletionPolicy implementation that keeps only the most recent commit and immediately removes all prior commits after a new commit is done.
No description provided by the author
No description provided by the author
LeafReaderContextImpl IndexReaderContext for LeafReader instances.
No description provided by the author
No description provided by the author
No description provided by the author
LongSorter Sorts documents based on long values from a NumericDocValues instance.
No description provided by the author
No description provided by the author
No description provided by the author
A MergeSpecification instance provides the information necessary to perform multiple merges.
MergeState Holds common state used during segment merging.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NormValuesWriter Buffers up pending long per doc, then flushes when segment flushes.
No description provided by the author
NumericDocValuesSub Tracks state of one numeric sub-reader that we are merging.
No description provided by the author
No description provided by the author
OneMerge provides the information necessary to perform an individual primitive merge operation, resulting in a single new segment.
OneMergeProgress Progress and state for an executing merge.
OrdinalMap Maps per-segment ordinals to/from global ordinal space, using a compact packed-ints representation.
No description provided by the author
PagedBytes Represents a logical byte[] as a series of pages.
No description provided by the author
No description provided by the author
PagedBytesReader Provides methods to read BytesRefs from a frozen PagedBytes.
No description provided by the author
No description provided by the author
PerField NOTE: not static: accesses at least docState, termsHash.
PointValuesWriter Buffers up pending byte[][] item(s) per doc, then flushes when segment flushes.
No description provided by the author
No description provided by the author
PrefixCodedTerms Prefix codes term instances (prefixes are shared).
No description provided by the author
ReaderPool Holds shared SegmentReader instances.
ReadersAndUpdates Used by IndexWriter to hold open SegmentReaders (for searching or merging), plus pending deletes and updates, for a given segment.
No description provided by the author
No description provided by the author
SegmentCoreReaders Holds core readers that are shared (unchanged) when SegmentReader is cloned or reopened.
SegmentDocValues Manages the DocValuesProducer held by SegmentReader and keeps track of their reference counting.
No description provided by the author
SegmentInfo Information about a segment such as its name, directory, and files related to the segment.
SegmentInfos A collection of segmentInfo objects with methods for operating on those segments in relation to the file system.
No description provided by the author
The SegmentMerger class combines two or more Segments, represented by an IndexReader, into a single Segment.
SegmentReader IndexReader implementation over a single segment.
No description provided by the author
SingleTermsEnum Subclass of FilteredTermsEnum for enumerating a single term.
No description provided by the author
SkipBuffer used to buffer the top skip levels.
No description provided by the author
No description provided by the author
SortedDocValuesTermsEnum Creates a new TermsEnum over the provided values.
No description provided by the author
No description provided by the author
No description provided by the author
SortedSetSelector Selects a item from the document's set to use as the representative item.
SortedSetSortField SortField for SortedSetDocValues.
No description provided by the author
No description provided by the author
No description provided by the author
StandardDirectoryReader Default implementation of DirectoryReader.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
TermStates Maintains a IndexReader TermState view over IndexReader instances containing a single term.
No description provided by the author
No description provided by the author
No description provided by the author

# Interfaces

No description provided by the author
DocValuesFieldUpdates holds updates of a single docvalues field, for a set of documents within one segment.
DocValuesFieldUpdatesIterator An iterator over documents and their updated values.
No description provided by the author
FieldTermIterator Iterates over terms in across multiple fields.
No description provided by the author
No description provided by the author
IndexCommit Expert: represents a single commit into an index as seen by the IndexDeletionPolicy or IndexReader.
IndexDeletionPolicy Expert: policy for deletion of stale index commits.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
MergeContext This interface represents the current context of the merge selection process.
MergePolicy Expert: a MergePolicy determines the sequence of primitive merge operations.
No description provided by the author
MergeScheduler Expert: IndexWriter uses an instance implementing this interface to execute the merges selected by a MergePolicy.
No description provided by the author
MultiLevelSkipListReader This interface reads skip lists with multiple levels.
MultiLevelSkipListWriter This abstract class writes skip lists with multiple levels.
No description provided by the author
NormsConsumer Abstract API that consumes normalization values.
NumericDocValuesProvider Provide a NumericDocValues instance for a LeafReader.
No description provided by the author
No description provided by the author
ReaderWarmer If DirectoryReader.open(IndexWriter) has been called (ie, this writer is in near real-time mode), then after a merge completes, this class can be invoked to warm the reader on the newly merged segment, before the merge commits.
No description provided by the author
SortedDocValuesProvider Provide a SortedDocValues instance for a LeafReader.
TermsHash This class is passed each token produced by the analyzer on each field during indexing, and it stores these tokens in a hash table, and allocates separate byte streams per token.
TermsHashPerField This class stores streams of information per term without knowing the size of the stream ahead of time.
No description provided by the author

# Type aliases

AcceptStatus Return item, if term should be accepted or the iteration should END.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
PauseReason Reason for pausing the merge thread.
No description provided by the author
No description provided by the author
No description provided by the author