LiveIndexWriterConfig

Holds all the configuration used by IndexWriter with few setters for settings that can be changed on an IndexWriter instance "live".

Since

4.0

Inheritors

Properties

Link copied to clipboard
open val analyzer: Analyzer
Link copied to clipboard

if an indexing thread should check for pending flushes on update in order to help out on a full flush

Link copied to clipboard
open lateinit var codec: Codec

Codec used to write new segments.

Link copied to clipboard

True if calls to IndexWriter.close should first do a commit.

Link copied to clipboard

Compatibility version to use for this index.

Link copied to clipboard
open lateinit var flushPolicy: FlushPolicy

FlushPolicy to control when segments are flushed.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

The sort order to use to write merged segments.

Link copied to clipboard

The field names involved in the index sort

Link copied to clipboard
open lateinit var infoStream: InfoStream

InfoStream for debugging messages.

Link copied to clipboard

The comparator for sorting leaf readers.

Link copied to clipboard

Returns the number of buffered added documents that will trigger a flush if enabled.

Link copied to clipboard

Amount of time to wait for merges returned by MergePolicy.findFullFlushMerges(...)

Link copied to clipboard
open lateinit var mergePolicy: MergePolicy

MergePolicy for selecting merges.

Link copied to clipboard

MergeScheduler to use for running merges.

Link copied to clipboard

OpenMode that IndexWriter is opened with.

Link copied to clipboard

parent document field

Link copied to clipboard

Returns the value set by .setRAMBufferSizeMB if enabled.

Link copied to clipboard

Sets the hard upper bound on RAM usage for a single segment, after which the segment is forced to flush.

Link copied to clipboard

True if readers should be pooled.

Link copied to clipboard
open lateinit var similarity: Similarity

Similarity to use when encoding norms.

Link copied to clipboard

soft deletes field

Link copied to clipboard

True if segment flushes should use compound file format

Functions

Link copied to clipboard

Returns the current merged segment warmer. See IndexReaderWarmer.

Link copied to clipboard
open fun setCheckPendingFlushUpdate(checkPendingFlushOnUpdate: Boolean): LiveIndexWriterConfig

Expert: sets if indexing threads check for pending flushes on update in order to help our flushing indexing buffers to disk. As a consequence, threads calling or IndexWriter.flush will be the only thread writing segments to disk unless flushes are falling behind. If indexing is stalled due to too many pending flushes indexing threads will help our writing pending segment flushes to disk.

Link copied to clipboard
open fun setMaxBufferedDocs(maxBufferedDocs: Int): LiveIndexWriterConfig

Determines the minimal number of documents required before the buffered in-memory documents are flushed as a new Segment. Large values generally give faster indexing.

Link copied to clipboard

Set the merged segment warmer. See IndexReaderWarmer.

Link copied to clipboard

Expert: MergePolicy is invoked whenever there are changes to the segments in the index. Its role is to select which merges to do, if any, and return a [ ] describing the merges. It also selects merges to do for forceMerge.

Link copied to clipboard
open fun setRAMBufferSizeMB(ramBufferSizeMB: Double): LiveIndexWriterConfig

Determines the amount of RAM that may be used for buffering added documents and deletions before they are flushed to the Directory. Generally for faster indexing performance it's best to flush by RAM usage instead of document count and use as large a RAM buffer as you can.

Link copied to clipboard

Sets if the IndexWriter should pack newly written segments in a compound file. Default is true.

Link copied to clipboard
open override fun toString(): String