Interface | Description |
---|---|
Snapshot |
Represent information about snapshot
|
SnapshotsService.CreateSnapshotListener |
Listener for create snapshot operation
|
SnapshotsService.DeleteSnapshotListener |
Listener for delete snapshot operation
|
SnapshotsService.SnapshotCompletionListener |
Class | Description |
---|---|
RestoreInfo |
Information about successfully completed restore operation.
|
RestoreService |
Service responsible for restoring snapshots
Restore operation is performed in several stages.
|
RestoreService.RestoreCompletionResponse | |
RestoreService.RestoreRequest |
Restore snapshot request
|
SnapshotInfo |
Information about snapshot
|
SnapshotShardFailure |
Stores information about failures that occurred during shard snapshotting process
|
SnapshotsService |
Service responsible for creating snapshots
A typical snapshot creating process looks like this:
On the master node the
SnapshotsService.createSnapshot(SnapshotRequest, CreateSnapshotListener) is called and makes sure that no snapshots is currently running
and registers the new snapshot in cluster state
When cluster state is updated the SnapshotsService.beginSnapshot(ClusterState, SnapshotMetaData.Entry, boolean, CreateSnapshotListener) method
kicks in and initializes the snapshot in the repository and then populates list of shards that needs to be snapshotted in cluster state
Each data node is watching for these shards and when new shards scheduled for snapshotting appear in the cluster state, data nodes
start processing them through SnapshotsService.processIndexShardSnapshots(SnapshotMetaData) method
Once shard snapshot is created data node updates state of the shard in the cluster state using the SnapshotsService.updateIndexShardSnapshotStatus(UpdateIndexShardSnapshotStatusRequest) method
When last shard is completed master node in SnapshotsService.innerUpdateSnapshotState(org.elasticsearch.snapshots.SnapshotsService.UpdateIndexShardSnapshotStatusRequest) method marks the snapshot as completed
After cluster state is updated, the SnapshotsService.endSnapshot(SnapshotMetaData.Entry) finalizes snapshot in the repository,
notifies all SnapshotsService.snapshotCompletionListeners that snapshot is completed, and finally calls SnapshotsService.removeSnapshotFromClusterState(SnapshotId, SnapshotInfo, Throwable) to remove snapshot from cluster state
|
SnapshotsService.SnapshotRequest |
Snapshot creation request
|
SnapshotUtils |
Snapshot utilities
|
Enum | Description |
---|---|
SnapshotState |
Represents the state that a snapshot can be in
|
Exception | Description |
---|---|
ConcurrentSnapshotExecutionException |
Thrown when a user tries to start multiple snapshots at the same time
|
InvalidSnapshotNameException |
Thrown on the attempt to create a snapshot with invalid name
|
SnapshotCreationException |
Thrown when snapshot creation fails completely
|
SnapshotException |
Generic snapshot exception
|
SnapshotMissingException |
Thrown if requested snapshot doesn't exist
|
SnapshotRestoreException |
Snapshot restore exception
|
Copyright © 2009–2015. All rights reserved.