BlobStoreRepository (Elasticsearch: Core 2.3.5.1 API)

java.lang.Object
- org.elasticsearch.common.component.AbstractComponent
- - org.elasticsearch.common.component.AbstractLifecycleComponent<Repository>
  - - org.elasticsearch.repositories.blobstore.BlobStoreRepository

すべての実装されたインタフェース:: AutoCloseable, LifecycleComponent<Repository>, Releasable, BlobStoreIndexShardRepository.RateLimiterListener, Repository

直系の既知のサブクラス:: FsRepository, URLRepository

public abstract class BlobStoreRepository
extends AbstractLifecycleComponent<Repository>
implements Repository, BlobStoreIndexShardRepository.RateLimiterListener

BlobStore - based implementation of Snapshot Repository

This repository works with any BlobStore implementation. The blobStore should be initialized in the derived class before doStart() is called.

BlobStoreRepository maintains the following structure in the blob store

 
   STORE_ROOT
   |- index             - list of all snapshot name as JSON array
   |- snapshot-20131010 - JSON serialized Snapshot for snapshot "20131010"
   |- meta-20131010.dat - JSON serialized MetaData for snapshot "20131010" (includes only global metadata)
   |- snapshot-20131011 - JSON serialized Snapshot for snapshot "20131011"
   |- meta-20131011.dat - JSON serialized MetaData for snapshot "20131011"
   .....
   |- indices/ - data for all indices
      |- foo/ - data for index "foo"
      |  |- meta-20131010.dat - JSON Serialized IndexMetaData for index "foo"
      |  |- 0/ - data for shard "0" of index "foo"
      |  |  |- __1 \
      |  |  |- __2 |
      |  |  |- __3 |- files from different segments see snapshot-* for their mappings to real segment files
      |  |  |- __4 |
      |  |  |- __5 /
      |  |  .....
      |  |  |- snap-20131010.dat - JSON serialized BlobStoreIndexShardSnapshot for snapshot "20131010"
      |  |  |- snap-20131011.dat - JSON serialized BlobStoreIndexShardSnapshot for snapshot "20131011"
      |  |  |- list-123 - JSON serialized BlobStoreIndexShardSnapshot for snapshot "20131011"
      |  |
      |  |- 1/ - data for shard "1" of index "foo"
      |  |  |- __1
      |  |  .....
      |  |
      |  |-2/
      |  ......
      |
      |- bar/ - data for index bar
      ......

フィールドのサマリー

フィールド
修飾子とタイプフィールドと説明

protected String repositoryName
- クラスから継承されたフィールド org.elasticsearch.common.component.AbstractLifecycleComponent
  lifecycle
- クラスから継承されたフィールド org.elasticsearch.common.component.AbstractComponent
  deprecationLogger, logger, settings

フィールド
修飾子とタイプ	フィールドと説明
`protected String`	`repositoryName`

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

コンストラクタ
修飾子	コンストラクタと説明
`protected`	`BlobStoreRepository(String repositoryName, RepositorySettings repositorySettings, IndexShardRepository indexShardRepository)` Constructs new BlobStoreRepository

メソッドのサマリー

すべてのメソッド staticメソッドインスタンス・メソッド abstractメソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`protected abstract BlobPath`	`basePath()` Returns base path of the repository
`protected abstract BlobStore`	`blobStore()` Returns initialized and ready to use BlobStore This method is first called in the `doStart()` method.
`protected ByteSizeValue`	`chunkSize()` Returns data file chunk size.
`void`	`deleteSnapshot(SnapshotId snapshotId)` Deletes snapshot
`protected void`	`doClose()`
`protected void`	`doStart()`
`protected void`	`doStop()`
`void`	`endVerification(String seed)` Called at the end of repository verification process.
`Snapshot`	`finalizeSnapshot(SnapshotId snapshotId, List<String> indices, long startTime, String failure, int totalShards, List<SnapshotShardFailure> shardFailures)` Finalizes snapshotting process This method is called on master after all shards are snapshotted.
`void`	`initializeSnapshot(SnapshotId snapshotId, List<String> indices, MetaData metaData)` Starts snapshotting process
`protected boolean`	`isCompress()` Returns true if metadata and snapshot files should be compressed
`static boolean`	`legacyMetaData(Version version)` In v2.0.0 we changed the matadata file format
`void`	`onRestorePause(long nanos)`
`void`	`onSnapshotPause(long nanos)`
`boolean`	`readOnly()` Returns true if the repository supports only read operations
`Snapshot`	`readSnapshot(SnapshotId snapshotId)` Reads snapshot description from repository.
`protected List<SnapshotId>`	`readSnapshotList()` Reads snapshot index file This file can be used by read-only repositories that are unable to list files in the repository
`MetaData`	`readSnapshotMetaData(SnapshotId snapshotId, Snapshot snapshot, List<String> indices)` Returns global metadata associate with the snapshot.
`long`	`restoreThrottleTimeInNanos()` Returns restore throttle time in nanoseconds
`List<SnapshotId>`	`snapshots()` Returns the list of snapshots currently stored in the repository
`long`	`snapshotThrottleTimeInNanos()` Returns snapshot throttle time in nanoseconds
`String`	`startVerification()` Verifies repository on the master node and returns the verification token.
`static String`	`testBlobPrefix(String seed)`
`protected void`	`writeSnapshotList(List<SnapshotId> snapshots)` Writes snapshot index file This file can be used by read-only repositories that are unable to list files in the repository

クラスから継承されたメソッド org.elasticsearch.common.component.AbstractLifecycleComponent
addLifecycleListener, close, lifecycleState, removeLifecycleListener, start, stop

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

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

インタフェースから継承されたメソッド org.elasticsearch.common.component.LifecycleComponent
addLifecycleListener, lifecycleState, removeLifecycleListener, start, stop

インタフェースから継承されたメソッド org.elasticsearch.common.lease.Releasable
close

- フィールドの詳細
  - repositoryName
```
protected final String repositoryName
```
- コンストラクタの詳細
  - BlobStoreRepository
```
protected BlobStoreRepository(String repositoryName,
                              RepositorySettings repositorySettings,
                              IndexShardRepository indexShardRepository)
```
    Constructs new BlobStoreRepository
    
    パラメータ:
    
    repositoryName - repository name
    
    repositorySettings - repository settings
    
    indexShardRepository - an instance of IndexShardRepository
- メソッドの詳細
  - doStart
```
protected void doStart()
```
    定義:
    
    doStart クラス内 AbstractLifecycleComponent<Repository>
  - doStop
```
protected void doStop()
```
    定義:
    
    doStop クラス内 AbstractLifecycleComponent<Repository>
  - doClose
```
protected void doClose()
```
    定義:
    
    doClose クラス内 AbstractLifecycleComponent<Repository>
  - blobStore
```
protected abstract BlobStore blobStore()
```
    Returns initialized and ready to use BlobStore
    This method is first called in the doStart() method.
    
    戻り値:
    
    blob store
  - basePath
```
protected abstract BlobPath basePath()
```
    Returns base path of the repository
  - isCompress
```
protected boolean isCompress()
```
    Returns true if metadata and snapshot files should be compressed
    
    戻り値:
    
    true if compression is needed
  - chunkSize
```
protected ByteSizeValue chunkSize()
```
    Returns data file chunk size.
    This method should return null if no chunking is needed.
    
    戻り値:
    
    chunk size
  - initializeSnapshot
```
public void initializeSnapshot(SnapshotId snapshotId,
                               List<String> indices,
                               MetaData metaData)
```
    Starts snapshotting process
    
    定義:
    
    initializeSnapshot インタフェース内 Repository
    
    パラメータ:
    
    snapshotId - snapshot id
    
    indices - list of indices to be snapshotted
    
    metaData - cluster metadata
  - deleteSnapshot
```
public void deleteSnapshot(SnapshotId snapshotId)
```
    Deletes snapshot
    
    定義:
    
    deleteSnapshot インタフェース内 Repository
    
    パラメータ:
    
    snapshotId - snapshot id
  - finalizeSnapshot
```
public Snapshot finalizeSnapshot(SnapshotId snapshotId,
                                 List<String> indices,
                                 long startTime,
                                 String failure,
                                 int totalShards,
                                 List<SnapshotShardFailure> shardFailures)
```
    Finalizes snapshotting process
    This method is called on master after all shards are snapshotted.
    
    定義:
    
    finalizeSnapshot インタフェース内 Repository
    
    パラメータ:
    
    snapshotId - snapshot id
    
    failure - global failure reason or null
    
    totalShards - total number of shards
    
    shardFailures - list of shard failures
    
    戻り値:
    
    snapshot description
  - snapshots
```
public List<SnapshotId> snapshots()
```
    Returns the list of snapshots currently stored in the repository
    
    定義:
    
    snapshots インタフェース内 Repository
    
    戻り値:
    
    snapshot list
  - readSnapshotMetaData
```
public MetaData readSnapshotMetaData(SnapshotId snapshotId,
                                     Snapshot snapshot,
                                     List<String> indices)
                              throws IOException
```
    Returns global metadata associate with the snapshot.
    The returned meta data contains global metadata as well as metadata for all indices listed in the indices parameter.
    
    定義:
    
    readSnapshotMetaData インタフェース内 Repository
    
    snapshot - snapshot
    
    indices - list of indices
    
    戻り値:
    
    information about snapshot
    
    例外:
    
    IOException
  - readSnapshot
```
public Snapshot readSnapshot(SnapshotId snapshotId)
```
    Reads snapshot description from repository.
    
    定義:
    
    readSnapshot インタフェース内 Repository
    
    パラメータ:
    
    snapshotId - snapshot ID
    
    戻り値:
    
    information about snapshot
  - legacyMetaData
```
public static boolean legacyMetaData(Version version)
```
    In v2.0.0 we changed the matadata file format
    
    戻り値:
    
    true if legacy version should be used false otherwise
  - writeSnapshotList
```
protected void writeSnapshotList(List<SnapshotId> snapshots)
                          throws IOException
```
    Writes snapshot index file
    This file can be used by read-only repositories that are unable to list files in the repository
    
    パラメータ:
    
    snapshots - list of snapshot ids
    
    例外:
    
    IOException - I/O errors
  - readSnapshotList
```
protected List<SnapshotId> readSnapshotList()
                                     throws IOException
```
    Reads snapshot index file
    This file can be used by read-only repositories that are unable to list files in the repository
    
    戻り値:
    
    list of snapshots in the repository
    
    例外:
    
    IOException - I/O errors
  - onRestorePause
```
public void onRestorePause(long nanos)
```
    定義:
    
    onRestorePause インタフェース内 BlobStoreIndexShardRepository.RateLimiterListener
  - onSnapshotPause
```
public void onSnapshotPause(long nanos)
```
    定義:
    
    onSnapshotPause インタフェース内 BlobStoreIndexShardRepository.RateLimiterListener
  - snapshotThrottleTimeInNanos
```
public long snapshotThrottleTimeInNanos()
```
    インタフェースからコピーされた説明: Repository
    
    Returns snapshot throttle time in nanoseconds
    
    定義:
    
    snapshotThrottleTimeInNanos インタフェース内 Repository
  - restoreThrottleTimeInNanos
```
public long restoreThrottleTimeInNanos()
```
    インタフェースからコピーされた説明: Repository
    
    Returns restore throttle time in nanoseconds
    
    定義:
    
    restoreThrottleTimeInNanos インタフェース内 Repository
  - startVerification
```
public String startVerification()
```
    インタフェースからコピーされた説明: Repository
    
    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
    
    定義:
    
    startVerification インタフェース内 Repository
    
    戻り値:
    
    verification token that should be passed to all Index Shard Repositories for additional verification or null
  - endVerification
```
public void endVerification(String seed)
```
    インタフェースからコピーされた説明: Repository
    
    Called at the end of repository verification process.
    This method should perform all necessary cleanup of the temporary files created in the repository
    
    定義:
    
    endVerification インタフェース内 Repository
    
    パラメータ:
    
    seed - verification request generated by Repository.startVerification() command
  - testBlobPrefix
```
public static String testBlobPrefix(String seed)
```
  - readOnly
```
public boolean readOnly()
```
    インタフェースからコピーされた説明: Repository
    
    Returns true if the repository supports only read operations
    
    定義:
    
    readOnly インタフェース内 Repository
    
    戻り値:
    
    true if the repository is read/only

クラス BlobStoreRepository

フィールドのサマリー

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

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

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

メソッドのサマリー

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

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

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

インタフェースから継承されたメソッド org.elasticsearch.common.component.LifecycleComponent

インタフェースから継承されたメソッド org.elasticsearch.common.lease.Releasable

フィールドの詳細

repositoryName

コンストラクタの詳細

BlobStoreRepository

メソッドの詳細

doStart

doStop

doClose

blobStore

basePath

isCompress

chunkSize

initializeSnapshot

deleteSnapshot

finalizeSnapshot

snapshots

readSnapshotMetaData

readSnapshot

legacyMetaData

writeSnapshotList

readSnapshotList

onRestorePause

onSnapshotPause

snapshotThrottleTimeInNanos

restoreThrottleTimeInNanos

startVerification

endVerification

testBlobPrefix

readOnly