org.elasticsearch.snapshots

Class RestoreService

java.lang.Object

org.elasticsearch.common.component.AbstractComponent

org.elasticsearch.snapshots.RestoreService

All Implemented Interfaces:

ClusterStateApplier

public class RestoreService
extends AbstractComponent
implements ClusterStateApplier

Service responsible for restoring snapshots

Restore operation is performed in several stages.

First restoreSnapshot(RestoreRequest, org.elasticsearch.action.ActionListener) method reads information about snapshot and metadata from repository. In update cluster state task it checks restore preconditions, restores global state if needed, creates RestoreInProgress record with list of shards that needs to be restored and adds this shard to the routing table using RoutingTable.Builder#addAsRestore(IndexMetaData, SnapshotRecoverySource) method.

Individual shards are getting restored as part of normal recovery process in IndexShard.restoreFromRepository(Repository) )} method, which detects that shard should be restored from snapshot rather than recovered from gateway by looking at the ShardRouting.recoverySource() property.

At the end of the successful restore process RestoreService calls cleanupRestoreState(ClusterChangedEvent), which removes RestoreInProgress when all shards are completed. In case of restore failure a normal recovery fail-over process kicks in.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RestoreService.RestoreCompletionResponse
static class	RestoreService.RestoreInProgressUpdater
static class	RestoreService.RestoreRequest Restore snapshot request
static class	RestoreService.UpdateIndexShardRestoreStatusRequest Internal class that is used to send notifications about finished shard restore operations to master node

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	UPDATE_RESTORE_ACTION_NAME
static Version	V_5_1_0_UNRELEASED

Fields inherited from class org.elasticsearch.common.component.AbstractComponent

deprecationLogger, logger, settings

Constructor Summary

Constructors

Constructor and Description
RestoreService(Settings settings, ClusterService clusterService, RepositoriesService repositoriesService, TransportService transportService, AllocationService allocationService, MetaDataCreateIndexService createIndexService, MetaDataIndexUpgradeService metaDataIndexUpgradeService, ClusterSettings clusterSettings)

Method Summary

Modifier and Type	Method and Description
void	applyClusterState(ClusterChangedEvent event) Called when a new cluster state (ClusterChangedEvent.state() needs to be applied
static void	checkIndexClosing(ClusterState currentState, java.util.Set<IndexMetaData> indices) Check if any of the indices to be closed are currently being restored from a snapshot and fail closing if such an index is found as closing an index that is being restored makes the index unusable (it cannot be recovered).
static boolean	completed(ImmutableOpenMap<ShardId,RestoreInProgress.ShardRestoreStatus> shards)
static int	failedShards(ImmutableOpenMap<ShardId,RestoreInProgress.ShardRestoreStatus> shards)
void	failRestore(Snapshot snapshot, ShardId shardId) Fails the given snapshot restore operation for the given shard
void	indexShardRestoreCompleted(Snapshot snapshot, ShardId shardId) This method is used by IndexShard to notify RestoreService about shard restore completion.
static boolean	isRepositoryInUse(ClusterState clusterState, java.lang.String repository) Checks if a repository is currently in use by one of the snapshots
static RestoreInProgress.State	overallState(RestoreInProgress.State nonCompletedState, ImmutableOpenMap<ShardId,RestoreInProgress.ShardRestoreStatus> shards)
static RestoreInProgress.Entry	restoreInProgress(ClusterState state, Snapshot snapshot)
void	restoreSnapshot(RestoreService.RestoreRequest request, ActionListener<RestoreService.RestoreCompletionResponse> listener) Restores snapshot specified in the restore request.
static RestoreInProgress	updateRestoreStateWithDeletedIndices(RestoreInProgress oldRestore, java.util.Set<Index> deletedIndices)

Methods inherited from class org.elasticsearch.common.component.AbstractComponent

logDeprecatedSetting, logRemovedSetting, nodeName

Methods inherited from class java.lang.Object

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

Field Detail

V_5_1_0_UNRELEASED

public static Version V_5_1_0_UNRELEASED

UPDATE_RESTORE_ACTION_NAME

public static final java.lang.String UPDATE_RESTORE_ACTION_NAME

See Also:

Constant Field Values

Constructor Detail

RestoreService

@Inject
public RestoreService(Settings settings,
                              ClusterService clusterService,
                              RepositoriesService repositoriesService,
                              TransportService transportService,
                              AllocationService allocationService,
                              MetaDataCreateIndexService createIndexService,
                              MetaDataIndexUpgradeService metaDataIndexUpgradeService,
                              ClusterSettings clusterSettings)

Method Detail

restoreSnapshot

public void restoreSnapshot(RestoreService.RestoreRequest request,
                            ActionListener<RestoreService.RestoreCompletionResponse> listener)

Restores snapshot specified in the restore request.

Parameters:

request - restore request

listener - restore listener

updateRestoreStateWithDeletedIndices

public static RestoreInProgress updateRestoreStateWithDeletedIndices(RestoreInProgress oldRestore,
                                                                     java.util.Set<Index> deletedIndices)

restoreInProgress

public static RestoreInProgress.Entry restoreInProgress(ClusterState state,
                                                        Snapshot snapshot)

overallState

public static RestoreInProgress.State overallState(RestoreInProgress.State nonCompletedState,
                                                   ImmutableOpenMap<ShardId,RestoreInProgress.ShardRestoreStatus> shards)

completed

public static boolean completed(ImmutableOpenMap<ShardId,RestoreInProgress.ShardRestoreStatus> shards)

failedShards

public static int failedShards(ImmutableOpenMap<ShardId,RestoreInProgress.ShardRestoreStatus> shards)

indexShardRestoreCompleted

public void indexShardRestoreCompleted(Snapshot snapshot,
                                       ShardId shardId)

This method is used by IndexShard to notify RestoreService about shard restore completion.

Parameters:

snapshot - snapshot

shardId - shard id

failRestore

public void failRestore(Snapshot snapshot,
                        ShardId shardId)

Fails the given snapshot restore operation for the given shard

checkIndexClosing

public static void checkIndexClosing(ClusterState currentState,
                                     java.util.Set<IndexMetaData> indices)

Check if any of the indices to be closed are currently being restored from a snapshot and fail closing if such an index is found as closing an index that is being restored makes the index unusable (it cannot be recovered).

applyClusterState

public void applyClusterState(ClusterChangedEvent event)

Description copied from interface: ClusterStateApplier

Called when a new cluster state (ClusterChangedEvent.state() needs to be applied

Specified by:

applyClusterState in interface ClusterStateApplier

isRepositoryInUse

public static boolean isRepositoryInUse(ClusterState clusterState,
                                        java.lang.String repository)

Checks if a repository is currently in use by one of the snapshots

Parameters:

clusterState - cluster state

repository - repository id

Returns:

true if repository is currently in use by one of the running snapshots