Module org.elasticsearch.server

Package org.elasticsearch.index

Class IndexService

java.lang.Object

org.elasticsearch.index.AbstractIndexComponent

org.elasticsearch.index.IndexService

All Implemented Interfaces:

Iterable<IndexShard>, IndicesClusterStateService.AllocatedIndex<IndexShard>

public class IndexService
extends AbstractIndexComponent
implements IndicesClusterStateService.AllocatedIndex<IndexShard>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	IndexService.IndexCreationContext
static interface	IndexService.ShardStoreDeleter

Field Summary

Fields

Modifier and Type	Field	Description
static final Setting<TimeValue>	GLOBAL_CHECKPOINT_SYNC_INTERVAL_SETTING
static final Setting<TimeValue>	RETENTION_LEASE_SYNC_INTERVAL_SETTING

Fields inherited from class org.elasticsearch.index.AbstractIndexComponent

deprecationLogger, logger

Constructor Summary

Constructors

Constructor

Description

IndexService(IndexSettings indexSettings, IndexService.IndexCreationContext indexCreationContext, NodeEnvironment nodeEnv, XContentParserConfiguration parserConfiguration, SimilarityService similarityService, IndexService.ShardStoreDeleter shardStoreDeleter, IndexAnalyzers indexAnalyzers, EngineFactory engineFactory, CircuitBreakerService circuitBreakerService, BigArrays bigArrays, ThreadPool threadPool, ScriptService scriptService, ClusterService clusterService, Client client, QueryCache queryCache, IndexStorePlugin.DirectoryFactory directoryFactory, IndexEventListener eventListener, Function<IndexService,CheckedFunction<org.apache.lucene.index.DirectoryReader,org.apache.lucene.index.DirectoryReader,IOException>> wrapperFactory, MapperRegistry mapperRegistry, IndicesFieldDataCache indicesFieldDataCache, List<SearchOperationListener> searchOperationListeners, List<IndexingOperationListener> indexingOperationListeners, NamedWriteableRegistry namedWriteableRegistry, IdFieldMapper idFieldMapper, BooleanSupplier allowExpensiveQueries, IndexNameExpressionResolver expressionResolver, ValuesSourceRegistry valuesSourceRegistry, IndexStorePlugin.RecoveryStateFactory recoveryStateFactory, IndexStorePlugin.IndexFoldersDeletionListener indexFoldersDeletionListener, IndexStorePlugin.SnapshotCommitSupplier snapshotCommitSupplier, Engine.IndexCommitListener indexCommitListener, Supplier<DocumentParsingObserver> documentParsingObserverSupplier)

Method Summary

Modifier and Type	Method	Description
void	addMetadataListener(Consumer<IndexMetadata> listener)
IndexCache	cache()
boolean	clearCaches(boolean queryCache, boolean fieldDataCache, String... fields)	Clears the caches for the given shard id if the shard is still allocated on this node
void	close(String reason, boolean delete)
RecoveryState	createRecoveryState(ShardRouting shardRouting, DiscoveryNode targetNode, DiscoveryNode sourceNode)
IndexShard	createShard(ShardRouting routing, GlobalCheckpointSyncer globalCheckpointSyncer, RetentionLeaseSyncer retentionLeaseSyncer)
static Function<String,String>	dateMathExpressionResolverAt()
static Function<String,String>	dateMathExpressionResolverAt(long instant)
void	deleteDanglingIndicesInfo()
BigArrays	getBigArrays()	The BigArrays to use for this index.
final EngineFactory	getEngineFactory()
IndexAnalyzers	getIndexAnalyzers()
IndexEventListener	getIndexEventListener()
IndexSettings	getIndexSettings()	Returns the index settings of this index.
Supplier<org.apache.lucene.search.Sort>	getIndexSortSupplier()
IndexMetadata	getMetadata()
NodeMappingStats	getNodeMappingStats()
ScriptService	getScriptService()	The ScriptService to use for this index.
IndexShard	getShard(int shardId)	Return the shard with the provided id, or throw an exception if it doesn't exist.
IndexShard	getShardOrNull(int shardId)	Return the shard with the provided id, or null if there is no such shard.
ThreadPool	getThreadPool()	The ThreadPool to use for this index.
boolean	hasShard(int shardId)
String	indexUUID()
Iterator<IndexShard>	iterator()
MapperService	mapperService()
QueryRewriteContext	newQueryRewriteContext(LongSupplier nowInMillis, Map<String,Object> runtimeMappings, String clusterAlias)	Creates a new QueryRewriteContext.
SearchExecutionContext	newSearchExecutionContext(int shardId, int shardRequestIndex, org.apache.lucene.search.IndexSearcher searcher, LongSupplier nowInMillis, String clusterAlias, Map<String,Object> runtimeMappings)	Creates a new SearchExecutionContext.
int	numberOfShards()
static Map<String,MappedFieldType>	parseRuntimeMappings(Map<String,Object> runtimeMappings, MapperService mapperService, IndexSettings indexSettings, MappingLookup lookup)
void	removeShard(int shardId, String reason)	Removes shard with given id.
Set<Integer>	shardIds()
SimilarityService	similarityService()
void	updateMapping(IndexMetadata currentIndexMetadata, IndexMetadata newIndexMetadata)	Updates the mappings by applying the incoming ones
void	updateMetadata(IndexMetadata currentIndexMetadata, IndexMetadata newIndexMetadata)	Updates the metadata of this index.
void	writeDanglingIndicesInfo()

Methods inherited from class org.elasticsearch.index.AbstractIndexComponent

index

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 Details

GLOBAL_CHECKPOINT_SYNC_INTERVAL_SETTING

public static final Setting<TimeValue> GLOBAL_CHECKPOINT_SYNC_INTERVAL_SETTING

RETENTION_LEASE_SYNC_INTERVAL_SETTING

public static final Setting<TimeValue> RETENTION_LEASE_SYNC_INTERVAL_SETTING

Constructor Details

IndexService

public IndexService(IndexSettings indexSettings,
 IndexService.IndexCreationContext indexCreationContext,
 NodeEnvironment nodeEnv,
 XContentParserConfiguration parserConfiguration,
 SimilarityService similarityService,
 IndexService.ShardStoreDeleter shardStoreDeleter,
 IndexAnalyzers indexAnalyzers,
 EngineFactory engineFactory,
 CircuitBreakerService circuitBreakerService,
 BigArrays bigArrays,
 ThreadPool threadPool,
 ScriptService scriptService,
 ClusterService clusterService,
 Client client,
 QueryCache queryCache,
 IndexStorePlugin.DirectoryFactory directoryFactory,
 IndexEventListener eventListener,
 Function<IndexService,CheckedFunction<org.apache.lucene.index.DirectoryReader,org.apache.lucene.index.DirectoryReader,IOException>> wrapperFactory,
 MapperRegistry mapperRegistry,
 IndicesFieldDataCache indicesFieldDataCache,
 List<SearchOperationListener> searchOperationListeners,
 List<IndexingOperationListener> indexingOperationListeners,
 NamedWriteableRegistry namedWriteableRegistry,
 IdFieldMapper idFieldMapper,
 BooleanSupplier allowExpensiveQueries,
 IndexNameExpressionResolver expressionResolver,
 ValuesSourceRegistry valuesSourceRegistry,
 IndexStorePlugin.RecoveryStateFactory recoveryStateFactory,
 IndexStorePlugin.IndexFoldersDeletionListener indexFoldersDeletionListener,
 IndexStorePlugin.SnapshotCommitSupplier snapshotCommitSupplier,
 Engine.IndexCommitListener indexCommitListener,
 Supplier<DocumentParsingObserver> documentParsingObserverSupplier)

Method Details

numberOfShards

public int numberOfShards()

getIndexEventListener

public IndexEventListener getIndexEventListener()

iterator

public Iterator<IndexShard> iterator()

Specified by:

iterator in interface Iterable<IndexShard>

hasShard

public boolean hasShard(int shardId)

getShardOrNull

@Nullable
public IndexShard getShardOrNull(int shardId)

Return the shard with the provided id, or null if there is no such shard.

Specified by:

getShardOrNull in interface IndicesClusterStateService.AllocatedIndex<IndexShard>

getShard

public IndexShard getShard(int shardId)

Return the shard with the provided id, or throw an exception if it doesn't exist.

getNodeMappingStats

public NodeMappingStats getNodeMappingStats()

shardIds

public Set<Integer> shardIds()

cache

public IndexCache cache()

getIndexAnalyzers

public IndexAnalyzers getIndexAnalyzers()

mapperService

public MapperService mapperService()

similarityService

public SimilarityService similarityService()

getIndexSortSupplier

public Supplier<org.apache.lucene.search.Sort> getIndexSortSupplier()

close

public void close(String reason,
 boolean delete)
           throws IOException

Throws:

IOException

writeDanglingIndicesInfo

public void writeDanglingIndicesInfo()

deleteDanglingIndicesInfo

public void deleteDanglingIndicesInfo()

indexUUID

public String indexUUID()

createShard

public IndexShard createShard(ShardRouting routing,
 GlobalCheckpointSyncer globalCheckpointSyncer,
 RetentionLeaseSyncer retentionLeaseSyncer)
                       throws IOException

Throws:

IOException

removeShard

public void removeShard(int shardId,
 String reason)

Description copied from interface: IndicesClusterStateService.AllocatedIndex

Removes shard with given id.

Specified by:

removeShard in interface IndicesClusterStateService.AllocatedIndex<IndexShard>

createRecoveryState

public RecoveryState createRecoveryState(ShardRouting shardRouting,
 DiscoveryNode targetNode,
 DiscoveryNode sourceNode)

getIndexSettings

public IndexSettings getIndexSettings()

Description copied from interface: IndicesClusterStateService.AllocatedIndex

Returns the index settings of this index.

Specified by:

getIndexSettings in interface IndicesClusterStateService.AllocatedIndex<IndexShard>

Overrides:

getIndexSettings in class AbstractIndexComponent

newSearchExecutionContext

public SearchExecutionContext newSearchExecutionContext(int shardId,
 int shardRequestIndex,
 org.apache.lucene.search.IndexSearcher searcher,
 LongSupplier nowInMillis,
 String clusterAlias,
 Map<String,Object> runtimeMappings)

Creates a new SearchExecutionContext. Passing a null IndexSearcher will return a valid context, however it won't be able to make IndexReader-specific optimizations, such as rewriting containing range queries.

newQueryRewriteContext

public QueryRewriteContext newQueryRewriteContext(LongSupplier nowInMillis,
 Map<String,Object> runtimeMappings,
 String clusterAlias)

Creates a new QueryRewriteContext. This class is used to rewrite queries in case access to the index is not required, since we can decide rewriting based on mappings alone. This saves the cost of pulling an index searcher as well as the associated cost of refreshing idle shards.

getThreadPool

public ThreadPool getThreadPool()

The ThreadPool to use for this index.

getBigArrays

public BigArrays getBigArrays()

The BigArrays to use for this index.

getScriptService

public ScriptService getScriptService()

The ScriptService to use for this index.

updateMapping

public void updateMapping(IndexMetadata currentIndexMetadata,
 IndexMetadata newIndexMetadata)

Description copied from interface: IndicesClusterStateService.AllocatedIndex

Updates the mappings by applying the incoming ones

Specified by:

updateMapping in interface IndicesClusterStateService.AllocatedIndex<IndexShard>

getMetadata

public IndexMetadata getMetadata()

addMetadataListener

public void addMetadataListener(Consumer<IndexMetadata> listener)

updateMetadata

public void updateMetadata(IndexMetadata currentIndexMetadata,
 IndexMetadata newIndexMetadata)

Description copied from interface: IndicesClusterStateService.AllocatedIndex

Updates the metadata of this index. Changes become visible through IndicesClusterStateService.AllocatedIndex.getIndexSettings().

Specified by:

updateMetadata in interface IndicesClusterStateService.AllocatedIndex<IndexShard>

Parameters:

currentIndexMetadata - the current index metadata

newIndexMetadata - the new index metadata

dateMathExpressionResolverAt

public static Function<String,String> dateMathExpressionResolverAt()

dateMathExpressionResolverAt

public static Function<String,String> dateMathExpressionResolverAt(long instant)

getEngineFactory

public final EngineFactory getEngineFactory()

clearCaches

public boolean clearCaches(boolean queryCache,
 boolean fieldDataCache,
 String... fields)

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

parseRuntimeMappings

public static Map<String,MappedFieldType> parseRuntimeMappings(Map<String,Object> runtimeMappings,
 MapperService mapperService,
 IndexSettings indexSettings,
 MappingLookup lookup)