org.elasticsearch.index.engine
Interface Engine

All Superinterfaces:

CloseableComponent, IndexShardComponent

All Known Implementing Classes:

RobinEngine

@ThreadSafe
public interface Engine
extends IndexShardComponent, CloseableComponent

Nested Class Summary

static class	Engine.Bulk
static class	Engine.Create
static class	Engine.Delete
static class	Engine.DeleteByQuery
static class	Engine.Flush
static class	Engine.Index
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 interface	Engine.SnapshotHandler<T>

Method Summary

EngineException[]	bulk(Engine.Bulk bulk)
void	create(Engine.Create create)
void	delete(Engine.Delete delete)
void	delete(Engine.DeleteByQuery delete)
ByteSizeValue	estimateFlushableMemorySize() Returns the estimated flushable memory size.
void	flush(Engine.Flush flush) Flushes the state of the engine, clearing memory.
void	index(Engine.Index index)
void	optimize(Engine.Optimize optimize)
void	recover(Engine.RecoveryHandler recoveryHandler)
void	refresh(Engine.Refresh refresh) Refreshes the engine for new search operations to reflect the latest changes.
Engine.Searcher	searcher()
<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

Method Detail

updateIndexingBufferSize

void updateIndexingBufferSize(ByteSizeValue indexingBufferSize)

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

bulk

EngineException[] bulk(Engine.Bulk bulk)
                       throws EngineException

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

searcher

Engine.Searcher searcher()
                         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

estimateFlushableMemorySize

ByteSizeValue estimateFlushableMemorySize()

Returns the estimated flushable memory size. Returns null if not available.