org.elasticsearch.indices

Class IndicesService

java.lang.Object

org.elasticsearch.common.component.AbstractComponent

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

org.elasticsearch.indices.IndicesService

All Implemented Interfaces:

AutoCloseable, Iterable<IndexService>, LifecycleComponent<IndicesService>, Releasable

public class IndicesService
extends AbstractLifecycleComponent<IndicesService>
implements Iterable<IndexService>

Field Summary

Fields

Modifier and Type	Field and Description
static String	INDICES_SHARDS_CLOSED_TIMEOUT

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
IndicesService(Settings settings, IndicesLifecycle indicesLifecycle, IndicesAnalysisService indicesAnalysisService, Injector injector, NodeEnvironment nodeEnv)

Method Summary

Modifier and Type	Method and Description
void	addPendingDelete(Index index, Settings settings) Adds a pending delete for the given index.
void	addPendingDelete(ShardId shardId, Settings settings) Adds a pending delete for the given index shard.
boolean	canDeleteIndexContents(Index index, Settings indexSettings) This method returns true if the current node is allowed to delete the given index.
boolean	canDeleteShardContent(ShardId shardId, IndexMetaData metaData) Returns true iff the shards content for the given shard can be deleted.
boolean	changesAllowed() Returns true if changes (adding / removing) indices, shards and so on are allowed.
IndexService	createIndex(String sIndexName, Settings settings, String localNodeId)
void	deleteClosedIndex(String reason, IndexMetaData metaData, ClusterState clusterState)
void	deleteIndex(String index, String reason) Deletes the given index.
void	deleteIndexStore(String reason, IndexMetaData metaData, ClusterState clusterState) Deletes the index store trying to acquire all shards locks for this index.
void	deleteShardStore(String reason, ShardId shardId, ClusterState clusterState) This method deletes the shard contents on disk for the given shard ID.
void	deleteShardStore(String reason, ShardLock lock, Settings indexSettings) Deletes the shard with an already acquired shard lock.
protected void	doClose()
protected void	doStart()
protected void	doStop()
boolean	hasIndex(String index)
IndexService	indexService(String index) Returns an IndexService for the specified index if exists otherwise returns null.
IndexService	indexServiceSafe(String index) Returns an IndexService for the specified index if exists otherwise a IndexMissingException is thrown.
IndicesLifecycle	indicesLifecycle()
Iterator<IndexService>	iterator()
void	processPendingDeletes(Index index, Settings indexSettings, TimeValue timeout) Processes all pending deletes for the given index.
void	removeIndex(String index, String reason) Removes the given index from this service and releases all associated resources.
NodeIndicesStats	stats(boolean includePrevious) Returns the node stats indices stats.
NodeIndicesStats	stats(boolean includePrevious, CommonStatsFlags flags)

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 java.lang.Iterable

forEach, spliterator

Field Detail

INDICES_SHARDS_CLOSED_TIMEOUT

public static final String INDICES_SHARDS_CLOSED_TIMEOUT

See Also:

Constant Field Values

Constructor Detail

IndicesService

@Inject
public IndicesService(Settings settings,
                              IndicesLifecycle indicesLifecycle,
                              IndicesAnalysisService indicesAnalysisService,
                              Injector injector,
                              NodeEnvironment nodeEnv)

Method Detail

doStart

protected void doStart()
                throws ElasticsearchException

Specified by:

doStart in class AbstractLifecycleComponent<IndicesService>

Throws:

ElasticsearchException

doStop

protected void doStop()
               throws ElasticsearchException

Specified by:

doStop in class AbstractLifecycleComponent<IndicesService>

Throws:

ElasticsearchException

doClose

protected void doClose()
                throws ElasticsearchException

Specified by:

doClose in class AbstractLifecycleComponent<IndicesService>

Throws:

ElasticsearchException

indicesLifecycle

public IndicesLifecycle indicesLifecycle()

stats

public NodeIndicesStats stats(boolean includePrevious)

Returns the node stats indices stats. The includePrevious flag controls if old shards stats will be aggregated as well (only for relevant stats, such as refresh and indexing, not for docs/store).

stats

public NodeIndicesStats stats(boolean includePrevious,
                              CommonStatsFlags flags)

changesAllowed

public boolean changesAllowed()

Returns true if changes (adding / removing) indices, shards and so on are allowed.

iterator

public Iterator<IndexService> iterator()

Specified by:

iterator in interface Iterable<IndexService>

hasIndex

public boolean hasIndex(String index)

indexService

@Nullable
public IndexService indexService(String index)

Returns an IndexService for the specified index if exists otherwise returns null.

indexServiceSafe

public IndexService indexServiceSafe(String index)
                              throws IndexMissingException

Returns an IndexService for the specified index if exists otherwise a IndexMissingException is thrown.

Throws:

IndexMissingException

createIndex

public IndexService createIndex(String sIndexName,
                                @IndexSettings
                                Settings settings,
                                String localNodeId)
                         throws ElasticsearchException

Throws:

ElasticsearchException

removeIndex

public void removeIndex(String index,
                        String reason)
                 throws ElasticsearchException

Removes the given index from this service and releases all associated resources. Persistent parts of the index like the shards files, state and transaction logs are kept around in the case of a disaster recovery.

Parameters:

index - the index to remove

reason - the high level reason causing this removal

Throws:

ElasticsearchException

deleteIndex

public void deleteIndex(String index,
                        String reason)
                 throws IOException

Deletes the given index. Persistent parts of the index like the shards files, state and transaction logs are removed once all resources are released. Equivalent to removeIndex(String, String) but fires different lifecycle events to ensure pending resources of this index are immediately removed.

Parameters:

index - the index to delete

reason - the high level reason causing this delete

Throws:

IOException

deleteClosedIndex

public void deleteClosedIndex(String reason,
                              IndexMetaData metaData,
                              ClusterState clusterState)

deleteIndexStore

public void deleteIndexStore(String reason,
                             IndexMetaData metaData,
                             ClusterState clusterState)
                      throws IOException

Deletes the index store trying to acquire all shards locks for this index. This method will delete the metadata for the index even if the actual shards can't be locked.

Throws:

IOException

deleteShardStore

public void deleteShardStore(String reason,
                             ShardLock lock,
                             Settings indexSettings)
                      throws IOException

Deletes the shard with an already acquired shard lock.

Parameters:

reason - the reason for the shard deletion

lock - the lock of the shard to delete

indexSettings - the shards index settings.

Throws:

IOException - if an IOException occurs

deleteShardStore

public void deleteShardStore(String reason,
                             ShardId shardId,
                             ClusterState clusterState)
                      throws IOException

This method deletes the shard contents on disk for the given shard ID. This method will fail if the shard deleting is prevented by canDeleteShardContent(org.elasticsearch.index.shard.ShardId, org.elasticsearch.cluster.metadata.IndexMetaData) of if the shards lock can not be acquired. On data nodes, if the deleted shard is the last shard folder in its index, the method will attempt to remove the index folder as well.

Parameters:

reason - the reason for the shard deletion

shardId - the shards ID to delete

clusterState - . This is required to access the indexes settings etc.

Throws:

IOException - if an IOException occurs

canDeleteIndexContents

public boolean canDeleteIndexContents(Index index,
                                      Settings indexSettings)

This method returns true if the current node is allowed to delete the given index. If the index uses a shared filesystem this method always returns false.

Parameters:

index - Index to check whether deletion is allowed

indexSettings - Settings for the given index

Returns:

true if the index can be deleted on this node

canDeleteShardContent

public boolean canDeleteShardContent(ShardId shardId,
                                     IndexMetaData metaData)

Returns true iff the shards content for the given shard can be deleted. This method will return false if:

• if the shard is still allocated / active on this node
• if for instance if the shard is located on shared and should not be deleted
• if the shards data locations do not exists

Parameters:

shardId - the shard to delete.

metaData - the shards index metadata. This is required to access the indexes settings etc.

addPendingDelete

public void addPendingDelete(ShardId shardId,
                             @IndexSettings
                             Settings settings)

Adds a pending delete for the given index shard.

addPendingDelete

public void addPendingDelete(Index index,
                             @IndexSettings
                             Settings settings)

Adds a pending delete for the given index.

processPendingDeletes

public void processPendingDeletes(Index index,
                                  @IndexSettings
                                  Settings indexSettings,
                                  TimeValue timeout)
                           throws IOException

Processes all pending deletes for the given index. This method will acquire all locks for the given index and will process all pending deletes for this index. Pending deletes might occur if the OS doesn't allow deletion of files because they are used by a different process ie. on Windows where files might still be open by a virus scanner. On a shared filesystem a replica might not have been closed when the primary is deleted causing problems on delete calls so we schedule there deletes later.

Parameters:

index - the index to process the pending deletes for

timeout - the timeout used for processing pending deletes

Throws:

IOException