Module org.elasticsearch.server

Package 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	Description
static final ByteSizeValue	DEFAULT_BUFFER_SIZE
static final ByteSizeValue	EMPTY_TRANSLOG_BUFFER_SIZE
static final OperationListener	NOOP_OPERATION_LISTENER

Constructor Summary

Constructors

Constructor	Description
TranslogConfig(ShardId shardId, Path translogPath, IndexSettings indexSettings, BigArrays bigArrays)	Creates a new TranslogConfig instance
TranslogConfig(ShardId shardId, Path translogPath, IndexSettings indexSettings, BigArrays bigArrays, ByteSizeValue bufferSize, DiskIoBufferPool diskIoBufferPool, OperationListener operationListener)
TranslogConfig(ShardId shardId, Path translogPath, IndexSettings indexSettings, BigArrays bigArrays, ByteSizeValue bufferSize, DiskIoBufferPool diskIoBufferPool, OperationListener operationListener, boolean fsync)

Method Summary

Modifier and Type	Method	Description
boolean	fsync()
BigArrays	getBigArrays()	Returns a BigArrays instance for this engine
ByteSizeValue	getBufferSize()	The translog buffer size.
DiskIoBufferPool	getDiskIoBufferPool()	DiskIoBufferPool for this engine.
IndexSettings	getIndexSettings()	Returns the index indexSettings
OperationListener	getOperationListener()
ShardId	getShardId()	Returns the shard ID this config is created for
Path	getTranslogPath()	Returns the translog path for this engine
boolean	hasTranslog()

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_BUFFER_SIZE

public static final ByteSizeValue DEFAULT_BUFFER_SIZE

EMPTY_TRANSLOG_BUFFER_SIZE

public static final ByteSizeValue EMPTY_TRANSLOG_BUFFER_SIZE

NOOP_OPERATION_LISTENER

public static final OperationListener NOOP_OPERATION_LISTENER

Constructor Details

TranslogConfig

public TranslogConfig(ShardId shardId,
 Path translogPath,
 IndexSettings indexSettings,
 BigArrays bigArrays)

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

bigArrays - a bigArrays instance used for temporarily allocating write operations

TranslogConfig

public TranslogConfig(ShardId shardId,
 Path translogPath,
 IndexSettings indexSettings,
 BigArrays bigArrays,
 ByteSizeValue bufferSize,
 DiskIoBufferPool diskIoBufferPool,
 OperationListener operationListener)

TranslogConfig

public TranslogConfig(ShardId shardId,
 Path translogPath,
 IndexSettings indexSettings,
 BigArrays bigArrays,
 ByteSizeValue bufferSize,
 DiskIoBufferPool diskIoBufferPool,
 OperationListener operationListener,
 boolean fsync)

Method Details

getIndexSettings

public IndexSettings getIndexSettings()

Returns the index indexSettings

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

getBufferSize

public ByteSizeValue getBufferSize()

The translog buffer size. Default is 8kb

getDiskIoBufferPool

public DiskIoBufferPool getDiskIoBufferPool()

DiskIoBufferPool for this engine. Used to allow custom pools in tests, always returns DiskIoBufferPool.INSTANCE in production.

getOperationListener

public OperationListener getOperationListener()

fsync

public boolean fsync()

Returns:

true if translog writes need to be followed by fsync

hasTranslog

public boolean hasTranslog()

Returns:

true if the configuration allows the Translog files to exist, false otherwise. In the case there is no translog, the shard is not writeable.