org.elasticsearch.index.snapshots.blobstore

Class BlobStoreIndexShardRepository

java.lang.Object

org.elasticsearch.common.component.AbstractComponent

org.elasticsearch.index.snapshots.blobstore.BlobStoreIndexShardRepository

All Implemented Interfaces:

IndexShardRepository

Direct Known Subclasses:

URLIndexShardRepository

public class BlobStoreIndexShardRepository
extends AbstractComponent
implements IndexShardRepository

Blob store based implementation of IndexShardRepository

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	BlobStoreIndexShardRepository.RateLimiterListener

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	DATA_BLOB_PREFIX
protected static String	LEGACY_SNAPSHOT_NAME_FORMAT
protected static String	LEGACY_SNAPSHOT_PREFIX
protected static String	SNAPSHOT_CODEC
protected static String	SNAPSHOT_INDEX_CODEC
protected static String	SNAPSHOT_INDEX_NAME_FORMAT
protected static String	SNAPSHOT_INDEX_PREFIX
protected static String	SNAPSHOT_NAME_FORMAT
protected static String	SNAPSHOT_PREFIX

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

deprecationLogger, logger, settings

Constructor Summary

Constructors

Constructor and Description
BlobStoreIndexShardRepository(Settings settings, RepositoryName repositoryName, IndicesService indicesService, ClusterService clusterService)

Method Summary

Methods

Modifier and Type	Method and Description
void	delete(SnapshotId snapshotId, Version version, ShardId shardId) Delete shard snapshot
void	initialize(BlobStore blobStore, BlobPath basePath, ByteSizeValue chunkSize, org.apache.lucene.store.RateLimiter snapshotRateLimiter, org.apache.lucene.store.RateLimiter restoreRateLimiter, BlobStoreIndexShardRepository.RateLimiterListener rateLimiterListener, boolean compress) Called by BlobStoreRepository on repository startup
protected boolean	isCompress() Returns true if metadata files should be compressed
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
String	toString()
void	verify(String seed) Verifies repository settings on data node

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, wait, wait, wait

Field Detail

LEGACY_SNAPSHOT_PREFIX

protected static final String LEGACY_SNAPSHOT_PREFIX

See Also:

Constant Field Values

LEGACY_SNAPSHOT_NAME_FORMAT

protected static final String LEGACY_SNAPSHOT_NAME_FORMAT

See Also:

Constant Field Values

SNAPSHOT_PREFIX

protected static final String SNAPSHOT_PREFIX

See Also:

Constant Field Values

SNAPSHOT_NAME_FORMAT

protected static final String SNAPSHOT_NAME_FORMAT

See Also:

Constant Field Values

SNAPSHOT_CODEC

protected static final String SNAPSHOT_CODEC

See Also:

Constant Field Values

SNAPSHOT_INDEX_PREFIX

protected static final String SNAPSHOT_INDEX_PREFIX

See Also:

Constant Field Values

SNAPSHOT_INDEX_NAME_FORMAT

protected static final String SNAPSHOT_INDEX_NAME_FORMAT

See Also:

Constant Field Values

SNAPSHOT_INDEX_CODEC

protected static final String SNAPSHOT_INDEX_CODEC

See Also:

Constant Field Values

DATA_BLOB_PREFIX

protected static final String DATA_BLOB_PREFIX

See Also:

Constant Field Values

Constructor Detail

BlobStoreIndexShardRepository

@Inject
public BlobStoreIndexShardRepository(Settings settings,
                                    RepositoryName repositoryName,
                                    IndicesService indicesService,
                                    ClusterService clusterService)

Method Detail

initialize

public void initialize(BlobStore blobStore,
              BlobPath basePath,
              ByteSizeValue chunkSize,
              org.apache.lucene.store.RateLimiter snapshotRateLimiter,
              org.apache.lucene.store.RateLimiter restoreRateLimiter,
              BlobStoreIndexShardRepository.RateLimiterListener rateLimiterListener,
              boolean compress)

Called by BlobStoreRepository on repository startup

Parameters:

blobStore - blob store

basePath - base path to blob store

chunkSize - chunk size

snapshot

public 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.

Specified by:

snapshot in interface IndexShardRepository

Parameters:

snapshotId - snapshot id

shardId - shard to be snapshotted

snapshotIndexCommit - commit point

snapshotStatus - snapshot status

restore

public 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.

Specified by:

restore in interface IndexShardRepository

Parameters:

snapshotId - snapshot id

version - version of elasticsearch that created this snapshot

shardId - shard id (in the current index)

snapshotShardId - shard id (in the snapshot)

recoveryState - recovery state

snapshotStatus

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

Retrieve shard snapshot status for the stored snapshot

Specified by:

snapshotStatus in interface IndexShardRepository

Parameters:

snapshotId - snapshot id

version - version of elasticsearch that created this snapshot

shardId - shard id

Returns:

snapshot status

verify

public void verify(String seed)

Description copied from interface: IndexShardRepository

Verifies repository settings on data node

Specified by:

verify in interface IndexShardRepository

Parameters:

seed - value returned by Repository.startVerification()

delete

public void delete(SnapshotId snapshotId,
          Version version,
          ShardId shardId)

Delete shard snapshot

Parameters:

snapshotId - snapshot id

shardId - shard id

toString

public String toString()

Overrides:

toString in class Object

isCompress

protected boolean isCompress()

Returns true if metadata files should be compressed

Returns:

true if compression is needed