Package org.opensearch.indices

Class IndicesService

java.lang.Object

org.opensearch.common.lifecycle.AbstractLifecycleComponent

org.opensearch.indices.IndicesService

All Implemented Interfaces:

Closeable, AutoCloseable, Iterable<IndexService>, org.opensearch.common.lease.Releasable, org.opensearch.common.lifecycle.LifecycleComponent, IndexService.ShardStoreDeleter, IndicesClusterStateService.AllocatedIndices<IndexShard,IndexService>

@PublicApi(since="1.0.0")
public class IndicesService
extends org.opensearch.common.lifecycle.AbstractLifecycleComponent
implements IndicesClusterStateService.AllocatedIndices<IndexShard,IndexService>, IndexService.ShardStoreDeleter

Main OpenSearch indices service

Opensearch.api:

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	IndicesService.IndexShardCacheEntity	An item in the index shard cache
static enum	IndicesService.ShardDeletionCheckResult	result type returned by signaling different reasons why a shard can / cannot be deleted

Nested classes/interfaces inherited from interface org.opensearch.indices.cluster.IndicesClusterStateService.AllocatedIndices

IndicesClusterStateService.AllocatedIndices.IndexRemovalReason

Field Summary

Fields

Modifier and Type	Field	Description
static final Setting<org.opensearch.common.unit.TimeValue>	CLUSTER_DEFAULT_INDEX_REFRESH_INTERVAL_SETTING	This setting is used to set the refresh interval when the index.refresh_interval index setting is not provided during index creation or when the existing index.refresh_interval index setting is set as null.
static final Setting<Boolean>	CLUSTER_INDEX_RESTRICT_REPLICATION_TYPE_SETTING	If enabled, this setting enforces that indexes will be created with a replication type matching the cluster setting defined in cluster.indices.replication.strategy by rejecting any request that specifies a replication type that does not match the cluster setting.
static final Setting<org.opensearch.common.unit.TimeValue>	CLUSTER_MINIMUM_INDEX_REFRESH_INTERVAL_SETTING	This setting is used to set the minimum refresh interval applicable for all indexes in a cluster.
static final Setting<Boolean>	CLUSTER_REMOTE_INDEX_RESTRICT_ASYNC_DURABILITY_SETTING	This setting is used to restrict creation or updation of index where the `index.translog.durability` index setting is set as ASYNC if enabled.
static final Setting<ReplicationType>	CLUSTER_REPLICATION_TYPE_SETTING
static final String	CLUSTER_SETTING_REPLICATION_TYPE	Used to specify SEGMENT replication type as the default replication strategy for all indices in a cluster.
static final Setting<org.opensearch.common.unit.TimeValue>	INDICES_CACHE_CLEAN_INTERVAL_SETTING
static final String	INDICES_CACHE_CLEANUP_INTERVAL_SETTING_KEY
static final Setting<Boolean>	INDICES_ID_FIELD_DATA_ENABLED_SETTING
static final String	INDICES_SHARDS_CLOSED_TIMEOUT
static final Setting<Boolean>	WRITE_DANGLING_INDICES_INFO_SETTING

Fields inherited from class org.opensearch.common.lifecycle.AbstractLifecycleComponent

lifecycle

Constructor Summary

Constructors

Constructor	Description
IndicesService(Settings settings, PluginsService pluginsService, NodeEnvironment nodeEnv, org.opensearch.core.xcontent.NamedXContentRegistry xContentRegistry, AnalysisRegistry analysisRegistry, IndexNameExpressionResolver indexNameExpressionResolver, MapperRegistry mapperRegistry, org.opensearch.core.common.io.stream.NamedWriteableRegistry namedWriteableRegistry, ThreadPool threadPool, IndexScopedSettings indexScopedSettings, org.opensearch.core.indices.breaker.CircuitBreakerService circuitBreakerService, BigArrays bigArrays, ScriptService scriptService, ClusterService clusterService, Client client, MetaStateService metaStateService, Collection<Function<IndexSettings,Optional<EngineFactory>>> engineFactoryProviders, Map<String,IndexStorePlugin.DirectoryFactory> directoryFactories, ValuesSourceRegistry valuesSourceRegistry, Map<String,IndexStorePlugin.RecoveryStateFactory> recoveryStateFactories, IndexStorePlugin.DirectoryFactory remoteDirectoryFactory, Supplier<RepositoriesService> repositoriesServiceSupplier, SearchRequestStats searchRequestStats, RemoteStoreStatsTrackerFactory remoteStoreStatsTrackerFactory, RecoverySettings recoverySettings, CacheService cacheService, RemoteStoreSettings remoteStoreSettings)
IndicesService(Settings settings, PluginsService pluginsService, NodeEnvironment nodeEnv, org.opensearch.core.xcontent.NamedXContentRegistry xContentRegistry, AnalysisRegistry analysisRegistry, IndexNameExpressionResolver indexNameExpressionResolver, MapperRegistry mapperRegistry, org.opensearch.core.common.io.stream.NamedWriteableRegistry namedWriteableRegistry, ThreadPool threadPool, IndexScopedSettings indexScopedSettings, org.opensearch.core.indices.breaker.CircuitBreakerService circuitBreakerService, BigArrays bigArrays, ScriptService scriptService, ClusterService clusterService, Client client, MetaStateService metaStateService, Collection<Function<IndexSettings,Optional<EngineFactory>>> engineFactoryProviders, Map<String,IndexStorePlugin.DirectoryFactory> directoryFactories, ValuesSourceRegistry valuesSourceRegistry, Map<String,IndexStorePlugin.RecoveryStateFactory> recoveryStateFactories, IndexStorePlugin.DirectoryFactory remoteDirectoryFactory, Supplier<RepositoriesService> repositoriesServiceSupplier, SearchRequestStats searchRequestStats, RemoteStoreStatsTrackerFactory remoteStoreStatsTrackerFactory, RecoverySettings recoverySettings, CacheService cacheService, RemoteStoreSettings remoteStoreSettings, FileCache fileCache)
IndicesService(Settings settings, PluginsService pluginsService, NodeEnvironment nodeEnv, org.opensearch.core.xcontent.NamedXContentRegistry xContentRegistry, AnalysisRegistry analysisRegistry, IndexNameExpressionResolver indexNameExpressionResolver, MapperRegistry mapperRegistry, org.opensearch.core.common.io.stream.NamedWriteableRegistry namedWriteableRegistry, ThreadPool threadPool, IndexScopedSettings indexScopedSettings, org.opensearch.core.indices.breaker.CircuitBreakerService circuitBreakerService, BigArrays bigArrays, ScriptService scriptService, ClusterService clusterService, Client client, MetaStateService metaStateService, Collection<Function<IndexSettings,Optional<EngineFactory>>> engineFactoryProviders, Map<String,IndexStorePlugin.DirectoryFactory> directoryFactories, ValuesSourceRegistry valuesSourceRegistry, Map<String,IndexStorePlugin.RecoveryStateFactory> recoveryStateFactories, IndexStorePlugin.DirectoryFactory remoteDirectoryFactory, Supplier<RepositoriesService> repositoriesServiceSupplier, SearchRequestStats searchRequestStats, RemoteStoreStatsTrackerFactory remoteStoreStatsTrackerFactory, RecoverySettings recoverySettings, CacheService cacheService, RemoteStoreSettings remoteStoreSettings, FileCache fileCache, CompositeIndexSettings compositeIndexSettings, Consumer<IndexShard> replicator)

Method Summary

Modifier and Type	Method	Description
void	addDocStatusStats(IndexingStats.Stats.DocStatusStats stats)	Accumulate stats from the passed Object
void	addPendingDelete(org.opensearch.core.index.Index index, IndexSettings settings)	Adds a pending delete for the given index.
void	addPendingDelete(org.opensearch.core.index.shard.ShardId shardId, IndexSettings settings)	Adds a pending delete for the given index shard.
boolean	allPendingDanglingIndicesWritten()
boolean	awaitClose(long timeout, TimeUnit timeUnit)	Wait for this IndicesService to be effectively closed.
AliasFilter	buildAliasFilter(ClusterState state, String index, Set<String> resolvedExpressions)
boolean	canCache(ShardSearchRequest request, SearchContext context)	Can the shard request be cached at all?
boolean	canDeleteIndexContents(org.opensearch.core.index.Index index, IndexSettings indexSettings)	This method returns true if the current node is allowed to delete the given index.
IndicesService.ShardDeletionCheckResult	canDeleteShardContent(org.opensearch.core.index.shard.ShardId shardId, IndexSettings indexSettings)	Returns ShardDeletionCheckResult signaling whether the shards content for the given shard can be deleted.
void	clearIndexShardCache(org.opensearch.core.index.shard.ShardId shardId, boolean queryCache, boolean fieldDataCache, boolean requestCache, String... fields)	Clears the caches for the given shard id if the shard is still allocated on this node
ClusterService	clusterService()
IndexService	createIndex(IndexMetadata indexMetadata, List<IndexEventListener> builtInListeners, boolean writeDanglingIndices)	Creates a new IndexService for the given metadata.
MapperService	createIndexMapperService(IndexMetadata indexMetadata)	creates a new mapper service for the given index, in order to do administrative work like mapping updates.
IndexShard	createShard(ShardRouting shardRouting, SegmentReplicationCheckpointPublisher checkpointPublisher, PeerRecoveryTargetService recoveryTargetService, RecoveryListener recoveryListener, RepositoriesService repositoriesService, Consumer<IndexShard.ShardFailure> onShardFailure, Consumer<org.opensearch.core.index.shard.ShardId> globalCheckpointSyncer, RetentionLeaseSyncer retentionLeaseSyncer, DiscoveryNode targetNode, DiscoveryNode sourceNode, RemoteStoreStatsTrackerFactory remoteStoreStatsTrackerFactory, DiscoveryNodes discoveryNodes)	Creates a shard for the specified shard routing and starts recovery.
void	deleteShardStore(String reason, org.opensearch.core.index.shard.ShardId shardId, ClusterState clusterState)	This method deletes the shard contents on disk for the given shard ID.
void	deleteShardStore(String reason, ShardLock lock, IndexSettings indexSettings)	Deletes the shard with an already acquired shard lock.
void	deleteUnassignedIndex(String reason, IndexMetadata metadata, ClusterState clusterState)	Deletes an index that is not assigned to this node.
protected void	doClose()
protected void	doStart()
protected void	doStop()
AnalysisRegistry	getAnalysis()
org.opensearch.core.indices.breaker.CircuitBreakerService	getCircuitBreakerService()
CompositeIndexSettings	getCompositeIndexSettings()
Function<String,Predicate<String>>	getFieldFilter()	Returns a function which given an index name, returns a predicate which fields must match in order to be returned by get mappings, get index, get field mappings and field capabilities API.
IndicesFieldDataCache	getIndicesFieldDataCache()
IndicesQueryCache	getIndicesQueryCache()
RemoteStoreSettings	getRemoteStoreSettings()
QueryRewriteContext	getRewriteContext(LongSupplier nowInMillis)	Returns a new QueryRewriteContext with the given now provider
org.opensearch.core.common.unit.ByteSizeValue	getTotalIndexingBufferBytes()
QueryRewriteContext	getValidationRewriteContext(LongSupplier nowInMillis)	Returns a new QueryRewriteContext for query validation with the given now provider
boolean	hasIndex(org.opensearch.core.index.Index index)
boolean	hasUncompletedPendingDeletes()	Checks if all pending deletes have completed.
IndexService	indexService(org.opensearch.core.index.Index index)	Returns an IndexService for the specified index if exists otherwise returns null.
IndexService	indexServiceSafe(org.opensearch.core.index.Index index)	Returns an IndexService for the specified index if exists otherwise a IndexNotFoundException is thrown.
boolean	isIdFieldDataEnabled()	Returns true if fielddata is enabled for the IdFieldMapper field, false otherwise.
boolean	isMetadataField(org.opensearch.Version indexCreatedVersion, String field)	Returns true if the provided field is a registered metadata field (including ones registered via plugins), false otherwise.
Iterator<IndexService>	iterator()
void	loadIntoContext(ShardSearchRequest request, SearchContext context, QueryPhase queryPhase)	Loads the cache result, computing it if needed by executing the query phase and otherwise deserializing the cached value into the context's query result.
void	processPendingDeletes(org.opensearch.core.index.Index index, IndexSettings indexSettings, org.opensearch.common.unit.TimeValue timeout)	Processes all pending deletes for the given index.
void	removeIndex(org.opensearch.core.index.Index index, IndicesClusterStateService.AllocatedIndices.IndexRemovalReason reason, String extraInfo)	Removes the given index from this service and releases all associated resources.
NodeIndicesStats	stats(CommonStatsFlags flags)
IndexMetadata	verifyIndexIsDeleted(org.opensearch.core.index.Index index, ClusterState clusterState)	Verify that the contents on disk for the given index is deleted; if not, delete the contents.
void	verifyIndexMetadata(IndexMetadata metadata, IndexMetadata metadataUpdate)	This method verifies that the given metadata holds sane values to create an IndexService.
<T, E extends Exception> T	withTempIndexService(IndexMetadata indexMetadata, org.opensearch.common.CheckedFunction<IndexService,T,E> indexServiceConsumer)

Methods inherited from class org.opensearch.common.lifecycle.AbstractLifecycleComponent

addLifecycleListener, close, lifecycleState, removeLifecycleListener, start, stop

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.indices.cluster.IndicesClusterStateService.AllocatedIndices

getShardOrNull

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Details

INDICES_CACHE_CLEANUP_INTERVAL_SETTING_KEY

public static final String INDICES_CACHE_CLEANUP_INTERVAL_SETTING_KEY

See Also:

• Constant Field Values

INDICES_SHARDS_CLOSED_TIMEOUT

public static final String INDICES_SHARDS_CLOSED_TIMEOUT

See Also:

• Constant Field Values

INDICES_CACHE_CLEAN_INTERVAL_SETTING

public static final Setting<org.opensearch.common.unit.TimeValue> INDICES_CACHE_CLEAN_INTERVAL_SETTING

INDICES_ID_FIELD_DATA_ENABLED_SETTING

public static final Setting<Boolean> INDICES_ID_FIELD_DATA_ENABLED_SETTING

WRITE_DANGLING_INDICES_INFO_SETTING

public static final Setting<Boolean> WRITE_DANGLING_INDICES_INFO_SETTING

CLUSTER_SETTING_REPLICATION_TYPE

public static final String CLUSTER_SETTING_REPLICATION_TYPE

Used to specify SEGMENT replication type as the default replication strategy for all indices in a cluster. By default, this is false.

See Also:

• Constant Field Values

CLUSTER_REPLICATION_TYPE_SETTING

public static final Setting<ReplicationType> CLUSTER_REPLICATION_TYPE_SETTING

CLUSTER_DEFAULT_INDEX_REFRESH_INTERVAL_SETTING

public static final Setting<org.opensearch.common.unit.TimeValue> CLUSTER_DEFAULT_INDEX_REFRESH_INTERVAL_SETTING

This setting is used to set the refresh interval when the index.refresh_interval index setting is not provided during index creation or when the existing index.refresh_interval index setting is set as null. This comes handy when the user wants to set a default refresh interval across all indexes created in a cluster which is different from 1s and also at the same time have searchIdle feature supported. The setting can only be as low as the cluster.minimum.index.refresh_interval.

CLUSTER_MINIMUM_INDEX_REFRESH_INTERVAL_SETTING

public static final Setting<org.opensearch.common.unit.TimeValue> CLUSTER_MINIMUM_INDEX_REFRESH_INTERVAL_SETTING

This setting is used to set the minimum refresh interval applicable for all indexes in a cluster. The cluster.default.index.refresh_interval setting value needs to be higher than this setting's value. Index creation will fail if the index setting index.refresh_interval is supplied with a value lower than the cluster minimum refresh interval.

CLUSTER_REMOTE_INDEX_RESTRICT_ASYNC_DURABILITY_SETTING

public static final Setting<Boolean> CLUSTER_REMOTE_INDEX_RESTRICT_ASYNC_DURABILITY_SETTING

This setting is used to restrict creation or updation of index where the `index.translog.durability` index setting is set as ASYNC if enabled. If disabled, any of the durability mode can be used and switched at any later time from one to another.

CLUSTER_INDEX_RESTRICT_REPLICATION_TYPE_SETTING

public static final Setting<Boolean> CLUSTER_INDEX_RESTRICT_REPLICATION_TYPE_SETTING

If enabled, this setting enforces that indexes will be created with a replication type matching the cluster setting defined in cluster.indices.replication.strategy by rejecting any request that specifies a replication type that does not match the cluster setting. If disabled, a user can choose a replication type on a per-index basis using the index.replication.type setting.

Constructor Details

IndicesService

public IndicesService(Settings settings,
 PluginsService pluginsService,
 NodeEnvironment nodeEnv,
 org.opensearch.core.xcontent.NamedXContentRegistry xContentRegistry,
 AnalysisRegistry analysisRegistry,
 IndexNameExpressionResolver indexNameExpressionResolver,
 MapperRegistry mapperRegistry,
 org.opensearch.core.common.io.stream.NamedWriteableRegistry namedWriteableRegistry,
 ThreadPool threadPool,
 IndexScopedSettings indexScopedSettings,
 org.opensearch.core.indices.breaker.CircuitBreakerService circuitBreakerService,
 BigArrays bigArrays,
 ScriptService scriptService,
 ClusterService clusterService,
 Client client,
 MetaStateService metaStateService,
 Collection<Function<IndexSettings,Optional<EngineFactory>>> engineFactoryProviders,
 Map<String,IndexStorePlugin.DirectoryFactory> directoryFactories,
 ValuesSourceRegistry valuesSourceRegistry,
 Map<String,IndexStorePlugin.RecoveryStateFactory> recoveryStateFactories,
 IndexStorePlugin.DirectoryFactory remoteDirectoryFactory,
 Supplier<RepositoriesService> repositoriesServiceSupplier,
 SearchRequestStats searchRequestStats,
 @Nullable
 RemoteStoreStatsTrackerFactory remoteStoreStatsTrackerFactory,
 RecoverySettings recoverySettings,
 CacheService cacheService,
 RemoteStoreSettings remoteStoreSettings,
 FileCache fileCache,
 CompositeIndexSettings compositeIndexSettings,
 Consumer<IndexShard> replicator)

IndicesService

public IndicesService(Settings settings,
 PluginsService pluginsService,
 NodeEnvironment nodeEnv,
 org.opensearch.core.xcontent.NamedXContentRegistry xContentRegistry,
 AnalysisRegistry analysisRegistry,
 IndexNameExpressionResolver indexNameExpressionResolver,
 MapperRegistry mapperRegistry,
 org.opensearch.core.common.io.stream.NamedWriteableRegistry namedWriteableRegistry,
 ThreadPool threadPool,
 IndexScopedSettings indexScopedSettings,
 org.opensearch.core.indices.breaker.CircuitBreakerService circuitBreakerService,
 BigArrays bigArrays,
 ScriptService scriptService,
 ClusterService clusterService,
 Client client,
 MetaStateService metaStateService,
 Collection<Function<IndexSettings,Optional<EngineFactory>>> engineFactoryProviders,
 Map<String,IndexStorePlugin.DirectoryFactory> directoryFactories,
 ValuesSourceRegistry valuesSourceRegistry,
 Map<String,IndexStorePlugin.RecoveryStateFactory> recoveryStateFactories,
 IndexStorePlugin.DirectoryFactory remoteDirectoryFactory,
 Supplier<RepositoriesService> repositoriesServiceSupplier,
 SearchRequestStats searchRequestStats,
 @Nullable
 RemoteStoreStatsTrackerFactory remoteStoreStatsTrackerFactory,
 RecoverySettings recoverySettings,
 CacheService cacheService,
 RemoteStoreSettings remoteStoreSettings,
 FileCache fileCache)

IndicesService

public IndicesService(Settings settings,
 PluginsService pluginsService,
 NodeEnvironment nodeEnv,
 org.opensearch.core.xcontent.NamedXContentRegistry xContentRegistry,
 AnalysisRegistry analysisRegistry,
 IndexNameExpressionResolver indexNameExpressionResolver,
 MapperRegistry mapperRegistry,
 org.opensearch.core.common.io.stream.NamedWriteableRegistry namedWriteableRegistry,
 ThreadPool threadPool,
 IndexScopedSettings indexScopedSettings,
 org.opensearch.core.indices.breaker.CircuitBreakerService circuitBreakerService,
 BigArrays bigArrays,
 ScriptService scriptService,
 ClusterService clusterService,
 Client client,
 MetaStateService metaStateService,
 Collection<Function<IndexSettings,Optional<EngineFactory>>> engineFactoryProviders,
 Map<String,IndexStorePlugin.DirectoryFactory> directoryFactories,
 ValuesSourceRegistry valuesSourceRegistry,
 Map<String,IndexStorePlugin.RecoveryStateFactory> recoveryStateFactories,
 IndexStorePlugin.DirectoryFactory remoteDirectoryFactory,
 Supplier<RepositoriesService> repositoriesServiceSupplier,
 SearchRequestStats searchRequestStats,
 @Nullable
 RemoteStoreStatsTrackerFactory remoteStoreStatsTrackerFactory,
 RecoverySettings recoverySettings,
 CacheService cacheService,
 RemoteStoreSettings remoteStoreSettings)

Method Details

doStart

protected void doStart()

Specified by:

doStart in class org.opensearch.common.lifecycle.AbstractLifecycleComponent

clusterService

public ClusterService clusterService()

doStop

protected void doStop()

Specified by:

doStop in class org.opensearch.common.lifecycle.AbstractLifecycleComponent

doClose

protected void doClose()
                throws IOException

Specified by:

doClose in class org.opensearch.common.lifecycle.AbstractLifecycleComponent

Throws:

IOException

awaitClose

public boolean awaitClose(long timeout,
 TimeUnit timeUnit)
                   throws InterruptedException

Wait for this IndicesService to be effectively closed. When this returns true, all shards and shard stores are closed and all shard closed listeners have run. However some shard closed listeners might not have run.

Returns:

true if all shards closed within the given timeout, false otherwise

Throws:

InterruptedException - if the current thread got interrupted while waiting for shards to close

stats

public NodeIndicesStats stats(CommonStatsFlags flags)

iterator

public Iterator<IndexService> iterator()

Specified by:

iterator in interface Iterable<IndexService>

hasIndex

public boolean hasIndex(org.opensearch.core.index.Index index)

indexService

@Nullable
public IndexService indexService(org.opensearch.core.index.Index index)

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

Specified by:

indexService in interface IndicesClusterStateService.AllocatedIndices<IndexShard,IndexService>

indexServiceSafe

public IndexService indexServiceSafe(org.opensearch.core.index.Index index)

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

createIndex

public IndexService createIndex(IndexMetadata indexMetadata,
 List<IndexEventListener> builtInListeners,
 boolean writeDanglingIndices)
                         throws IOException

Creates a new IndexService for the given metadata.

Specified by:

createIndex in interface IndicesClusterStateService.AllocatedIndices<IndexShard,IndexService>

Parameters:

indexMetadata - the index metadata to create the index for

builtInListeners - a list of built-in lifecycle IndexEventListener that should should be used along side with the per-index listeners

writeDanglingIndices - whether dangling indices information should be written

Throws:

ResourceAlreadyExistsException - if the index already exists.

IOException

withTempIndexService

public <T,
E extends Exception> T withTempIndexService(IndexMetadata indexMetadata,
 org.opensearch.common.CheckedFunction<IndexService,T,E> indexServiceConsumer)
                                                throws IOException,
E

Throws:

IOException

E

createIndexMapperService

public MapperService createIndexMapperService(IndexMetadata indexMetadata)
                                       throws IOException

creates a new mapper service for the given index, in order to do administrative work like mapping updates. This *should not* be used for document parsing. Doing so will result in an exception.

Note: the returned MapperService should be closed when unneeded.

Throws:

IOException

verifyIndexMetadata

public void verifyIndexMetadata(IndexMetadata metadata,
 IndexMetadata metadataUpdate)
                         throws IOException

This method verifies that the given metadata holds sane values to create an IndexService. This method tries to update the meta data of the created IndexService if the given metadataUpdate is different from the given metadata. This method will throw an exception if the creation or the update fails. The created IndexService will not be registered and will be closed immediately.

Throws:

IOException

createShard

public IndexShard createShard(ShardRouting shardRouting,
 SegmentReplicationCheckpointPublisher checkpointPublisher,
 PeerRecoveryTargetService recoveryTargetService,
 RecoveryListener recoveryListener,
 RepositoriesService repositoriesService,
 Consumer<IndexShard.ShardFailure> onShardFailure,
 Consumer<org.opensearch.core.index.shard.ShardId> globalCheckpointSyncer,
 RetentionLeaseSyncer retentionLeaseSyncer,
 DiscoveryNode targetNode,
 DiscoveryNode sourceNode,
 RemoteStoreStatsTrackerFactory remoteStoreStatsTrackerFactory,
 DiscoveryNodes discoveryNodes)
                       throws IOException

Description copied from interface: IndicesClusterStateService.AllocatedIndices

Creates a shard for the specified shard routing and starts recovery.

Specified by:

createShard in interface IndicesClusterStateService.AllocatedIndices<IndexShard,IndexService>

Parameters:

shardRouting - the shard routing

recoveryTargetService - recovery service for the target

recoveryListener - a callback when recovery changes state (finishes or fails)

repositoriesService - service responsible for snapshot/restore

onShardFailure - a callback when this shard fails

globalCheckpointSyncer - a callback when this shard syncs the global checkpoint

retentionLeaseSyncer - a callback when this shard syncs retention leases

targetNode - the node where this shard will be recovered

sourceNode - the source node to recover this shard from (it might be null)

remoteStoreStatsTrackerFactory - factory for remote store stats trackers

Returns:

a new shard

Throws:

IOException - if an I/O exception occurs when creating the shard

removeIndex

public void removeIndex(org.opensearch.core.index.Index index,
 IndicesClusterStateService.AllocatedIndices.IndexRemovalReason reason,
 String extraInfo)

Description copied from interface: IndicesClusterStateService.AllocatedIndices

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.

Specified by:

removeIndex in interface IndicesClusterStateService.AllocatedIndices<IndexShard,IndexService>

Parameters:

index - the index to remove

reason - the reason to remove the index

extraInfo - extra information that will be used for logging and reporting

getIndicesFieldDataCache

public IndicesFieldDataCache getIndicesFieldDataCache()

getCircuitBreakerService

public org.opensearch.core.indices.breaker.CircuitBreakerService getCircuitBreakerService()

getIndicesQueryCache

public IndicesQueryCache getIndicesQueryCache()

addDocStatusStats

public void addDocStatusStats(IndexingStats.Stats.DocStatusStats stats)

Accumulate stats from the passed Object

Parameters:

stats - Instance storing IndexingStats.Stats.DocStatusStats

deleteUnassignedIndex

public void deleteUnassignedIndex(String reason,
 IndexMetadata metadata,
 ClusterState clusterState)

Deletes an index that is not assigned to this node. This method cleans up all disk folders relating to the index but does not deal with in-memory structures. For those call removeIndex(Index, IndexRemovalReason, String)

Specified by:

deleteUnassignedIndex in interface IndicesClusterStateService.AllocatedIndices<IndexShard,IndexService>

deleteShardStore

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

Deletes the shard with an already acquired shard lock.

Specified by:

deleteShardStore in interface IndexService.ShardStoreDeleter

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,
 org.opensearch.core.index.shard.ShardId shardId,
 ClusterState clusterState)
                      throws IOException,
ShardLockObtainFailedException

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(ShardId, IndexSettings) 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

ShardLockObtainFailedException

canDeleteIndexContents

public boolean canDeleteIndexContents(org.opensearch.core.index.Index index,
 IndexSettings indexSettings)

This method returns true if the current node is allowed to delete the given index. This is the case if the index is deleted in the metadata or there is no allocation on the local node and the index isn't on a shared file system.

Parameters:

index - Index to check whether deletion is allowed

indexSettings - IndexSettings for the given index

Returns:

true if the index can be deleted on this node

verifyIndexIsDeleted

@Nullable
public IndexMetadata verifyIndexIsDeleted(org.opensearch.core.index.Index index,
 ClusterState clusterState)

Verify that the contents on disk for the given index is deleted; if not, delete the contents. This method assumes that an index is already deleted in the cluster state and/or explicitly through index tombstones.

Specified by:

verifyIndexIsDeleted in interface IndicesClusterStateService.AllocatedIndices<IndexShard,IndexService>

Parameters:

index - Index to make sure its deleted from disk

clusterState - ClusterState to ensure the index is not part of it

Returns:

IndexMetadata for the index loaded from disk

canDeleteShardContent

public IndicesService.ShardDeletionCheckResult canDeleteShardContent(org.opensearch.core.index.shard.ShardId shardId,
 IndexSettings indexSettings)

Returns ShardDeletionCheckResult signaling whether the shards content for the given shard can be deleted.

Parameters:

shardId - the shard to delete.

indexSettings - the shards's relevant IndexSettings. This is required to access the indexes settings etc.

addPendingDelete

public void addPendingDelete(org.opensearch.core.index.shard.ShardId shardId,
 IndexSettings settings)

Adds a pending delete for the given index shard.

Specified by:

addPendingDelete in interface IndexService.ShardStoreDeleter

addPendingDelete

public void addPendingDelete(org.opensearch.core.index.Index index,
 IndexSettings settings)

Adds a pending delete for the given index.

processPendingDeletes

public void processPendingDeletes(org.opensearch.core.index.Index index,
 IndexSettings indexSettings,
 org.opensearch.common.unit.TimeValue timeout)
                           throws IOException,
InterruptedException,
ShardLockObtainFailedException

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.

Specified by:

processPendingDeletes in interface IndicesClusterStateService.AllocatedIndices<IndexShard,IndexService>

Parameters:

index - the index to process the pending deletes for

timeout - the timeout used for processing pending deletes

Throws:

IOException

InterruptedException

ShardLockObtainFailedException

hasUncompletedPendingDeletes

public boolean hasUncompletedPendingDeletes()

Checks if all pending deletes have completed. Used by tests to ensure we don't check directory contents while deletion still ongoing. * The reason is that, on Windows, browsing the directory contents can interfere with the deletion process and delay it unnecessarily.

getAnalysis

public AnalysisRegistry getAnalysis()

canCache

public boolean canCache(ShardSearchRequest request,
 SearchContext context)

Can the shard request be cached at all?

loadIntoContext

public void loadIntoContext(ShardSearchRequest request,
 SearchContext context,
 QueryPhase queryPhase)
                     throws Exception

Loads the cache result, computing it if needed by executing the query phase and otherwise deserializing the cached value into the context's query result. The combination of load + compute allows to have a single load operation that will cause other requests with the same key to wait till its loaded an reuse the same cache.

Throws:

Exception

getTotalIndexingBufferBytes

public org.opensearch.core.common.unit.ByteSizeValue getTotalIndexingBufferBytes()

buildAliasFilter

public AliasFilter buildAliasFilter(ClusterState state,
 String index,
 Set<String> resolvedExpressions)

getRewriteContext

public QueryRewriteContext getRewriteContext(LongSupplier nowInMillis)

Returns a new QueryRewriteContext with the given now provider

getValidationRewriteContext

public QueryRewriteContext getValidationRewriteContext(LongSupplier nowInMillis)

Returns a new QueryRewriteContext for query validation with the given now provider

clearIndexShardCache

public void clearIndexShardCache(org.opensearch.core.index.shard.ShardId shardId,
 boolean queryCache,
 boolean fieldDataCache,
 boolean requestCache,
 String... fields)

Clears the caches for the given shard id if the shard is still allocated on this node

getFieldFilter

public Function<String,Predicate<String>> getFieldFilter()

Returns a function which given an index name, returns a predicate which fields must match in order to be returned by get mappings, get index, get field mappings and field capabilities API. Useful to filter the fields that such API return. The predicate receives the field name as input argument. In case multiple plugins register a field filter through MapperPlugin.getFieldFilter(), only fields that match all the registered filters will be returned by get mappings, get index, get field mappings and field capabilities API.

isMetadataField

public boolean isMetadataField(org.opensearch.Version indexCreatedVersion,
 String field)

Returns true if the provided field is a registered metadata field (including ones registered via plugins), false otherwise.

isIdFieldDataEnabled

public boolean isIdFieldDataEnabled()

Returns true if fielddata is enabled for the IdFieldMapper field, false otherwise.

allPendingDanglingIndicesWritten

public boolean allPendingDanglingIndicesWritten()

getRemoteStoreSettings

public RemoteStoreSettings getRemoteStoreSettings()

getCompositeIndexSettings

public CompositeIndexSettings getCompositeIndexSettings()