org.elasticsearch.index.store.support

Class AbstractIndexStore

java.lang.Object

org.elasticsearch.index.AbstractIndexComponent

org.elasticsearch.index.store.support.AbstractIndexStore

All Implemented Interfaces:

Closeable, AutoCloseable, CloseableIndexComponent, IndexComponent, IndexStore

Direct Known Subclasses:

FsIndexStore, RamIndexStore

public abstract class AbstractIndexStore
extends AbstractIndexComponent
implements IndexStore

Field Summary

Fields

Modifier and Type	Field and Description
static String	INDEX_FOLDER_NAME
static String	INDEX_STORE_THROTTLE_MAX_BYTES_PER_SEC
static String	INDEX_STORE_THROTTLE_TYPE
protected IndexService	indexService
protected IndicesStore	indicesStore
static String	TRANSLOG_FOLDER_NAME

Fields inherited from class org.elasticsearch.index.AbstractIndexComponent

componentSettings, index, indexSettings, logger

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractIndexStore(Index index, Settings indexSettings, IndexService indexService, IndicesStore indicesStore, NodeEnvironment nodeEnv)

Method Summary

Modifier and Type	Method and Description
void	close() Closes the index component.
IndicesStore	indicesStore()
StoreRateLimiting	rateLimiting() Returns the rate limiting, either of the index is explicitly configured, or the node level one (defaults to the node level one).
Path[]	shardIndexLocations(ShardId shardId) Return an array of all index folder locations for a given shard.
Path[]	shardTranslogLocations(ShardId shardId) Return an array of all translog folder locations for a given shard.

Methods inherited from class org.elasticsearch.index.AbstractIndexComponent

index, 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.index.store.IndexStore

persistent, shardDirectory

Field Detail

INDEX_STORE_THROTTLE_TYPE

public static final String INDEX_STORE_THROTTLE_TYPE

See Also:

Constant Field Values

INDEX_STORE_THROTTLE_MAX_BYTES_PER_SEC

public static final String INDEX_STORE_THROTTLE_MAX_BYTES_PER_SEC

See Also:

Constant Field Values

INDEX_FOLDER_NAME

public static final String INDEX_FOLDER_NAME

See Also:

Constant Field Values

TRANSLOG_FOLDER_NAME

public static final String TRANSLOG_FOLDER_NAME

See Also:

Constant Field Values

indexService

protected final IndexService indexService

indicesStore

protected final IndicesStore indicesStore

Constructor Detail

AbstractIndexStore

protected AbstractIndexStore(Index index,
                             @IndexSettings
                             Settings indexSettings,
                             IndexService indexService,
                             IndicesStore indicesStore,
                             NodeEnvironment nodeEnv)

Method Detail

indicesStore

public IndicesStore indicesStore()

Specified by:

indicesStore in interface IndexStore

close

public void close()
           throws ElasticsearchException

Description copied from interface: CloseableIndexComponent

Closes the index component. A boolean indicating if its part of an actual index deletion or not is passed.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface CloseableIndexComponent

Throws:

ElasticsearchException

rateLimiting

public StoreRateLimiting rateLimiting()

Description copied from interface: IndexStore

Returns the rate limiting, either of the index is explicitly configured, or the node level one (defaults to the node level one).

Specified by:

rateLimiting in interface IndexStore

shardIndexLocations

public Path[] shardIndexLocations(ShardId shardId)

Return an array of all index folder locations for a given shard. Uses the index settings to determine if a custom data path is set for the index and uses that if applicable.

Specified by:

shardIndexLocations in interface IndexStore

shardTranslogLocations

public Path[] shardTranslogLocations(ShardId shardId)

Return an array of all translog folder locations for a given shard. Uses the index settings to determine if a custom data path is set for the index and uses that if applicable.

Specified by:

shardTranslogLocations in interface IndexStore