org.elasticsearch.index.translog

Class TranslogConfig

java.lang.Object

org.elasticsearch.index.translog.TranslogConfig

public final class TranslogConfig
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	INDEX_TRANSLOG_BUFFER_SIZE
static String	INDEX_TRANSLOG_DURABILITY
static String	INDEX_TRANSLOG_FS_TYPE
static String	INDEX_TRANSLOG_SYNC_INTERVAL

Constructor Summary

Constructors

Constructor and Description
TranslogConfig(ShardId shardId, Path translogPath, Settings indexSettings, Translog.Durabilty durabilty, BigArrays bigArrays, ThreadPool threadPool) Creates a new TranslogConfig instance

Method Summary

Methods

Modifier and Type	Method and Description
BigArrays	getBigArrays() Returns a BigArrays instance for this engine
int	getBufferSize() Retruns the current translog buffer size.
Translog.Durabilty	getDurabilty() Returns the current durability mode of this translog.
Settings	getIndexSettings() Returns the current index settings
ShardId	getShardId() Returns the shard ID this config is created for
TimeValue	getSyncInterval() Returns the current async fsync interval
ThreadPool	getThreadPool() Returns a ThreadPool to schedule async durability operations
Translog.TranslogGeneration	getTranslogGeneration() Returns the translog generation to open.
Path	getTranslogPath() Returns the translog path for this engine
TranslogWriter.Type	getType() Returns the translog type
boolean	isSyncOnEachOperation() Returns true iff each low level operation shoudl be fsynced
void	setBufferSize(int bufferSize) Sets the current buffer size - for setting a live setting use Translog.updateBuffer(ByteSizeValue)
void	setDurabilty(Translog.Durabilty durabilty) Sets the current durability mode for the translog.
void	setTranslogGeneration(Translog.TranslogGeneration translogGeneration) Set the generation to be opened.
void	setType(TranslogWriter.Type type) Sets the TranslogType for this Translog.

Methods inherited from class java.lang.Object

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

Field Detail

INDEX_TRANSLOG_DURABILITY

public static final String INDEX_TRANSLOG_DURABILITY

See Also:

Constant Field Values

INDEX_TRANSLOG_FS_TYPE

public static final String INDEX_TRANSLOG_FS_TYPE

See Also:

Constant Field Values

INDEX_TRANSLOG_BUFFER_SIZE

public static final String INDEX_TRANSLOG_BUFFER_SIZE

See Also:

Constant Field Values

INDEX_TRANSLOG_SYNC_INTERVAL

public static final String INDEX_TRANSLOG_SYNC_INTERVAL

See Also:

Constant Field Values

Constructor Detail

TranslogConfig

public TranslogConfig(ShardId shardId,
              Path translogPath,
              Settings indexSettings,
              Translog.Durabilty durabilty,
              BigArrays bigArrays,
              @Nullable
              ThreadPool threadPool)

Creates a new TranslogConfig instance

Parameters:

shardId - the shard ID this translog belongs to

translogPath - the path to use for the transaction log files

indexSettings - the index settings used to set internal variables

durabilty - the default durability setting for the translog

bigArrays - a bigArrays instance used for temporarily allocating write operations

threadPool - a ThreadPool to schedule async sync durability

Method Detail

getThreadPool

public ThreadPool getThreadPool()

Returns a ThreadPool to schedule async durability operations

getDurabilty

public Translog.Durabilty getDurabilty()

Returns the current durability mode of this translog.

setDurabilty

public void setDurabilty(Translog.Durabilty durabilty)

Sets the current durability mode for the translog.

getType

public TranslogWriter.Type getType()

Returns the translog type

setType

public void setType(TranslogWriter.Type type)

Sets the TranslogType for this Translog. The change will affect all subsequent translog files.

isSyncOnEachOperation

public boolean isSyncOnEachOperation()

Returns true iff each low level operation shoudl be fsynced

getBufferSize

public int getBufferSize()

Retruns the current translog buffer size.

setBufferSize

public void setBufferSize(int bufferSize)

Sets the current buffer size - for setting a live setting use Translog.updateBuffer(ByteSizeValue)

getSyncInterval

public TimeValue getSyncInterval()

Returns the current async fsync interval

getIndexSettings

public Settings getIndexSettings()

Returns the current index settings

getShardId

public ShardId getShardId()

Returns the shard ID this config is created for

getBigArrays

public BigArrays getBigArrays()

Returns a BigArrays instance for this engine

getTranslogPath

public Path getTranslogPath()

Returns the translog path for this engine

getTranslogGeneration

public Translog.TranslogGeneration getTranslogGeneration()

Returns the translog generation to open. If this is null a new translog is created. If non-null the translog tries to open the given translog generation. The generation is treated as the last generation referenced form already committed data. This means all operations that have not yet been committed should be in the translog file referenced by this generation. The translog creation will fail if this generation can't be opened.

setTranslogGeneration

public void setTranslogGeneration(Translog.TranslogGeneration translogGeneration)

Set the generation to be opened. Use null to start with a fresh translog.

See Also:

getTranslogGeneration()