org.elasticsearch.index.translog.fs

Class FsTranslog

java.lang.Object

org.elasticsearch.index.shard.AbstractIndexShardComponent

org.elasticsearch.index.translog.fs.FsTranslog

All Implemented Interfaces:

Closeable, AutoCloseable, org.apache.lucene.util.Accountable, CloseableIndexComponent, IndexShardComponent, Translog

public class FsTranslog
extends AbstractIndexShardComponent
implements Translog

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.index.translog.Translog

Translog.Create, Translog.Delete, Translog.DeleteByQuery, Translog.Index, Translog.Location, Translog.Operation, Translog.Snapshot, Translog.Source

Field Summary

Fields

Modifier and Type	Field and Description
static String	INDEX_TRANSLOG_FS_TYPE

Fields inherited from class org.elasticsearch.index.shard.AbstractIndexShardComponent

componentSettings, indexSettings, logger, shardId

Fields inherited from interface org.elasticsearch.index.translog.Translog

INACTIVE_SHARD_TRANSLOG_BUFFER, TRANSLOG_ID_KEY

Constructor Summary

Constructors

Constructor and Description
FsTranslog(ShardId shardId, Settings indexSettings, File location)
FsTranslog(ShardId shardId, Settings indexSettings, IndexSettingsService indexSettingsService, BigArrays bigArrays, IndexStore indexStore)

Method Summary

Modifier and Type	Method and Description
Translog.Location	add(Translog.Operation operation) Adds a create operation to the transaction log.
int	clearUnreferenced() Clears unreferenced transaction logs.
void	close() Closes the index component.
void	closeWithDelete()
long	currentId() Returns the id of the current transaction log.
int	estimatedNumberOfOperations() Returns the number of operations in the transaction log.
File[]	locations()
void	makeTransientCurrent() Swaps the transient translog to be the current one.
void	newTransientTranslog(long id) Creates a new transient translog, where added ops will be added to the current one, and to it.
void	newTranslog(long id) Creates a new transaction log internally.
long	ramBytesUsed()
Translog.Operation	read(Translog.Location location) Read the Operation object from the given location, returns null if the Operation could not be read.
void	revertTransient() Reverts back to not have a transient translog.
FsChannelSnapshot	snapshot() Snapshots the current transaction log allowing to safely iterate over the snapshot.
Translog.Snapshot	snapshot(Translog.Snapshot snapshot) Snapshots the delta between the current state of the translog, and the state defined by the provided snapshot.
TranslogStats	stats() return stats
void	sync() Sync's the translog.
boolean	syncNeeded()
void	syncOnEachOperation(boolean syncOnEachOperation)
long	translogSizeInBytes() Returns the size in bytes of the translog.
void	updateBuffer(ByteSizeValue bufferSize)

Methods inherited from class org.elasticsearch.index.shard.AbstractIndexShardComponent

indexSettings, nodeName, shardId

Methods inherited from class java.lang.Object

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

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

indexSettings, shardId

Field Detail

INDEX_TRANSLOG_FS_TYPE

public static final String INDEX_TRANSLOG_FS_TYPE

See Also:

Constant Field Values

Constructor Detail

FsTranslog

@Inject
public FsTranslog(ShardId shardId,
                          @IndexSettings
                          Settings indexSettings,
                          IndexSettingsService indexSettingsService,
                          BigArrays bigArrays,
                          IndexStore indexStore)
                   throws IOException

Throws:

IOException

FsTranslog

public FsTranslog(ShardId shardId,
                  @IndexSettings
                  Settings indexSettings,
                  File location)

Method Detail

closeWithDelete

public void closeWithDelete()

Specified by:

closeWithDelete in interface Translog

close

public void close()
           throws ElasticsearchException

Description copied from interface: CloseableIndexComponent

Closes the index component. A boolean indicating if its part of an actual index deletion or not is passed.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface CloseableIndexComponent

Throws:

ElasticsearchException

updateBuffer

public void updateBuffer(ByteSizeValue bufferSize)

Specified by:

updateBuffer in interface Translog

locations

public File[] locations()

currentId

public long currentId()

Description copied from interface: Translog

Returns the id of the current transaction log.

Specified by:

currentId in interface Translog

estimatedNumberOfOperations

public int estimatedNumberOfOperations()

Description copied from interface: Translog

Returns the number of operations in the transaction log.

Specified by:

estimatedNumberOfOperations in interface Translog

ramBytesUsed

public long ramBytesUsed()

Specified by:

ramBytesUsed in interface org.apache.lucene.util.Accountable

translogSizeInBytes

public long translogSizeInBytes()

Description copied from interface: Translog

Returns the size in bytes of the translog.

Specified by:

translogSizeInBytes in interface Translog

clearUnreferenced

public int clearUnreferenced()

Description copied from interface: Translog

Clears unreferenced transaction logs.

Specified by:

clearUnreferenced in interface Translog

Returns:

the number of clean up files

newTranslog

public void newTranslog(long id)
                 throws TranslogException

Description copied from interface: Translog

Creates a new transaction log internally.

Can only be called by one thread.

Specified by:

newTranslog in interface Translog

Throws:

TranslogException

newTransientTranslog

public void newTransientTranslog(long id)
                          throws TranslogException

Description copied from interface: Translog

Creates a new transient translog, where added ops will be added to the current one, and to it.

Can only be called by one thread.

Specified by:

newTransientTranslog in interface Translog

Throws:

TranslogException

makeTransientCurrent

public void makeTransientCurrent()

Description copied from interface: Translog

Swaps the transient translog to be the current one.

Can only be called by one thread.

Specified by:

makeTransientCurrent in interface Translog

revertTransient

public void revertTransient()

Description copied from interface: Translog

Reverts back to not have a transient translog.

Specified by:

revertTransient in interface Translog

read

public Translog.Operation read(Translog.Location location)

Read the Operation object from the given location, returns null if the Operation could not be read.

Specified by:

read in interface Translog

add

public Translog.Location add(Translog.Operation operation)
                      throws TranslogException

Description copied from interface: Translog

Adds a create operation to the transaction log.

Specified by:

add in interface Translog

Throws:

TranslogException

snapshot

public FsChannelSnapshot snapshot()
                           throws TranslogException

Description copied from interface: Translog

Snapshots the current transaction log allowing to safely iterate over the snapshot.

Specified by:

snapshot in interface Translog

Throws:

TranslogException

snapshot

public Translog.Snapshot snapshot(Translog.Snapshot snapshot)

Description copied from interface: Translog

Snapshots the delta between the current state of the translog, and the state defined by the provided snapshot. If a new translog has been created after the provided snapshot has been take, will return a snapshot on the current trasnlog.

Specified by:

snapshot in interface Translog

sync

public void sync()
          throws IOException

Description copied from interface: Translog

Sync's the translog.

Specified by:

sync in interface Translog

Throws:

IOException

syncNeeded

public boolean syncNeeded()

Specified by:

syncNeeded in interface Translog

syncOnEachOperation

public void syncOnEachOperation(boolean syncOnEachOperation)

Specified by:

syncOnEachOperation in interface Translog

stats

public TranslogStats stats()

Description copied from interface: Translog

return stats

Specified by:

stats in interface Translog