org.elasticsearch.index.store
Interface IndexStore

All Superinterfaces:

CloseableIndexComponent

All Known Implementing Classes:

AbstractIndexStore, ByteBufferIndexStore, FsIndexStore, MmapFsIndexStore, NioFsIndexStore, RamIndexStore, SimpleFsIndexStore

public interface IndexStore
extends CloseableIndexComponent

Index store is an index level information of the Store each shard will use.

Method Summary

ByteSizeValue	backingStoreFreeSpace() Returns the backing store free space.
ByteSizeValue	backingStoreTotalSpace() Returns the backing store total space.
boolean	canDeleteUnallocated(ShardId shardId) Returns true if this shard is allocated on this node.
void	deleteUnallocated(ShardId shardId) Deletes this shard store since its no longer allocated.
IndicesStore	indicesStore()
boolean	persistent() Is the store a persistent store that can survive full restarts.
StoreRateLimiting	rateLimiting() Returns the rate limiting, either of the index is explicitly configured, or the node level one (defaults to the node level one).
Class<? extends DirectoryService>	shardDirectory() The shard store class that should be used for each shard.

Methods inherited from interface org.elasticsearch.index.CloseableIndexComponent

close

Method Detail

persistent

boolean persistent()

Is the store a persistent store that can survive full restarts.

indicesStore

IndicesStore indicesStore()

rateLimiting

StoreRateLimiting rateLimiting()

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

shardDirectory

Class<? extends DirectoryService> shardDirectory()

The shard store class that should be used for each shard.

backingStoreTotalSpace

ByteSizeValue backingStoreTotalSpace()

Returns the backing store total space. Return -1 if not available.

backingStoreFreeSpace

ByteSizeValue backingStoreFreeSpace()

Returns the backing store free space. Return -1 if not available.

canDeleteUnallocated

boolean canDeleteUnallocated(ShardId shardId)

Returns true if this shard is allocated on this node. Allocated means that it has storage files that can be deleted using deleteUnallocated(org.elasticsearch.index.shard.ShardId).

deleteUnallocated

void deleteUnallocated(ShardId shardId)
                       throws IOException

Deletes this shard store since its no longer allocated.

Throws:

IOException