Module org.apache.lucene.core

Package org.apache.lucene.index

Class FlushByRamOrCountsPolicy

java.lang.Object

org.apache.lucene.index.FlushPolicy

org.apache.lucene.index.FlushByRamOrCountsPolicy

class FlushByRamOrCountsPolicy
extends FlushPolicy

Default FlushPolicy implementation that flushes new segments based on RAM used and document count depending on the IndexWriter's IndexWriterConfig. It also applies pending deletes based on the number of buffered delete terms.

• onDelete(DocumentsWriterFlushControl, DocumentsWriterPerThread) - applies pending delete operations based on the global number of buffered delete terms if the consumed memory is greater than IndexWriterConfig.getRAMBufferSizeMB().
• onInsert(DocumentsWriterFlushControl, DocumentsWriterPerThread) - flushes either on the number of documents per DocumentsWriterPerThread ( DocumentsWriterPerThread.getNumDocsInRAM()) or on the global active memory consumption in the current indexing session iff IndexWriterConfig.getMaxBufferedDocs() or IndexWriterConfig.getRAMBufferSizeMB() is enabled respectively
• FlushPolicy.onUpdate(DocumentsWriterFlushControl, DocumentsWriterPerThread) - calls onInsert(DocumentsWriterFlushControl, DocumentsWriterPerThread) and onDelete(DocumentsWriterFlushControl, DocumentsWriterPerThread) in order

All IndexWriterConfig settings are used to mark DocumentsWriterPerThread as flush pending during indexing with respect to their live updates.

If IndexWriterConfig.setRAMBufferSizeMB(double) is enabled, the largest ram consuming DocumentsWriterPerThread will be marked as pending iff the global active RAM consumption is >= the configured max RAM buffer.

Field Summary

Fields inherited from class org.apache.lucene.index.FlushPolicy

indexWriterConfig, infoStream

Constructor Summary

Constructors

Constructor	Description
FlushByRamOrCountsPolicy()

Method Summary

Modifier and Type	Method	Description
protected boolean	flushOnDocCount()	Returns true if this FlushPolicy flushes on IndexWriterConfig.getMaxBufferedDocs(), otherwise false.
protected boolean	flushOnRAM()	Returns true if this FlushPolicy flushes on IndexWriterConfig.getRAMBufferSizeMB(), otherwise false.
protected void	markLargestWriterPending(DocumentsWriterFlushControl control, DocumentsWriterPerThread perThread)	Marks the most ram consuming active DocumentsWriterPerThread flush pending
void	onDelete(DocumentsWriterFlushControl control, DocumentsWriterPerThread perThread)	Called for each delete term.
void	onInsert(DocumentsWriterFlushControl control, DocumentsWriterPerThread perThread)	Called for each document addition on the given DocumentsWriterPerThreads DocumentsWriterPerThread.

Methods inherited from class org.apache.lucene.index.FlushPolicy

findLargestNonPendingWriter, init, onUpdate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

FlushByRamOrCountsPolicy

FlushByRamOrCountsPolicy()

Method Details

onDelete

public void onDelete(DocumentsWriterFlushControl control,
 DocumentsWriterPerThread perThread)

Description copied from class: FlushPolicy

Called for each delete term. If this is a delete triggered due to an update the given DocumentsWriterPerThread is non-null.

Note: This method is called synchronized on the given DocumentsWriterFlushControl and it is guaranteed that the calling thread holds the lock on the given DocumentsWriterPerThread

Specified by:

onDelete in class FlushPolicy

onInsert

public void onInsert(DocumentsWriterFlushControl control,
 DocumentsWriterPerThread perThread)

Description copied from class: FlushPolicy

Called for each document addition on the given DocumentsWriterPerThreads DocumentsWriterPerThread.

Note: This method is synchronized by the given DocumentsWriterFlushControl and it is guaranteed that the calling thread holds the lock on the given DocumentsWriterPerThread

Specified by:

onInsert in class FlushPolicy

markLargestWriterPending

protected void markLargestWriterPending(DocumentsWriterFlushControl control,
 DocumentsWriterPerThread perThread)

Marks the most ram consuming active DocumentsWriterPerThread flush pending

flushOnDocCount

protected boolean flushOnDocCount()

Returns true if this FlushPolicy flushes on IndexWriterConfig.getMaxBufferedDocs(), otherwise false.

flushOnRAM

protected boolean flushOnRAM()

Returns true if this FlushPolicy flushes on IndexWriterConfig.getRAMBufferSizeMB(), otherwise false.