public class InternalEngine extends Engine
Engine.CommitId, Engine.Delete, Engine.DeleteResult, Engine.EventListener, Engine.Get, Engine.GetResult, Engine.Index, Engine.IndexResult, Engine.IndexThrottle, Engine.NoOpLock, Engine.Operation, Engine.Result, Engine.Searcher, Engine.SyncedFlushResult, Engine.Warmer
deletionPolicy, engineConfig, eventListener, failedEngine, failEngineLock, isClosed, lastWriteNanos, logger, readLock, rwl, shardId, store, SYNC_COMMIT_ID, writeLock
Constructor and Description |
---|
InternalEngine(EngineConfig engineConfig) |
Modifier and Type | Method and Description |
---|---|
org.apache.lucene.index.IndexCommit |
acquireIndexCommit(boolean flushFirst)
Snapshots the index and returns a handle to it.
|
void |
activateThrottling()
Request that this engine throttle incoming indexing requests to one thread.
|
protected void |
closeNoLock(java.lang.String reason,
java.util.concurrent.CountDownLatch closedLatch)
Closes the engine without acquiring the write lock.
|
void |
deactivateThrottling()
Reverses a previous
Engine.activateThrottling() call. |
Engine.DeleteResult |
delete(Engine.Delete delete)
Perform document delete operation on the engine
|
Engine.CommitId |
flush()
Flushes the state of the engine including the transaction log, clearing memory and persisting
documents in the lucene index to disk including a potentially heavy and durable fsync operation.
|
Engine.CommitId |
flush(boolean force,
boolean waitIfOngoing)
Flushes the state of the engine including the transaction log, clearing memory.
|
void |
forceMerge(boolean flush,
int maxNumSegments,
boolean onlyExpungeDeletes,
boolean upgrade,
boolean upgradeOnlyAncientSegments)
Triggers a forced merge on this engine
|
Engine.GetResult |
get(Engine.Get get,
java.util.function.Function<java.lang.String,Engine.Searcher> searcherFactory) |
long |
getIndexBufferRAMBytesUsed()
How much heap is used that would be freed by a refresh.
|
long |
getIndexThrottleTimeInMillis()
Returns the number of milliseconds this engine was under index throttling.
|
protected org.apache.lucene.index.SegmentInfos |
getLastCommittedSegmentInfos() |
MergeStats |
getMergeStats() |
protected org.apache.lucene.search.SearcherManager |
getSearcherManager() |
Translog |
getTranslog()
returns the translog for this engine
|
Engine.IndexResult |
index(Engine.Index index)
Perform document index operation on the engine
|
boolean |
isRecovering()
Returns
true iff this engine is currently recovering from translog. |
boolean |
isThrottled()
Returns the
true iff this engine is currently under index throttling. |
protected boolean |
maybeFailEngine(java.lang.String source,
java.lang.Exception e)
Check whether the engine should be failed
|
void |
onSettingsChanged() |
InternalEngine |
recoverFromTranslog()
Performs recovery from the transaction log.
|
void |
refresh(java.lang.String source)
Synchronously refreshes the engine for new search operations to reflect the latest
changes.
|
java.util.List<Segment> |
segments(boolean verbose)
The list of segments in the engine.
|
Engine.SyncedFlushResult |
syncFlush(java.lang.String syncId,
Engine.CommitId expectedCommitId)
Attempts to do a special commit where the given syncID is put into the commit data.
|
void |
writeIndexingBuffer()
Called when our engine is using too much heap and should move buffered indexed/deleted documents to disk.
|
protected void |
writerSegmentStats(SegmentsStats stats) |
acquireSearcher, close, commitStats, config, ensureOpen, failEngine, flushAndClose, forceMerge, getFromSearcher, getLastWriteNanos, getSegmentInfo, guardedRamBytesUsed, isMergedSegment, newSearcher, readLastCommittedSegmentInfos, refreshNeeded, segmentReader, segmentsStats
public InternalEngine(EngineConfig engineConfig) throws EngineException
EngineException
public InternalEngine recoverFromTranslog() throws java.io.IOException
Engine
recoverFromTranslog
in class Engine
java.io.IOException
public Translog getTranslog()
Engine
getTranslog
in class Engine
public Engine.GetResult get(Engine.Get get, java.util.function.Function<java.lang.String,Engine.Searcher> searcherFactory) throws EngineException
get
in class Engine
EngineException
public Engine.IndexResult index(Engine.Index index) throws java.io.IOException
Engine
index
in class Engine
index
- operation to performEngine.IndexResult
containing updated translog location, version and
document specific failures
Note: engine level failures (i.e. persistent engine failures) are thrownjava.io.IOException
public Engine.DeleteResult delete(Engine.Delete delete) throws java.io.IOException
Engine
delete
in class Engine
delete
- operation to performEngine.DeleteResult
containing updated translog location, version and
document specific failures
Note: engine level failures (i.e. persistent engine failures) are thrownjava.io.IOException
public void refresh(java.lang.String source) throws EngineException
Engine
refresh
in class Engine
EngineException
public void writeIndexingBuffer() throws EngineException
Engine
writeIndexingBuffer
in class Engine
EngineException
public Engine.SyncedFlushResult syncFlush(java.lang.String syncId, Engine.CommitId expectedCommitId) throws EngineException
Engine
syncFlush
in class Engine
syncId
- id of this syncexpectedCommitId
- the expected value ofEngineException
public Engine.CommitId flush() throws EngineException
Engine
flush
in class Engine
EngineException
public Engine.CommitId flush(boolean force, boolean waitIfOngoing) throws EngineException
Engine
flush
in class Engine
force
- if true
a lucene commit is executed even if no changes need to be committed.waitIfOngoing
- if true
this call will block until all currently running flushes have finished.
Otherwise this call will return without blocking.EngineException
public void forceMerge(boolean flush, int maxNumSegments, boolean onlyExpungeDeletes, boolean upgrade, boolean upgradeOnlyAncientSegments) throws EngineException, java.io.IOException
Engine
forceMerge
in class Engine
EngineException
java.io.IOException
public org.apache.lucene.index.IndexCommit acquireIndexCommit(boolean flushFirst) throws EngineException
Engine
acquireIndexCommit
in class Engine
flushFirst
- indicates whether the engine should flush before returning the snapshotEngineException
protected boolean maybeFailEngine(java.lang.String source, java.lang.Exception e)
Engine
maybeFailEngine
in class Engine
protected org.apache.lucene.index.SegmentInfos getLastCommittedSegmentInfos()
getLastCommittedSegmentInfos
in class Engine
protected final void writerSegmentStats(SegmentsStats stats)
writerSegmentStats
in class Engine
public long getIndexBufferRAMBytesUsed()
Engine
AlreadyClosedException
.getIndexBufferRAMBytesUsed
in class Engine
public java.util.List<Segment> segments(boolean verbose)
Engine
protected final void closeNoLock(java.lang.String reason, java.util.concurrent.CountDownLatch closedLatch)
closeNoLock
in class Engine
protected org.apache.lucene.search.SearcherManager getSearcherManager()
getSearcherManager
in class Engine
public void activateThrottling()
Engine
Engine.deactivateThrottling()
.activateThrottling
in class Engine
public void deactivateThrottling()
Engine
Engine.activateThrottling()
call.deactivateThrottling
in class Engine
public boolean isThrottled()
Engine
true
iff this engine is currently under index throttling.isThrottled
in class Engine
Engine.getIndexThrottleTimeInMillis()
public long getIndexThrottleTimeInMillis()
Engine
getIndexThrottleTimeInMillis
in class Engine
public void onSettingsChanged()
onSettingsChanged
in class Engine
public MergeStats getMergeStats()
getMergeStats
in class Engine
public boolean isRecovering()
Engine
true
iff this engine is currently recovering from translog.isRecovering
in class Engine