org.elasticsearch.index.snapshots.blobstore

クラス BlobStoreIndexShardRepository

java.lang.Object

org.elasticsearch.common.component.AbstractComponent

org.elasticsearch.index.snapshots.blobstore.BlobStoreIndexShardRepository

すべての実装されたインタフェース:

IndexShardRepository

直系の既知のサブクラス:

URLIndexShardRepository

public class BlobStoreIndexShardRepository
extends AbstractComponent
implements IndexShardRepository

Blob store based implementation of IndexShardRepository

ネストされたクラスのサマリー

ネストされたクラス

修飾子とタイプ	クラスと説明
static interface	BlobStoreIndexShardRepository.RateLimiterListener

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
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

クラスから継承されたフィールド org.elasticsearch.common.component.AbstractComponent

deprecationLogger, logger, settings

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
BlobStoreIndexShardRepository(Settings settings, RepositoryName repositoryName, IndicesService indicesService, ClusterService clusterService)

メソッドのサマリー

修飾子とタイプ	メソッドと説明
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

クラスから継承されたメソッド org.elasticsearch.common.component.AbstractComponent

logDeprecatedSetting, logRemovedSetting, nodeName

クラスから継承されたメソッド java.lang.Object

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

フィールドの詳細

LEGACY_SNAPSHOT_PREFIX

protected static final String LEGACY_SNAPSHOT_PREFIX

関連項目:

定数フィールド値

LEGACY_SNAPSHOT_NAME_FORMAT

protected static final String LEGACY_SNAPSHOT_NAME_FORMAT

関連項目:

定数フィールド値

SNAPSHOT_PREFIX

protected static final String SNAPSHOT_PREFIX

関連項目:

定数フィールド値

SNAPSHOT_NAME_FORMAT

protected static final String SNAPSHOT_NAME_FORMAT

関連項目:

定数フィールド値

SNAPSHOT_CODEC

protected static final String SNAPSHOT_CODEC

関連項目:

定数フィールド値

SNAPSHOT_INDEX_PREFIX

protected static final String SNAPSHOT_INDEX_PREFIX

関連項目:

定数フィールド値

SNAPSHOT_INDEX_NAME_FORMAT

protected static final String SNAPSHOT_INDEX_NAME_FORMAT

関連項目:

定数フィールド値

SNAPSHOT_INDEX_CODEC

protected static final String SNAPSHOT_INDEX_CODEC

関連項目:

定数フィールド値

DATA_BLOB_PREFIX

protected static final String DATA_BLOB_PREFIX

関連項目:

定数フィールド値

コンストラクタの詳細

BlobStoreIndexShardRepository

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

メソッドの詳細

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

パラメータ:

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.

定義:

snapshot インタフェース内 IndexShardRepository

パラメータ:

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.

定義:

restore インタフェース内 IndexShardRepository

パラメータ:

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

定義:

snapshotStatus インタフェース内 IndexShardRepository

パラメータ:

snapshotId - snapshot id

version - version of elasticsearch that created this snapshot

shardId - shard id

戻り値:

snapshot status

verify

public void verify(String seed)

インタフェースからコピーされた説明: IndexShardRepository

Verifies repository settings on data node

定義:

verify インタフェース内 IndexShardRepository

パラメータ:

seed - value returned by Repository.startVerification()

delete

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

Delete shard snapshot

パラメータ:

snapshotId - snapshot id

shardId - shard id

toString

public String toString()

オーバーライド:

toString クラス内 Object

isCompress

protected boolean isCompress()

Returns true if metadata files should be compressed

戻り値:

true if compression is needed