org.elasticsearch.repositories.fs

Class FsRepository

java.lang.Object

org.elasticsearch.common.component.AbstractComponent

org.elasticsearch.common.component.AbstractLifecycleComponent<Repository>

org.elasticsearch.repositories.blobstore.BlobStoreRepository

org.elasticsearch.repositories.fs.FsRepository

All Implemented Interfaces:

AutoCloseable, LifecycleComponent<Repository>, Releasable, BlobStoreIndexShardRepository.RateLimiterListener, Repository

public class FsRepository
extends BlobStoreRepository

Shared file system implementation of the BlobStoreRepository

Shared file system repository supports the following settings

location

Path to the root of repository. This is mandatory parameter.

concurrent_streams

Number of concurrent read/write stream (per repository on each node). Defaults to 5.

chunk_size

Large file can be divided into chunks. This parameter specifies the chunk size. Defaults to not chucked.

compress

If set to true metadata files will be stored compressed. Defaults to false.

Field Summary

Fields

Modifier and Type	Field and Description
static String	TYPE

Fields inherited from class org.elasticsearch.repositories.blobstore.BlobStoreRepository

repositoryName

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

lifecycle

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

componentSettings, logger, settings

Constructor Summary

Constructors

Constructor and Description
FsRepository(RepositoryName name, RepositorySettings repositorySettings, IndexShardRepository indexShardRepository, Environment environment) Constructs new shared file system repository

Method Summary

Modifier and Type	Method and Description
protected BlobPath	basePath() Returns base path of the repository
protected BlobStore	blobStore() Returns initialized and ready to use BlobStore This method is first called in the BlobStoreRepository.doStart() method.
protected ByteSizeValue	chunkSize() Returns data file chunk size.
protected boolean	isCompress() Returns true if metadata and snapshot files should be compressed

Methods inherited from class org.elasticsearch.repositories.blobstore.BlobStoreRepository

deleteSnapshot, doClose, doStart, doStop, endVerification, finalizeSnapshot, initializeSnapshot, onRestorePause, onSnapshotPause, readSnapshot, readSnapshotList, readSnapshotMetaData, restoreThrottleTimeInNanos, snapshots, snapshotThrottleTimeInNanos, startVerification, testBlobPrefix, writeSnapshotList

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

addLifecycleListener, close, lifecycleState, removeLifecycleListener, start, stop

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

nodeName

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.common.component.LifecycleComponent

addLifecycleListener, lifecycleState, removeLifecycleListener, start, stop

Methods inherited from interface org.elasticsearch.common.lease.Releasable

close

Field Detail

TYPE

public static final String TYPE

See Also:

Constant Field Values

Constructor Detail

FsRepository

@Inject
public FsRepository(RepositoryName name,
                            RepositorySettings repositorySettings,
                            IndexShardRepository indexShardRepository,
                            Environment environment)
                     throws IOException

Constructs new shared file system repository

Parameters:

name - repository name

repositorySettings - repository settings

indexShardRepository - index shard repository

Throws:

IOException

Method Detail

blobStore

protected BlobStore blobStore()

Returns initialized and ready to use BlobStore

This method is first called in the BlobStoreRepository.doStart() method.

Specified by:

blobStore in class BlobStoreRepository

Returns:

blob store

isCompress

protected boolean isCompress()

Returns true if metadata and snapshot files should be compressed

Overrides:

isCompress in class BlobStoreRepository

Returns:

true if compression is needed

chunkSize

protected ByteSizeValue chunkSize()

Returns data file chunk size.

This method should return null if no chunking is needed.

Overrides:

chunkSize in class BlobStoreRepository

Returns:

chunk size

basePath

protected BlobPath basePath()

Description copied from class: BlobStoreRepository

Returns base path of the repository

Specified by:

basePath in class BlobStoreRepository