org.elasticsearch.env

Class NodeEnvironment

java.lang.Object

org.elasticsearch.common.component.AbstractComponent

org.elasticsearch.env.NodeEnvironment

All Implemented Interfaces:

Closeable, AutoCloseable

public class NodeEnvironment
extends AbstractComponent
implements Closeable

A component that holds all data paths for a single node.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NodeEnvironment.NodePath

Field Summary

Fields

Modifier and Type	Field and Description
static String	ADD_NODE_ID_TO_CUSTOM_PATH
static String	INDICES_FOLDER
static String	NODE_LOCK_FILENAME
static String	NODES_FOLDER
static String	SETTING_ENABLE_LUCENE_SEGMENT_INFOS_TRACE

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

deprecationLogger, logger, settings

Constructor Summary

Constructors

Constructor and Description
NodeEnvironment(Settings settings, Environment environment)

Method Summary

Methods

Modifier and Type	Method and Description
static void	acquireFSLockForPaths(Settings indexSettings, Path... shardPaths) Acquires, then releases, all write.lock files in the given shard paths.
Path[]	availableShardPaths(ShardId shardId) Returns all shard paths excluding custom shard path.
void	close()
void	deleteIndexDirectorySafe(Index index, long lockTimeoutMS, Settings indexSettings) Deletes an indexes data directory recursively iff all of the indexes shards locks were successfully acquired.
void	deleteIndexDirectoryUnderLock(Index index, Settings indexSettings) Deletes an indexes data directory recursively.
void	deleteShardDirectorySafe(ShardId shardId, Settings indexSettings) Deletes a shard data directory iff the shards locks were successfully acquired.
void	deleteShardDirectoryUnderLock(ShardLock lock, Settings indexSettings) Deletes a shard data directory.
void	ensureAtomicMoveSupported() This method tries to write an empty file and moves it using an atomic move operation.
Set<String>	findAllIndices()
Set<ShardId>	findAllShardIds(Index index) Tries to find all allocated shards for the given index on the current node.
static boolean	hasCustomDataPath(Settings indexSettings)
boolean	hasNodeFile()
Path[]	indexPaths(Index index) Returns all index paths.
int	localNodeId()
List<ShardLock>	lockAllForIndex(Index index, Settings settings, long lockTimeoutMS) Tries to lock all local shards for the given index.
Set<ShardId>	lockedShards() Returns all currently lock shards
Path[]	nodeDataPaths() Returns an array of all of the nodes data locations.
NodeEnvironment.NodePath[]	nodePaths() Returns an array of all of the NodeEnvironment.NodePaths.
Path	resolveCustomLocation(Settings indexSettings, ShardId shardId) Resolve the custom path for a index's shard.
ShardLock	shardLock(ShardId id) Tries to lock the given shards ID.
ShardLock	shardLock(ShardId id, long lockTimeoutMS) Tries to lock the given shards ID.
static Path	shardStatePathToDataPath(Path shardPath) Returns the NodePath.path for this shard.

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

logDeprecatedSetting, logRemovedSetting, nodeName

Methods inherited from class java.lang.Object

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

Field Detail

ADD_NODE_ID_TO_CUSTOM_PATH

public static final String ADD_NODE_ID_TO_CUSTOM_PATH

See Also:

Constant Field Values

SETTING_ENABLE_LUCENE_SEGMENT_INFOS_TRACE

public static final String SETTING_ENABLE_LUCENE_SEGMENT_INFOS_TRACE

See Also:

Constant Field Values

NODES_FOLDER

public static final String NODES_FOLDER

See Also:

Constant Field Values

INDICES_FOLDER

public static final String INDICES_FOLDER

See Also:

Constant Field Values

NODE_LOCK_FILENAME

public static final String NODE_LOCK_FILENAME

See Also:

Constant Field Values

Constructor Detail

NodeEnvironment

@Inject
public NodeEnvironment(Settings settings,
                      Environment environment)
                throws IOException

Throws:

IOException

Method Detail

deleteShardDirectorySafe

public void deleteShardDirectorySafe(ShardId shardId,
                            Settings indexSettings)
                              throws IOException

Deletes a shard data directory iff the shards locks were successfully acquired.

Parameters:

shardId - the id of the shard to delete to delete

Throws:

IOException - if an IOException occurs

acquireFSLockForPaths

public static void acquireFSLockForPaths(Settings indexSettings,
                         Path... shardPaths)
                                  throws IOException

Acquires, then releases, all write.lock files in the given shard paths. The "write.lock" file is assumed to be under the shard path's "index" directory as used by Elasticsearch.

Throws:

org.apache.lucene.store.LockObtainFailedException - if any of the locks could not be acquired

IOException

deleteShardDirectoryUnderLock

public void deleteShardDirectoryUnderLock(ShardLock lock,
                                 Settings indexSettings)
                                   throws IOException

Deletes a shard data directory. Note: this method assumes that the shard lock is acquired. This method will also attempt to acquire the write locks for the shard's paths before deleting the data, but this is best effort, as the lock is released before the deletion happens in order to allow the folder to be deleted

Parameters:

lock - the shards lock

Throws:

IOException - if an IOException occurs

ElasticsearchException - if the write.lock is not acquirable

deleteIndexDirectorySafe

public void deleteIndexDirectorySafe(Index index,
                            long lockTimeoutMS,
                            Settings indexSettings)
                              throws IOException

Deletes an indexes data directory recursively iff all of the indexes shards locks were successfully acquired. If any of the indexes shard directories can't be locked non of the shards will be deleted

Parameters:

index - the index to delete

lockTimeoutMS - how long to wait for acquiring the indices shard locks

indexSettings - settings for the index being deleted

Throws:

IOException - if any of the shards data directories can't be locked or deleted

deleteIndexDirectoryUnderLock

public void deleteIndexDirectoryUnderLock(Index index,
                                 Settings indexSettings)
                                   throws IOException

Deletes an indexes data directory recursively. Note: this method assumes that the shard lock is acquired

Parameters:

index - the index to delete

indexSettings - settings for the index being deleted

Throws:

IOException

lockAllForIndex

public List<ShardLock> lockAllForIndex(Index index,
                              Settings settings,
                              long lockTimeoutMS)
                                throws IOException

Tries to lock all local shards for the given index. If any of the shard locks can't be acquired an LockObtainFailedException is thrown and all previously acquired locks are released.

Parameters:

index - the index to lock shards for

lockTimeoutMS - how long to wait for acquiring the indices shard locks

Returns:

the ShardLock instances for this index.

Throws:

IOException - if an IOException occurs.

shardLock

public ShardLock shardLock(ShardId id)
                    throws IOException

Tries to lock the given shards ID. A shard lock is required to perform any kind of write operation on a shards data directory like deleting files, creating a new index writer or recover from a different shard instance into it. If the shard lock can not be acquired an LockObtainFailedException is thrown. Note: this method will return immediately if the lock can't be acquired.

Parameters:

id - the shard ID to lock

Returns:

the shard lock. Call ShardLock.close() to release the lock

Throws:

IOException - if an IOException occurs.

shardLock

public ShardLock shardLock(ShardId id,
                  long lockTimeoutMS)
                    throws IOException

Tries to lock the given shards ID. A shard lock is required to perform any kind of write operation on a shards data directory like deleting files, creating a new index writer or recover from a different shard instance into it. If the shard lock can not be acquired an LockObtainFailedException is thrown

Parameters:

id - the shard ID to lock

lockTimeoutMS - the lock timeout in milliseconds

Returns:

the shard lock. Call ShardLock.close() to release the lock

Throws:

IOException - if an IOException occurs.

lockedShards

public Set<ShardId> lockedShards()

Returns all currently lock shards

localNodeId

public int localNodeId()

hasNodeFile

public boolean hasNodeFile()

nodeDataPaths

public Path[] nodeDataPaths()

Returns an array of all of the nodes data locations.

Throws:

IllegalStateException - if the node is not configured to store local locations

nodePaths

public NodeEnvironment.NodePath[] nodePaths()

Returns an array of all of the NodeEnvironment.NodePaths.

indexPaths

public Path[] indexPaths(Index index)

Returns all index paths.

availableShardPaths

public Path[] availableShardPaths(ShardId shardId)

Returns all shard paths excluding custom shard path. Note: Shards are only allocated on one of the returned paths. The returned array may contain paths to non-existing directories.

See Also:

hasCustomDataPath(org.elasticsearch.common.settings.Settings), resolveCustomLocation(org.elasticsearch.common.settings.Settings, org.elasticsearch.index.shard.ShardId)

findAllIndices

public Set<String> findAllIndices()
                           throws IOException

Throws:

IOException

findAllShardIds

public Set<ShardId> findAllShardIds(Index index)
                             throws IOException

Tries to find all allocated shards for the given index on the current node. NOTE: This methods is prone to race-conditions on the filesystem layer since it might not see directories created concurrently or while it's traversing.

Parameters:

index - the index to filter shards

Returns:

a set of shard IDs

Throws:

IOException - if an IOException occurs

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

ensureAtomicMoveSupported

public void ensureAtomicMoveSupported()
                               throws IOException

This method tries to write an empty file and moves it using an atomic move operation. This method throws an IllegalStateException if this operation is not supported by the filesystem. This test is executed on each of the data directories. This method cleans up all files even in the case of an error.

Throws:

IOException

hasCustomDataPath

public static boolean hasCustomDataPath(Settings indexSettings)

Parameters:

indexSettings - settings for an index

Returns:

true if the index has a custom data path

resolveCustomLocation

public Path resolveCustomLocation(Settings indexSettings,
                         ShardId shardId)

Resolve the custom path for a index's shard. Uses the IndexMetaData.SETTING_DATA_PATH setting to determine the root path for the index.

Parameters:

indexSettings - settings for the index

shardId - shard to resolve the path to

shardStatePathToDataPath

public static Path shardStatePathToDataPath(Path shardPath)

Returns the NodePath.path for this shard.