org.elasticsearch.index.engine
Interface Engine

All Superinterfaces:

CloseableComponent, IndexShardComponent

All Known Implementing Classes:

RobinEngine

public interface Engine
extends IndexShardComponent, CloseableComponent

Nested Class Summary

static class	Engine.Create
static class	Engine.Delete
static class	Engine.DeleteByQuery
static interface	Engine.FailedEngineListener
static class	Engine.Flush
static class	Engine.Get
static class	Engine.GetResult
static class	Engine.Index
static interface	Engine.IndexingOperation
static interface	Engine.Operation
static class	Engine.Optimize
static interface	Engine.RecoveryHandler Recovery allow to start the recovery process.
static class	Engine.Refresh
static interface	Engine.Searcher
static class	Engine.SimpleSearcher
static interface	Engine.SnapshotHandler<T>

Field Summary

static ByteSizeValue

INACTIVE_SHARD_INDEXING_BUFFER

Method Summary

void	addFailedEngineListener(Engine.FailedEngineListener listener)
void	create(Engine.Create create)
TimeValue	defaultRefreshInterval() The default suggested refresh interval, -1 to disable it.
void	delete(Engine.Delete delete)
void	delete(Engine.DeleteByQuery delete)
void	enableGcDeletes(boolean enableGcDeletes)
void	flush(Engine.Flush flush) Flushes the state of the engine, clearing memory.
Engine.GetResult	get(Engine.Get get)
void	index(Engine.Index index)
void	maybeMerge()
void	optimize(Engine.Optimize optimize)
boolean	possibleMergeNeeded() Returns true if a possible merge is really needed.
void	recover(Engine.RecoveryHandler recoveryHandler)
void	refresh(Engine.Refresh refresh) Refreshes the engine for new search operations to reflect the latest changes.
boolean	refreshNeeded() Returns true if a refresh is really needed.
Engine.Searcher	searcher()
List<Segment>	segments()
<T> T	snapshot(Engine.SnapshotHandler<T> snapshotHandler)
void	start() Starts the Engine.
void	updateIndexingBufferSize(ByteSizeValue indexingBufferSize)

Methods inherited from interface org.elasticsearch.index.shard.IndexShardComponent

indexSettings, shardId

Methods inherited from interface org.elasticsearch.common.component.CloseableComponent

close

Field Detail

INACTIVE_SHARD_INDEXING_BUFFER

static final ByteSizeValue INACTIVE_SHARD_INDEXING_BUFFER

Method Detail

defaultRefreshInterval

TimeValue defaultRefreshInterval()

The default suggested refresh interval, -1 to disable it.

enableGcDeletes

void enableGcDeletes(boolean enableGcDeletes)

updateIndexingBufferSize

void updateIndexingBufferSize(ByteSizeValue indexingBufferSize)

addFailedEngineListener

void addFailedEngineListener(Engine.FailedEngineListener listener)

start

void start()
           throws EngineException

Starts the Engine.

Note, after the creation and before the call to start, the store might be changed.

Throws:

EngineException

create

void create(Engine.Create create)
            throws EngineException

Throws:

EngineException

index

void index(Engine.Index index)
           throws EngineException

Throws:

EngineException

delete

void delete(Engine.Delete delete)
            throws EngineException

Throws:

EngineException

delete

void delete(Engine.DeleteByQuery delete)
            throws EngineException

Throws:

EngineException

get

Engine.GetResult get(Engine.Get get)
                     throws EngineException

Throws:

EngineException

searcher

Engine.Searcher searcher()
                         throws EngineException

Throws:

EngineException

segments

List<Segment> segments()

refreshNeeded

boolean refreshNeeded()

Returns true if a refresh is really needed.

possibleMergeNeeded

boolean possibleMergeNeeded()

Returns true if a possible merge is really needed.

maybeMerge

void maybeMerge()
                throws EngineException

Throws:

EngineException

refresh

void refresh(Engine.Refresh refresh)
             throws EngineException

Refreshes the engine for new search operations to reflect the latest changes. Pass true if the refresh operation should include all the operations performed up to this call.

Throws:

EngineException

flush

void flush(Engine.Flush flush)
           throws EngineException,
                  FlushNotAllowedEngineException

Flushes the state of the engine, clearing memory.

Throws:

EngineException

FlushNotAllowedEngineException

optimize

void optimize(Engine.Optimize optimize)
              throws EngineException

Throws:

EngineException

snapshot

<T> T snapshot(Engine.SnapshotHandler<T> snapshotHandler)
           throws EngineException

Throws:

EngineException

recover

void recover(Engine.RecoveryHandler recoveryHandler)
             throws EngineException

Throws:

EngineException