org.elasticsearch.search

Class SearchService

java.lang.Object

org.elasticsearch.common.component.AbstractComponent

org.elasticsearch.common.component.AbstractLifecycleComponent

org.elasticsearch.search.SearchService

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, LifecycleComponent, Releasable, IndexEventListener

public class SearchService
extends AbstractLifecycleComponent
implements IndexEventListener

Field Summary

Fields

Modifier and Type	Field and Description
static Setting<TimeValue>	DEFAULT_KEEPALIVE_SETTING
static Setting<TimeValue>	DEFAULT_SEARCH_TIMEOUT_SETTING
static Setting<TimeValue>	KEEPALIVE_INTERVAL_SETTING
static Setting<java.lang.Boolean>	LOW_LEVEL_CANCELLATION_SETTING Enables low-level, frequent search cancellation checks.
static TimeValue	NO_TIMEOUT

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

lifecycle

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

deprecationLogger, logger, settings

Constructor Summary

Constructors

Constructor and Description
SearchService(ClusterService clusterService, IndicesService indicesService, ThreadPool threadPool, ScriptService scriptService, BigArrays bigArrays, FetchPhase fetchPhase)

Method Summary

Modifier and Type	Method and Description
void	afterIndexRemoved(Index index, IndexSettings indexSettings, IndicesClusterStateService.AllocatedIndices.IndexRemovalReason reason) Called after the index has been removed.
AliasFilter	buildAliasFilter(ClusterState state, java.lang.String index, java.lang.String... expressions)
boolean	canMatch(ShardSearchRequest request) This method does a very quick rewrite of the query and returns true if the query can potentially match any documents.
static boolean	canRewriteToMatchNone(SearchSourceBuilder source) Returns true iff the given search source builder can be early terminated by rewriting to a match none query.
org.elasticsearch.search.DefaultSearchContext	createSearchContext(ShardSearchRequest request, TimeValue timeout, Engine.Searcher searcher)
protected void	doClose()
protected void	doStart()
protected void	doStop()
DfsSearchResult	executeDfsPhase(ShardSearchRequest request, SearchTask task)
ScrollQueryFetchSearchResult	executeFetchPhase(InternalScrollSearchRequest request, SearchTask task)
FetchSearchResult	executeFetchPhase(ShardFetchRequest request, SearchTask task)
ScrollQuerySearchResult	executeQueryPhase(InternalScrollSearchRequest request, SearchTask task)
QuerySearchResult	executeQueryPhase(QuerySearchRequest request, SearchTask task)
SearchPhaseResult	executeQueryPhase(ShardSearchRequest request, SearchTask task)
void	freeAllScrollContexts()
boolean	freeContext(long id)
int	getActiveContexts() Returns the number of active contexts in this SearchService
protected void	putContext(SearchContext context)
protected SearchContext	removeContext(long id)

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

addLifecycleListener, close, lifecycleState, removeLifecycleListener, start, stop

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

Methods inherited from interface org.elasticsearch.index.shard.IndexEventListener

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

Field Detail

DEFAULT_KEEPALIVE_SETTING

public static final Setting<TimeValue> DEFAULT_KEEPALIVE_SETTING

KEEPALIVE_INTERVAL_SETTING

public static final Setting<TimeValue> KEEPALIVE_INTERVAL_SETTING

LOW_LEVEL_CANCELLATION_SETTING

public static final Setting<java.lang.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. However, since it will produce more cancellation checks it might slow the search performance down.

NO_TIMEOUT

public static final TimeValue NO_TIMEOUT

DEFAULT_SEARCH_TIMEOUT_SETTING

public static final Setting<TimeValue> DEFAULT_SEARCH_TIMEOUT_SETTING

Constructor Detail

SearchService

public SearchService(ClusterService clusterService,
                     IndicesService indicesService,
                     ThreadPool threadPool,
                     ScriptService scriptService,
                     BigArrays bigArrays,
                     FetchPhase fetchPhase)

Method Detail

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

putContext

protected void putContext(SearchContext context)

removeContext

protected SearchContext removeContext(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 DfsSearchResult executeDfsPhase(ShardSearchRequest request,
                                       SearchTask task)
                                throws java.io.IOException

Throws:

java.io.IOException

executeQueryPhase

public SearchPhaseResult executeQueryPhase(ShardSearchRequest request,
                                           SearchTask task)
                                    throws java.io.IOException

Throws:

java.io.IOException

executeQueryPhase

public ScrollQuerySearchResult executeQueryPhase(InternalScrollSearchRequest request,
                                                 SearchTask task)

executeQueryPhase

public QuerySearchResult executeQueryPhase(QuerySearchRequest request,
                                           SearchTask task)

executeFetchPhase

public ScrollQueryFetchSearchResult executeFetchPhase(InternalScrollSearchRequest request,
                                                      SearchTask task)

executeFetchPhase

public FetchSearchResult executeFetchPhase(ShardFetchRequest request,
                                           SearchTask task)

createSearchContext

public org.elasticsearch.search.DefaultSearchContext createSearchContext(ShardSearchRequest request,
                                                                         TimeValue timeout,
                                                                         @Nullable
                                                                         Engine.Searcher searcher)
                                                                  throws java.io.IOException

Throws:

java.io.IOException

freeContext

public boolean freeContext(long id)

freeAllScrollContexts

public void freeAllScrollContexts()

getActiveContexts

public int getActiveContexts()

Returns the number of active contexts in this SearchService

buildAliasFilter

public AliasFilter buildAliasFilter(ClusterState state,
                                    java.lang.String index,
                                    java.lang.String... expressions)

canMatch

public boolean canMatch(ShardSearchRequest request)
                 throws java.io.IOException

This method does a very quick rewrite of the query and returns true if the query can potentially 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:

java.io.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 a 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.