org.elasticsearch.index.snapshots

Interface IndexShardRepository

All Known Implementing Classes:

BlobStoreIndexShardRepository, URLIndexShardRepository

public interface IndexShardRepository

Shard-level snapshot repository

IndexShardRepository is used on data node to create snapshots of individual shards. See Repository for more information.

Method Summary

Methods

Modifier and Type	Method and Description
void	restore(SnapshotId snapshotId, Version version, ShardId shardId, ShardId snapshotShardId, RecoveryState recoveryState) Restores snapshot of the shard.
void	snapshot(SnapshotId snapshotId, ShardId shardId, SnapshotIndexCommit snapshotIndexCommit, IndexShardSnapshotStatus snapshotStatus) Creates a snapshot of the shard based on the index commit point.
IndexShardSnapshotStatus	snapshotStatus(SnapshotId snapshotId, Version version, ShardId shardId) Retrieve shard snapshot status for the stored snapshot
void	verify(String verificationToken) Verifies repository settings on data node

Method Detail

snapshot

void snapshot(SnapshotId snapshotId,
            ShardId shardId,
            SnapshotIndexCommit snapshotIndexCommit,
            IndexShardSnapshotStatus snapshotStatus)

Creates a snapshot of the shard based on the index commit point.

The index commit point can be obtained by using Engine.snapshotIndex(boolean) method. IndexShardRepository implementations shouldn't release the snapshot index commit point. It is done by the method caller.

As snapshot process progresses, implementation of this method should update IndexShardSnapshotStatus object and check IndexShardSnapshotStatus.aborted() to see if the snapshot process should be aborted.

Parameters:

snapshotId - snapshot id

shardId - shard to be snapshotted

snapshotIndexCommit - commit point

snapshotStatus - snapshot status

restore

void restore(SnapshotId snapshotId,
           Version version,
           ShardId shardId,
           ShardId snapshotShardId,
           RecoveryState recoveryState)

Restores snapshot of the shard.

The index can be renamed on restore, hence different shardId and snapshotShardId are supplied.

Parameters:

snapshotId - snapshot id

shardId - shard id (in the current index)

version - version of elasticsearch that created this snapshot

snapshotShardId - shard id (in the snapshot)

recoveryState - recovery state

snapshotStatus

IndexShardSnapshotStatus snapshotStatus(SnapshotId snapshotId,
                                      Version version,
                                      ShardId shardId)

Retrieve shard snapshot status for the stored snapshot

Parameters:

snapshotId - snapshot id

version - version of elasticsearch that created this snapshot

shardId - shard id

Returns:

snapshot status

verify

void verify(String verificationToken)

Verifies repository settings on data node

Parameters:

verificationToken - value returned by Repository.startVerification()