org.elasticsearch.index.deletionpolicy

Class SnapshotDeletionPolicy

java.lang.Object

org.apache.lucene.index.IndexDeletionPolicy

org.elasticsearch.index.deletionpolicy.SnapshotDeletionPolicy

All Implemented Interfaces:

IndexShardComponent

public class SnapshotDeletionPolicy
extends org.apache.lucene.index.IndexDeletionPolicy

Snapshot deletion policy allows to get snapshots of an index state (last commit or all commits) and if the deletion policy is used with all open index writers (JVM level) then the snapshot state will not be deleted until it will be released.

Field Summary

Fields

Modifier and Type	Field and Description
protected Settings	indexSettings
protected ESLogger	logger
protected ShardId	shardId

Constructor Summary

Constructors

Constructor and Description
SnapshotDeletionPolicy(org.apache.lucene.index.IndexDeletionPolicy primary) Constructs a new snapshot deletion policy that wraps the provided deletion policy.

Method Summary

Methods

Modifier and Type	Method and Description
org.apache.lucene.index.IndexDeletionPolicy	clone()
Settings	indexSettings()
String	nodeName()
void	onCommit(List<? extends org.apache.lucene.index.IndexCommit> commits) Called by Lucene..
void	onInit(List<? extends org.apache.lucene.index.IndexCommit> commits) Called by Lucene.
ShardId	shardId()
SnapshotIndexCommit	snapshot() Returns a snapshot of the index (for the last commit point).
SnapshotIndexCommits	snapshots() Snapshots all the current commits in the index.

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected final ESLogger logger

shardId

protected final ShardId shardId

indexSettings

protected final Settings indexSettings

Constructor Detail

SnapshotDeletionPolicy

@Inject
public SnapshotDeletionPolicy(org.apache.lucene.index.IndexDeletionPolicy primary)

Constructs a new snapshot deletion policy that wraps the provided deletion policy.

Method Detail

onInit

public void onInit(List<? extends org.apache.lucene.index.IndexCommit> commits)
            throws IOException

Called by Lucene. Same as onCommit(java.util.List).

Specified by:

onInit in class org.apache.lucene.index.IndexDeletionPolicy

Throws:

IOException

onCommit

public void onCommit(List<? extends org.apache.lucene.index.IndexCommit> commits)
              throws IOException

Called by Lucene.. Wraps the provided commits with SnapshotIndexCommit and delegates to the wrapped deletion policy.

Specified by:

onCommit in class org.apache.lucene.index.IndexDeletionPolicy

Throws:

IOException

snapshots

public SnapshotIndexCommits snapshots()
                               throws IOException

Snapshots all the current commits in the index. Make sure to call SnapshotIndexCommits.close() to release it.

Throws:

IOException

snapshot

public SnapshotIndexCommit snapshot()
                             throws IOException

Returns a snapshot of the index (for the last commit point). Make sure to call SnapshotIndexCommit.close() in order to release it.

Throws:

IOException

clone

public org.apache.lucene.index.IndexDeletionPolicy clone()

Overrides:

clone in class Object

shardId

public ShardId shardId()

Specified by:

shardId in interface IndexShardComponent

indexSettings

public Settings indexSettings()

Specified by:

indexSettings in interface IndexShardComponent

nodeName

public String nodeName()