Package org.elasticsearch.repositories

Interface Repository

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, LifecycleComponent, Releasable

All Known Implementing Classes:

BlobStoreRepository, FsRepository

public interface Repository
extends LifecycleComponent

An interface for interacting with a repository in snapshot and restore.

Implementations are responsible for reading and writing both metadata and shard data to and from a repository backend.

To perform a snapshot:

• Master calls initializeSnapshot(SnapshotId, List, org.elasticsearch.cluster.metadata.MetaData) with list of indices that will be included into the snapshot
• Data nodes call snapshotShard(IndexShard, SnapshotId, IndexId, IndexCommit, IndexShardSnapshotStatus) for each shard
• When all shard calls return master calls finalizeSnapshot(org.elasticsearch.snapshots.SnapshotId, java.util.List<org.elasticsearch.repositories.IndexId>, long, java.lang.String, int, java.util.List<org.elasticsearch.snapshots.SnapshotShardFailure>, long, boolean) with possible list of failures

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Repository.Factory	An factory interface for constructing repositories.

Method Summary

Modifier and Type	Method	Description
void	deleteSnapshot(SnapshotId snapshotId, long repositoryStateId)	Deletes snapshot
void	endVerification(java.lang.String verificationToken)	Called at the end of repository verification process.
SnapshotInfo	finalizeSnapshot(SnapshotId snapshotId, java.util.List<IndexId> indices, long startTime, java.lang.String failure, int totalShards, java.util.List<SnapshotShardFailure> shardFailures, long repositoryStateId, boolean includeGlobalState)	Finalizes snapshotting process
RepositoryMetaData	getMetadata()	Returns metadata about this repository.
RepositoryData	getRepositoryData()	Returns a RepositoryData to describe the data in the repository, including the snapshots and the indices across all snapshots found in the repository.
long	getRestoreThrottleTimeInNanos()	Returns restore throttle time in nanoseconds
IndexShardSnapshotStatus	getShardSnapshotStatus(SnapshotId snapshotId, Version version, IndexId indexId, ShardId shardId)	Retrieve shard snapshot status for the stored snapshot
SnapshotInfo	getSnapshotInfo(SnapshotId snapshotId)	Reads snapshot description from repository.
MetaData	getSnapshotMetaData(SnapshotInfo snapshot, java.util.List<IndexId> indices)	Returns global metadata associate with the snapshot.
long	getSnapshotThrottleTimeInNanos()	Returns snapshot throttle time in nanoseconds
void	initializeSnapshot(SnapshotId snapshotId, java.util.List<IndexId> indices, MetaData metaData)	Starts snapshotting process
boolean	isReadOnly()	Returns true if the repository supports only read operations
void	restoreShard(IndexShard shard, SnapshotId snapshotId, Version version, IndexId indexId, ShardId snapshotShardId, RecoveryState recoveryState)	Restores snapshot of the shard.
void	snapshotShard(IndexShard shard, SnapshotId snapshotId, IndexId indexId, org.apache.lucene.index.IndexCommit snapshotIndexCommit, IndexShardSnapshotStatus snapshotStatus)	Creates a snapshot of the shard based on the index commit point.
java.lang.String	startVerification()	Verifies repository on the master node and returns the verification token.
void	verify(java.lang.String verificationToken, DiscoveryNode localNode)	Verifies repository settings on data node.

Methods inherited from interface org.elasticsearch.common.component.LifecycleComponent

addLifecycleListener, lifecycleState, removeLifecycleListener, start, stop

Methods inherited from interface org.elasticsearch.common.lease.Releasable

close

Method Detail

getMetadata

RepositoryMetaData getMetadata()

Returns metadata about this repository.

getSnapshotInfo

SnapshotInfo getSnapshotInfo(SnapshotId snapshotId)

Reads snapshot description from repository.

Parameters:

snapshotId - snapshot id

Returns:

information about snapshot

getSnapshotMetaData

MetaData getSnapshotMetaData(SnapshotInfo snapshot,
                             java.util.List<IndexId> indices)
                      throws java.io.IOException

Returns global metadata associate with the snapshot.

The returned meta data contains global metadata as well as metadata for all indices listed in the indices parameter.

Parameters:

snapshot - snapshot

indices - list of indices

Returns:

information about snapshot

Throws:

java.io.IOException

getRepositoryData

RepositoryData getRepositoryData()

Returns a RepositoryData to describe the data in the repository, including the snapshots and the indices across all snapshots found in the repository. Throws a RepositoryException if there was an error in reading the data.

initializeSnapshot

void initializeSnapshot(SnapshotId snapshotId,
                        java.util.List<IndexId> indices,
                        MetaData metaData)

Starts snapshotting process

Parameters:

snapshotId - snapshot id

indices - list of indices to be snapshotted

metaData - cluster metadata

finalizeSnapshot

SnapshotInfo finalizeSnapshot(SnapshotId snapshotId,
                              java.util.List<IndexId> indices,
                              long startTime,
                              java.lang.String failure,
                              int totalShards,
                              java.util.List<SnapshotShardFailure> shardFailures,
                              long repositoryStateId,
                              boolean includeGlobalState)

Finalizes snapshotting process

This method is called on master after all shards are snapshotted.

Parameters:

snapshotId - snapshot id

indices - list of indices in the snapshot

startTime - start time of the snapshot

failure - global failure reason or null

totalShards - total number of shards

shardFailures - list of shard failures

repositoryStateId - the unique id identifying the state of the repository when the snapshot began

includeGlobalState - include cluster global state

Returns:

snapshot description

deleteSnapshot

void deleteSnapshot(SnapshotId snapshotId,
                    long repositoryStateId)

Deletes snapshot

Parameters:

snapshotId - snapshot id

repositoryStateId - the unique id identifying the state of the repository when the snapshot deletion began

getSnapshotThrottleTimeInNanos

long getSnapshotThrottleTimeInNanos()

Returns snapshot throttle time in nanoseconds

getRestoreThrottleTimeInNanos

long getRestoreThrottleTimeInNanos()

Returns restore throttle time in nanoseconds

startVerification

java.lang.String startVerification()

Verifies repository on the master node and returns the verification token.

If the verification token is not null, it's passed to all data nodes for verification. If it's null - no additional verification is required

Returns:

verification token that should be passed to all Index Shard Repositories for additional verification or null

endVerification

void endVerification(java.lang.String verificationToken)

Called at the end of repository verification process.

This method should perform all necessary cleanup of the temporary files created in the repository

Parameters:

verificationToken - verification request generated by startVerification() command

verify

void verify(java.lang.String verificationToken,
            DiscoveryNode localNode)

Verifies repository settings on data node.

Parameters:

verificationToken - value returned by startVerification()

localNode - the local node information, for inclusion in verification errors

isReadOnly

boolean isReadOnly()

Returns true if the repository supports only read operations

Returns:

true if the repository is read/only

snapshotShard

void snapshotShard(IndexShard shard,
                   SnapshotId snapshotId,
                   IndexId indexId,
                   org.apache.lucene.index.IndexCommit 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.acquireLastIndexCommit(boolean) method. Repository 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.isAborted() to see if the snapshot process should be aborted.

Parameters:

shard - shard to be snapshotted

snapshotId - snapshot id

indexId - id for the index being snapshotted

snapshotIndexCommit - commit point

snapshotStatus - snapshot status

restoreShard

void restoreShard(IndexShard shard,
                  SnapshotId snapshotId,
                  Version version,
                  IndexId indexId,
                  ShardId snapshotShardId,
                  RecoveryState recoveryState)

Restores snapshot of the shard.

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

Parameters:

shard - the shard to restore the index into

snapshotId - snapshot id

version - version of elasticsearch that created this snapshot

indexId - id of the index in the repository from which the restore is occurring

snapshotShardId - shard id (in the snapshot)

recoveryState - recovery state

getShardSnapshotStatus

IndexShardSnapshotStatus getShardSnapshotStatus(SnapshotId snapshotId,
                                                Version version,
                                                IndexId indexId,
                                                ShardId shardId)

Retrieve shard snapshot status for the stored snapshot

Parameters:

snapshotId - snapshot id

version - version of elasticsearch that created this snapshot

indexId - the snapshotted index id for the shard to get status for

shardId - shard id

Returns:

snapshot status