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
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
deleteSnapshot(SnapshotId snapshotId, long repositoryStateId)
Deletes snapshotvoid
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 processRepositoryMetaData
getMetadata()
Returns metadata about this repository.RepositoryData
getRepositoryData()
Returns aRepositoryData
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 nanosecondsIndexShardSnapshotStatus
getShardSnapshotStatus(SnapshotId snapshotId, Version version, IndexId indexId, ShardId shardId)
Retrieve shard snapshot status for the stored snapshotMetaData
getSnapshotGlobalMetaData(SnapshotId snapshotId)
Returns global metadata associated with the snapshot.IndexMetaData
getSnapshotIndexMetaData(SnapshotId snapshotId, IndexId index)
Returns the index metadata associated with the snapshot.SnapshotInfo
getSnapshotInfo(SnapshotId snapshotId)
Reads snapshot description from repository.long
getSnapshotThrottleTimeInNanos()
Returns snapshot throttle time in nanosecondsvoid
initializeSnapshot(SnapshotId snapshotId, java.util.List<IndexId> indices, MetaData metaData)
Starts snapshotting processboolean
isReadOnly()
Returns true if the repository supports only read operationsvoid
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
-
getSnapshotGlobalMetaData
MetaData getSnapshotGlobalMetaData(SnapshotId snapshotId)
Returns global metadata associated with the snapshot.- Parameters:
snapshotId
- the snapshot id to load the global metadata from- Returns:
- the global metadata about the snapshot
-
getSnapshotIndexMetaData
IndexMetaData getSnapshotIndexMetaData(SnapshotId snapshotId, IndexId index) throws java.io.IOException
Returns the index metadata associated with the snapshot.- Parameters:
snapshotId
- the snapshot id to load the index metadata fromindex
- theIndexId
to load the metadata from- Returns:
- the index metadata about the given index for the given snapshot
- Throws:
java.io.IOException
-
getRepositoryData
RepositoryData getRepositoryData()
Returns aRepositoryData
to describe the data in the repository, including the snapshots and the indices across all snapshots found in the repository. Throws aRepositoryException
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 idindices
- list of indices to be snapshottedmetaData
- 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 processThis method is called on master after all shards are snapshotted.
- Parameters:
snapshotId
- snapshot idindices
- list of indices in the snapshotstartTime
- start time of the snapshotfailure
- global failure reason or nulltotalShards
- total number of shardsshardFailures
- list of shard failuresrepositoryStateId
- the unique id identifying the state of the repository when the snapshot beganincludeGlobalState
- include cluster global state- Returns:
- snapshot description
-
deleteSnapshot
void deleteSnapshot(SnapshotId snapshotId, long repositoryStateId)
Deletes snapshot- Parameters:
snapshotId
- snapshot idrepositoryStateId
- 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 bystartVerification()
command
-
verify
void verify(java.lang.String verificationToken, DiscoveryNode localNode)
Verifies repository settings on data node.- Parameters:
verificationToken
- value returned bystartVerification()
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 checkIndexShardSnapshotStatus.isAborted()
to see if the snapshot process should be aborted.- Parameters:
shard
- shard to be snapshottedsnapshotId
- snapshot idindexId
- id for the index being snapshottedsnapshotIndexCommit
- commit pointsnapshotStatus
- 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
andsnapshotShardId
are supplied.- Parameters:
shard
- the shard to restore the index intosnapshotId
- snapshot idversion
- version of elasticsearch that created this snapshotindexId
- id of the index in the repository from which the restore is occurringsnapshotShardId
- 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 idversion
- version of elasticsearch that created this snapshotindexId
- the snapshotted index id for the shard to get status forshardId
- shard id- Returns:
- snapshot status
-
-