core/org.gnit.lucenekmp.index/MergePolicy/OneMerge

OneMerge

OneMerge provides the information necessary to perform an individual primitive merge operation, resulting in a single new segment. The merge spec includes the subset of segments to be merged as well as whether the new segment should use the compound file format.

Constructors

OneMerge

constructor(segments: MutableList<SegmentCommitInfo>)

Sole constructor.

constructor(vararg codecReaders: CodecReader)

Create a OneMerge directly from CodecReaders. Used to merge incoming readers in . This OneMerge works directly on readers and has an empty segments list.

Properties

debugPhase

@Volatile

var debugPhase: String

debugPhaseStartedAtNanos

@Volatile

var debugPhaseStartedAtNanos: Long

estimatedMergeBytes

@Volatile

var estimatedMergeBytes: Long

Estimated size in bytes of the merged segment.

exception

var exception: Throwable?

Record that an exception occurred while executing this merge

info

var info: SegmentCommitInfo?

isAborted

val isAborted: Boolean

isExternal

var isExternal: Boolean

maxNumSegments

var maxNumSegments: Int

mergeCompleted

val mergeCompleted: CompletableDeferred<Boolean>

mergeGen

var mergeGen: Long

mergeInfo

val mergeInfo: SegmentCommitInfo?

mergeProgress

val mergeProgress: MergePolicy.OneMergeProgress

Control used to pause/stop/resume the merge thread.

mergeReader

var mergeReader: MutableList<MergePolicy.MergeReader>

Returns the merge readers or an empty list if the readers were not initialized yet.

mergeStartNS

@Volatile

var mergeStartNS: Long

registerDone

var registerDone: Boolean

segments

val segments: MutableList<SegmentCommitInfo>

Segments to be merged.

storeMergeInfo

val storeMergeInfo: MergeInfo

totalMaxDoc

val totalMaxDoc: Int

Total number of documents in segments to be merged, not accounting for deletions.

totalMergeBytes

@Volatile

var totalMergeBytes: Long

usesPooledReaders

var usesPooledReaders: Boolean

Functions

await

suspend fun await(timeout: Long, timeUnit: TimeUnit): Boolean

Waits for this merge to be completed

checkAborted

fun checkAborted()

Checks if merge has been aborted and throws a merge exception if so.

fun close(success: Boolean, segmentDropped: Boolean, readerConsumer: IOConsumer<MergePolicy.MergeReader>)

Closes this merge and releases all merge readers

debugPhaseElapsedMs

fun debugPhaseElapsedMs(nowNanos: Long = System.nanoTime()): Long

hasCompletedSuccessfully

fun hasCompletedSuccessfully(): Optional<Boolean?>

Returns true if the merge completed successfully or false if the merge succeeded with a failure. This method will not block and return an empty Optional if the merge has not finished yet

hasFinished

fun hasFinished(): Boolean

Returns true if the merge has finished or false if it's still running or has not been started. This method will not block.

initMergeReaders

open fun initMergeReaders(readerFactory: IOFunction<SegmentCommitInfo, MergePolicy.MergeReader>)

Sets the merge readers for this merge.

markDebugPhase

fun markDebugPhase(phase: String)

mergeFinished

open fun mergeFinished(success: Boolean, segmentDropped: Boolean)

Called by IndexWriter after the merge is done and all readers have been closed.

mergeInit

suspend fun mergeInit()

Called by IndexWriter after the merge started and from the thread that will be executing the merge.

onMergeComplete

open fun onMergeComplete()

Called just before the merge is applied to IndexWriter's SegmentInfos

reorder

open fun reorder(reader: CodecReader, dir: Directory, executor: Executor): Sorter.DocMap?

Extend this method if you wish to renumber doc IDs. This method will be called when index sorting is disabled on a merged view of the OneMerge. A null return value indicates that doc IDs should not be reordered.

segString

fun segString(): String

Returns a readable description of the current merge state.

setAborted

suspend fun setAborted()

Marks this merge as aborted. The merge thread should terminate at the soonest possible moment.

setMergeInfo

open fun setMergeInfo(info: SegmentCommitInfo)

Expert: Sets the SegmentCommitInfo of the merged segment. Allows sub-classes to e.g. add diagnostic properties.

totalBytesSize

fun totalBytesSize(): Long

Returns the total size in bytes of this merge. Note that this does not indicate the size of the merged segment, but the input total size. This is only set once the merge is initialized by IndexWriter.

totalNumDocs

fun totalNumDocs(): Int

Returns the total number of documents that are included with this merge. Note that this does not indicate the number of documents after the merge.

wrapForMerge

open fun wrapForMerge(reader: CodecReader): CodecReader

Wrap a reader prior to merging in order to add/remove fields or documents.