org.elasticsearch.index.store.fs
Class FsIndexStore

java.lang.Object
  org.elasticsearch.index.AbstractIndexComponent
      org.elasticsearch.index.store.support.AbstractIndexStore
          org.elasticsearch.index.store.fs.FsIndexStore

All Implemented Interfaces:

CloseableIndexComponent, IndexComponent, IndexStore

Direct Known Subclasses:

MmapFsIndexStore, NioFsIndexStore, SimpleFsIndexStore

public abstract class FsIndexStore
extends AbstractIndexStore

Field Summary

Fields inherited from class org.elasticsearch.index.store.support.AbstractIndexStore

indexService, indicesStore

Fields inherited from class org.elasticsearch.index.AbstractIndexComponent

componentSettings, index, indexSettings, logger

Constructor Summary

FsIndexStore(Index index, Settings indexSettings, IndexService indexService, IndicesStore indicesStore, NodeEnvironment nodeEnv)

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.
boolean	persistent() Is the store a persistent store that can survive full restarts.
File[]	shardIndexLocations(ShardId shardId)
File[]	shardLocations(ShardId shardId)
File[]	shardTranslogLocations(ShardId shardId)

Methods inherited from class org.elasticsearch.index.store.support.AbstractIndexStore

close, indicesStore, rateLimiting

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

shardDirectory

Constructor Detail

FsIndexStore

public FsIndexStore(Index index,
                    @IndexSettings
                    Settings indexSettings,
                    IndexService indexService,
                    IndicesStore indicesStore,
                    NodeEnvironment nodeEnv)

Method Detail

persistent

public boolean persistent()

Description copied from interface: IndexStore

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

backingStoreTotalSpace

public ByteSizeValue backingStoreTotalSpace()

Description copied from interface: IndexStore

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

backingStoreFreeSpace

public ByteSizeValue backingStoreFreeSpace()

Description copied from interface: IndexStore

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

canDeleteUnallocated

public boolean canDeleteUnallocated(ShardId shardId)

Description copied from interface: IndexStore

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

Specified by:

canDeleteUnallocated in interface IndexStore

Overrides:

canDeleteUnallocated in class AbstractIndexStore

deleteUnallocated

public void deleteUnallocated(ShardId shardId)
                       throws IOException

Description copied from interface: IndexStore

Deletes this shard store since its no longer allocated.

Specified by:

deleteUnallocated in interface IndexStore

Overrides:

deleteUnallocated in class AbstractIndexStore

Throws:

IOException

shardLocations

public File[] shardLocations(ShardId shardId)

shardIndexLocations

public File[] shardIndexLocations(ShardId shardId)

shardTranslogLocations

public File[] shardTranslogLocations(ShardId shardId)