org.elasticsearch.index.translog

Class TranslogWriter

java.lang.Object

org.elasticsearch.index.translog.TranslogReader

org.elasticsearch.index.translog.TranslogWriter

All Implemented Interfaces:

Closeable, AutoCloseable, Comparable<TranslogReader>

Direct Known Subclasses:

BufferingTranslogWriter

public class TranslogWriter
extends TranslogReader

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TranslogWriter.Type

Field Summary

Fields

Modifier and Type	Field and Description
protected long	lastSyncedOffset
protected int	operationCounter
protected ReleasableLock	readLock
protected ShardId	shardId
static String	TRANSLOG_CODEC
static int	VERSION
static int	VERSION_CHECKPOINTS
static int	VERSION_CHECKSUMS
protected ReleasableLock	writeLock
protected long	writtenOffset

Fields inherited from class org.elasticsearch.index.translog.TranslogReader

channel, channelReference, closed, firstOperationOffset, generation, UNKNOWN_OP_COUNT

Constructor Summary

Constructors

Constructor and Description
TranslogWriter(ShardId shardId, long generation, org.elasticsearch.index.translog.ChannelReference channelReference)

Method Summary

Methods

Modifier and Type	Method and Description
Translog.Location	add(BytesReference data) add the given bytes to the translog and return the location they were written at
protected void	checkpoint(long lastSyncPosition, int operationCounter, org.elasticsearch.index.translog.ChannelReference channelReference)
protected void	closeWithTragicEvent(Throwable throwable)
static TranslogWriter	create(TranslogWriter.Type type, ShardId shardId, String translogUUID, long fileGeneration, Path file, Callback<org.elasticsearch.index.translog.ChannelReference> onClose, int bufferSize, org.elasticsearch.index.translog.TranslogWriter.ChannelFactory channelFactory)
protected void	ensureOpen()
protected void	flush() Flushes the buffer if the translog is buffered.
Throwable	getTragicException() If this TranslogWriter was closed as a side-effect of a tragic exception, e.g.
ImmutableTranslogReader	immutableReader() returns a new immutable reader which only exposes the current written operation *
TranslogReader	newReaderFromWriter() returns a new reader that follows the current writes (most importantly allows making repeated snapshots that includes new content)
protected void	readBytes(ByteBuffer buffer, long position) reads bytes at position into the given buffer, filling it.
long	sizeInBytes()
void	sync() write all buffered ops to disk and fsync file
boolean	syncNeeded() returns true if there are buffered ops
boolean	syncUpTo(long offset) Syncs the translog up to at least the given offset unless already synced
int	totalOperations()
void	updateBufferSize(int bufferSize) change the size of the internal buffer if relevant

Methods inherited from class org.elasticsearch.index.translog.TranslogReader

close, compareTo, getFirstOperationOffset, getGeneration, isClosed, newReaderSnapshot, newSnapshot, open, path, read, read, toString

Methods inherited from class java.lang.Object

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

Field Detail

TRANSLOG_CODEC

public static final String TRANSLOG_CODEC

See Also:

Constant Field Values

VERSION_CHECKSUMS

public static final int VERSION_CHECKSUMS

See Also:

Constant Field Values

VERSION_CHECKPOINTS

public static final int VERSION_CHECKPOINTS

See Also:

Constant Field Values

VERSION

public static final int VERSION

See Also:

Constant Field Values

shardId

protected final ShardId shardId

readLock

protected final ReleasableLock readLock

writeLock

protected final ReleasableLock writeLock

lastSyncedOffset

protected volatile long lastSyncedOffset

operationCounter

protected volatile int operationCounter

writtenOffset

protected volatile long writtenOffset

Constructor Detail

TranslogWriter

public TranslogWriter(ShardId shardId,
              long generation,
              org.elasticsearch.index.translog.ChannelReference channelReference)
               throws IOException

Throws:

IOException

Method Detail

create

public static TranslogWriter create(TranslogWriter.Type type,
                    ShardId shardId,
                    String translogUUID,
                    long fileGeneration,
                    Path file,
                    Callback<org.elasticsearch.index.translog.ChannelReference> onClose,
                    int bufferSize,
                    org.elasticsearch.index.translog.TranslogWriter.ChannelFactory channelFactory)
                             throws IOException

Throws:

IOException

getTragicException

public Throwable getTragicException()

If this TranslogWriter was closed as a side-effect of a tragic exception, e.g. disk full while flushing a new segment, this returns the root cause exception. Otherwise (no tragic exception has occurred) it returns null.

closeWithTragicEvent

protected final void closeWithTragicEvent(Throwable throwable)
                                   throws IOException

Throws:

IOException

add

public Translog.Location add(BytesReference data)
                      throws IOException

add the given bytes to the translog and return the location they were written at

Throws:

IOException

updateBufferSize

public void updateBufferSize(int bufferSize)
                      throws TranslogException

change the size of the internal buffer if relevant

Throws:

TranslogException

sync

public void sync()
          throws IOException

write all buffered ops to disk and fsync file

Throws:

IOException

syncNeeded

public boolean syncNeeded()

returns true if there are buffered ops

totalOperations

public int totalOperations()

Specified by:

totalOperations in class TranslogReader

sizeInBytes

public long sizeInBytes()

Specified by:

sizeInBytes in class TranslogReader

flush

protected void flush()
              throws IOException

Flushes the buffer if the translog is buffered.

Throws:

IOException

newReaderFromWriter

public TranslogReader newReaderFromWriter()

returns a new reader that follows the current writes (most importantly allows making repeated snapshots that includes new content)

immutableReader

public ImmutableTranslogReader immutableReader()
                                        throws TranslogException

returns a new immutable reader which only exposes the current written operation *

Throws:

TranslogException

syncUpTo

public boolean syncUpTo(long offset)
                 throws IOException

Syncs the translog up to at least the given offset unless already synced

Returns:

true if this call caused an actual sync operation

Throws:

IOException

readBytes

protected void readBytes(ByteBuffer buffer,
             long position)
                  throws IOException

Description copied from class: TranslogReader

reads bytes at position into the given buffer, filling it.

Specified by:

readBytes in class TranslogReader

Throws:

IOException

checkpoint

protected void checkpoint(long lastSyncPosition,
              int operationCounter,
              org.elasticsearch.index.translog.ChannelReference channelReference)
                   throws IOException

Throws:

IOException

ensureOpen

protected final void ensureOpen()

Overrides:

ensureOpen in class TranslogReader