Package org.elasticsearch.search

Class SearchService

java.lang.Object

org.elasticsearch.common.component.AbstractLifecycleComponent

org.elasticsearch.search.SearchService

All Implemented Interfaces:

Closeable, AutoCloseable, LifecycleComponent, Releasable, IndexEventListener

public class SearchService
extends AbstractLifecycleComponent
implements IndexEventListener

Field Summary

Fields

Modifier and Type	Field	Description
static final Setting<Boolean>	ALLOW_EXPENSIVE_QUERIES
static final Setting<Boolean>	DEFAULT_ALLOW_PARTIAL_SEARCH_RESULTS
static final int	DEFAULT_FROM
static final Setting<TimeValue>	DEFAULT_KEEPALIVE_SETTING
static final Setting<TimeValue>	DEFAULT_SEARCH_TIMEOUT_SETTING
static final int	DEFAULT_SIZE
static final Setting<Boolean>	ENABLE_REWRITE_AGGS_TO_FILTER_BY_FILTER
static final Setting<TimeValue>	KEEPALIVE_INTERVAL_SETTING
static final Setting<Boolean>	LOW_LEVEL_CANCELLATION_SETTING	Enables low-level, frequent search cancellation checks.
static final Setting<ByteSizeValue>	MAX_ASYNC_SEARCH_RESPONSE_SIZE_SETTING
static final Setting<TimeValue>	MAX_KEEPALIVE_SETTING
static final Setting<Integer>	MAX_OPEN_SCROLL_CONTEXT
static final TimeValue	NO_TIMEOUT

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

lifecycle

Constructor Summary

Constructors

Constructor	Description
SearchService(ClusterService clusterService, IndicesService indicesService, ThreadPool threadPool, ScriptService scriptService, BigArrays bigArrays, FetchPhase fetchPhase, ResponseCollectorService responseCollectorService, CircuitBreakerService circuitBreakerService, ExecutorSelector executorSelector)

Method Summary

Modifier and Type	Method	Description
void	afterIndexRemoved(Index index, IndexSettings indexSettings, IndicesClusterStateService.AllocatedIndices.IndexRemovalReason reason)	Called after the index has been removed.
InternalAggregation.ReduceContextBuilder	aggReduceContextBuilder(Supplier<Boolean> isCanceled, SearchRequest request)	Returns a builder for InternalAggregation.ReduceContext.
void	beforeIndexShardCreated(ShardRouting routing, Settings indexSettings)	Called before the index shard gets created, before obtaining the shard lock.
AliasFilter	buildAliasFilter(ClusterState state, String index, Set<String> resolvedExpressions)
void	canMatch(CanMatchNodeRequest request, ActionListener<CanMatchNodeResponse> listener)
CanMatchShardResponse	canMatch(ShardSearchRequest request)	This method uses a lightweight searcher without wrapping (i.e., not open a full reader on frozen indices) to rewrite the query to check if the query can match any documents.
void	canMatch(ShardSearchRequest request, ActionListener<CanMatchShardResponse> listener)
static boolean	canRewriteToMatchNone(SearchSourceBuilder source)	Returns true iff the given search source builder can be early terminated by rewriting to a match none query.
protected void	checkCancelled(SearchShardTask task)
protected SearchContext	createContext(ReaderContext readerContext, ShardSearchRequest request, SearchShardTask task, boolean includeAggregations)
org.elasticsearch.search.DefaultSearchContext	createSearchContext(ShardSearchRequest request, TimeValue timeout)
boolean	defaultAllowPartialSearchResults()
protected void	doClose()
protected void	doStart()
protected void	doStop()
void	executeDfsPhase(ShardSearchRequest request, SearchShardTask task, ActionListener<SearchPhaseResult> listener)
void	executeFetchPhase(ShardFetchRequest request, SearchShardTask task, ActionListener<FetchSearchResult> listener)
void	executeFetchPhase(InternalScrollSearchRequest request, SearchShardTask task, ActionListener<ScrollQueryFetchSearchResult> listener)
void	executeQueryPhase(InternalScrollSearchRequest request, SearchShardTask task, ActionListener<ScrollQuerySearchResult> listener)
void	executeQueryPhase(ShardSearchRequest request, SearchShardTask task, ActionListener<SearchPhaseResult> listener)
void	executeQueryPhase(QuerySearchRequest request, SearchShardTask task, ActionListener<QuerySearchResult> listener)
void	freeAllScrollContexts()
boolean	freeReaderContext(ShardSearchContextId contextId)
int	getActiveContexts()	Returns the number of active contexts in this SearchService
CoordinatorRewriteContextProvider	getCoordinatorRewriteContextProvider(LongSupplier nowInMillis)
IndicesService	getIndicesService()
int	getOpenScrollContexts()	Returns the number of scroll contexts opened on the node
ResponseCollectorService	getResponseCollectorService()
QueryRewriteContext	getRewriteContext(LongSupplier nowInMillis)	Returns a new QueryRewriteContext with the given now provider
void	openReaderContext(ShardId shardId, TimeValue keepAlive, ActionListener<ShardSearchContextId> listener)	Opens the reader context for given shardId.
protected void	putReaderContext(ReaderContext context)
static boolean	queryStillMatchesAfterRewrite(ShardSearchRequest request, QueryRewriteContext context)
protected ReaderContext	removeReaderContext(long id)

Methods inherited from class org.elasticsearch.common.component.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.elasticsearch.index.shard.IndexEventListener

afterIndexCreated, afterIndexShardClosed, afterIndexShardCreated, afterIndexShardDeleted, afterIndexShardStarted, beforeIndexAddedToCluster, beforeIndexCreated, beforeIndexRemoved, beforeIndexShardClosed, beforeIndexShardDeleted, beforeIndexShardRecovery, indexShardStateChanged, onShardInactive, onStoreClosed, onStoreCreated, shardRoutingChanged

Field Details

DEFAULT_KEEPALIVE_SETTING

public static final Setting<TimeValue> DEFAULT_KEEPALIVE_SETTING

MAX_KEEPALIVE_SETTING

public static final Setting<TimeValue> MAX_KEEPALIVE_SETTING

KEEPALIVE_INTERVAL_SETTING

public static final Setting<TimeValue> KEEPALIVE_INTERVAL_SETTING

ALLOW_EXPENSIVE_QUERIES

public static final Setting<Boolean> ALLOW_EXPENSIVE_QUERIES

LOW_LEVEL_CANCELLATION_SETTING

public static final Setting<Boolean> LOW_LEVEL_CANCELLATION_SETTING

Enables low-level, frequent search cancellation checks. Enabling low-level checks will make long running searches to react to the cancellation request faster. It will produce more cancellation checks but benchmarking has shown these did not noticeably slow down searches.

NO_TIMEOUT

public static final TimeValue NO_TIMEOUT

DEFAULT_SEARCH_TIMEOUT_SETTING

public static final Setting<TimeValue> DEFAULT_SEARCH_TIMEOUT_SETTING

DEFAULT_ALLOW_PARTIAL_SEARCH_RESULTS

public static final Setting<Boolean> DEFAULT_ALLOW_PARTIAL_SEARCH_RESULTS

MAX_OPEN_SCROLL_CONTEXT

public static final Setting<Integer> MAX_OPEN_SCROLL_CONTEXT

ENABLE_REWRITE_AGGS_TO_FILTER_BY_FILTER

public static final Setting<Boolean> ENABLE_REWRITE_AGGS_TO_FILTER_BY_FILTER

MAX_ASYNC_SEARCH_RESPONSE_SIZE_SETTING

public static final Setting<ByteSizeValue> MAX_ASYNC_SEARCH_RESPONSE_SIZE_SETTING

DEFAULT_SIZE

public static final int DEFAULT_SIZE

See Also:

• Constant Field Values

DEFAULT_FROM

public static final int DEFAULT_FROM

See Also:

• Constant Field Values

Constructor Details

SearchService

public SearchService(ClusterService clusterService,
 IndicesService indicesService,
 ThreadPool threadPool,
 ScriptService scriptService,
 BigArrays bigArrays,
 FetchPhase fetchPhase,
 ResponseCollectorService responseCollectorService,
 CircuitBreakerService circuitBreakerService,
 ExecutorSelector executorSelector)

Method Details

defaultAllowPartialSearchResults

public boolean defaultAllowPartialSearchResults()

afterIndexRemoved

public void afterIndexRemoved(Index index,
 IndexSettings indexSettings,
 IndicesClusterStateService.AllocatedIndices.IndexRemovalReason reason)

Description copied from interface: IndexEventListener

Called after the index has been removed.

Specified by:

afterIndexRemoved in interface IndexEventListener

Parameters:

index - The index

reason - the reason for index removal

beforeIndexShardCreated

public void beforeIndexShardCreated(ShardRouting routing,
 Settings indexSettings)

Description copied from interface: IndexEventListener

Called before the index shard gets created, before obtaining the shard lock.

Specified by:

beforeIndexShardCreated in interface IndexEventListener

Parameters:

routing - the routing entry that caused the shard to be created.

indexSettings - the shards index settings

putReaderContext

protected void putReaderContext(ReaderContext context)

removeReaderContext

protected ReaderContext removeReaderContext(long id)

doStart

protected void doStart()

Specified by:

doStart in class AbstractLifecycleComponent

doStop

protected void doStop()

Specified by:

doStop in class AbstractLifecycleComponent

doClose

protected void doClose()

Specified by:

doClose in class AbstractLifecycleComponent

executeDfsPhase

public void executeDfsPhase(ShardSearchRequest request,
 SearchShardTask task,
 ActionListener<SearchPhaseResult> listener)

executeQueryPhase

public void executeQueryPhase(ShardSearchRequest request,
 SearchShardTask task,
 ActionListener<SearchPhaseResult> listener)

executeQueryPhase

public void executeQueryPhase(InternalScrollSearchRequest request,
 SearchShardTask task,
 ActionListener<ScrollQuerySearchResult> listener)

executeQueryPhase

public void executeQueryPhase(QuerySearchRequest request,
 SearchShardTask task,
 ActionListener<QuerySearchResult> listener)

executeFetchPhase

public void executeFetchPhase(InternalScrollSearchRequest request,
 SearchShardTask task,
 ActionListener<ScrollQueryFetchSearchResult> listener)

executeFetchPhase

public void executeFetchPhase(ShardFetchRequest request,
 SearchShardTask task,
 ActionListener<FetchSearchResult> listener)

checkCancelled

protected void checkCancelled(SearchShardTask task)

openReaderContext

public void openReaderContext(ShardId shardId,
 TimeValue keepAlive,
 ActionListener<ShardSearchContextId> listener)

Opens the reader context for given shardId. The newly opened reader context will be keep until the keepAlive elapsed unless it is manually released.

createContext

protected SearchContext createContext(ReaderContext readerContext,
 ShardSearchRequest request,
 SearchShardTask task,
 boolean includeAggregations)
                               throws IOException

Throws:

IOException

createSearchContext

public org.elasticsearch.search.DefaultSearchContext createSearchContext(ShardSearchRequest request,
 TimeValue timeout)
                                                                  throws IOException

Throws:

IOException

freeReaderContext

public boolean freeReaderContext(ShardSearchContextId contextId)

freeAllScrollContexts

public void freeAllScrollContexts()

getActiveContexts

public int getActiveContexts()

Returns the number of active contexts in this SearchService

getOpenScrollContexts

public int getOpenScrollContexts()

Returns the number of scroll contexts opened on the node

getResponseCollectorService

public ResponseCollectorService getResponseCollectorService()

buildAliasFilter

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

canMatch

public void canMatch(ShardSearchRequest request,
 ActionListener<CanMatchShardResponse> listener)

canMatch

public void canMatch(CanMatchNodeRequest request,
 ActionListener<CanMatchNodeResponse> listener)

canMatch

public CanMatchShardResponse canMatch(ShardSearchRequest request)
                               throws IOException

This method uses a lightweight searcher without wrapping (i.e., not open a full reader on frozen indices) to rewrite the query to check if the query can match any documents. This method can have false positives while if it returns false the query won't match any documents on the current shard.

Throws:

IOException

queryStillMatchesAfterRewrite

public static boolean queryStillMatchesAfterRewrite(ShardSearchRequest request,
 QueryRewriteContext context)
                                             throws IOException

Throws:

IOException

canRewriteToMatchNone

public static boolean canRewriteToMatchNone(SearchSourceBuilder source)

Returns true iff the given search source builder can be early terminated by rewriting to a match none query. Or in other words if the execution of the search request can be early terminated without executing it. This is for instance not possible if a global aggregation is part of this request or if there is a suggest builder present.

getRewriteContext

public QueryRewriteContext getRewriteContext(LongSupplier nowInMillis)

Returns a new QueryRewriteContext with the given now provider

getCoordinatorRewriteContextProvider

public CoordinatorRewriteContextProvider getCoordinatorRewriteContextProvider(LongSupplier nowInMillis)

getIndicesService

public IndicesService getIndicesService()

aggReduceContextBuilder

public InternalAggregation.ReduceContextBuilder aggReduceContextBuilder(Supplier<Boolean> isCanceled,
 SearchRequest request)

Returns a builder for InternalAggregation.ReduceContext. This builder retains a reference to the provided SearchRequest.