Package org.opensearch.search
Class SearchService
java.lang.Object
org.opensearch.common.component.AbstractLifecycleComponent
org.opensearch.search.SearchService
- All Implemented Interfaces:
java.io.Closeable
,java.lang.AutoCloseable
,LifecycleComponent
,Releasable
,IndexEventListener
public class SearchService extends AbstractLifecycleComponent implements IndexEventListener
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
SearchService.CanMatchResponse
-
Field Summary
Fields Modifier and Type Field Description static Setting<java.lang.Boolean>
ALLOW_EXPENSIVE_QUERIES
static Setting<java.lang.Boolean>
DEFAULT_ALLOW_PARTIAL_SEARCH_RESULTS
static int
DEFAULT_FROM
static Setting<org.opensearch.common.unit.TimeValue>
DEFAULT_KEEPALIVE_SETTING
static Setting<org.opensearch.common.unit.TimeValue>
DEFAULT_SEARCH_TIMEOUT_SETTING
static int
DEFAULT_SIZE
static Setting<org.opensearch.common.unit.TimeValue>
KEEPALIVE_INTERVAL_SETTING
static Setting<java.lang.Boolean>
LOW_LEVEL_CANCELLATION_SETTING
Enables low-level, frequent search cancellation checks.static Setting<org.opensearch.common.unit.TimeValue>
MAX_KEEPALIVE_SETTING
static Setting<java.lang.Integer>
MAX_OPEN_SCROLL_CONTEXT
static org.opensearch.common.unit.TimeValue
NO_TIMEOUT
-
Constructor Summary
Constructors Constructor Description SearchService(ClusterService clusterService, IndicesService indicesService, ThreadPool threadPool, ScriptService scriptService, BigArrays bigArrays, FetchPhase fetchPhase, ResponseCollectorService responseCollectorService, CircuitBreakerService circuitBreakerService)
-
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(SearchRequest request)
Returns a builder forInternalAggregation.ReduceContext
.AliasFilter
buildAliasFilter(ClusterState state, java.lang.String index, java.util.Set<java.lang.String> resolvedExpressions)
SearchService.CanMatchResponse
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<SearchService.CanMatchResponse> 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.org.opensearch.search.DefaultSearchContext
createSearchContext(ShardSearchRequest request, org.opensearch.common.unit.TimeValue timeout)
boolean
defaultAllowPartialSearchResults()
protected void
doClose()
protected void
doStart()
protected void
doStop()
void
executeDfsPhase(ShardSearchRequest request, boolean keepStatesInContext, 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, boolean keepStatesInContext, 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 SearchServiceIndicesService
getIndicesService()
ResponseCollectorService
getResponseCollectorService()
QueryRewriteContext
getRewriteContext(java.util.function.LongSupplier nowInMillis)
Returns a newQueryRewriteContext
with the givennow
providervoid
openReaderContext(ShardId shardId, org.opensearch.common.unit.TimeValue keepAlive, ActionListener<ShardSearchContextId> listener)
Opens the reader context for given shardId.protected void
putReaderContext(ReaderContext context)
protected ReaderContext
removeReaderContext(long id)
Methods inherited from class org.opensearch.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.opensearch.index.shard.IndexEventListener
afterIndexCreated, afterIndexShardClosed, afterIndexShardCreated, afterIndexShardDeleted, afterIndexShardStarted, beforeIndexAddedToCluster, beforeIndexCreated, beforeIndexRemoved, beforeIndexShardClosed, beforeIndexShardCreated, beforeIndexShardDeleted, beforeIndexShardRecovery, indexShardStateChanged, onShardInactive, onStoreClosed, onStoreCreated, shardRoutingChanged
-
Field Details
-
DEFAULT_KEEPALIVE_SETTING
-
MAX_KEEPALIVE_SETTING
-
KEEPALIVE_INTERVAL_SETTING
-
ALLOW_EXPENSIVE_QUERIES
-
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 org.opensearch.common.unit.TimeValue NO_TIMEOUT -
DEFAULT_SEARCH_TIMEOUT_SETTING
-
DEFAULT_ALLOW_PARTIAL_SEARCH_RESULTS
-
MAX_OPEN_SCROLL_CONTEXT
-
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)
-
-
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 interfaceIndexEventListener
- Parameters:
index
- The indexreason
- the reason for index removal
-
putReaderContext
-
removeReaderContext
-
doStart
protected void doStart()- Specified by:
doStart
in classAbstractLifecycleComponent
-
doStop
protected void doStop()- Specified by:
doStop
in classAbstractLifecycleComponent
-
doClose
protected void doClose()- Specified by:
doClose
in classAbstractLifecycleComponent
-
executeDfsPhase
public void executeDfsPhase(ShardSearchRequest request, boolean keepStatesInContext, SearchShardTask task, ActionListener<SearchPhaseResult> listener) -
executeQueryPhase
public void executeQueryPhase(ShardSearchRequest request, boolean keepStatesInContext, 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) -
openReaderContext
public void openReaderContext(ShardId shardId, org.opensearch.common.unit.TimeValue keepAlive, ActionListener<ShardSearchContextId> listener)Opens the reader context for given shardId. The newly opened reader context will be keep until thekeepAlive
elapsed unless it is manually released. -
createSearchContext
public org.opensearch.search.DefaultSearchContext createSearchContext(ShardSearchRequest request, org.opensearch.common.unit.TimeValue timeout) throws java.io.IOException- Throws:
java.io.IOException
-
freeReaderContext
-
freeAllScrollContexts
public void freeAllScrollContexts() -
getActiveContexts
public int getActiveContexts()Returns the number of active contexts in this SearchService -
getResponseCollectorService
-
buildAliasFilter
public AliasFilter buildAliasFilter(ClusterState state, java.lang.String index, java.util.Set<java.lang.String> resolvedExpressions) -
canMatch
public void canMatch(ShardSearchRequest request, ActionListener<SearchService.CanMatchResponse> listener) -
canMatch
public SearchService.CanMatchResponse canMatch(ShardSearchRequest request) throws java.io.IOExceptionThis 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 returnsfalse
the query won't match any documents on the current shard.- Throws:
java.io.IOException
-
canRewriteToMatchNone
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
Returns a newQueryRewriteContext
with the givennow
provider -
getIndicesService
-
aggReduceContextBuilder
Returns a builder forInternalAggregation.ReduceContext
. This builder retains a reference to the providedSearchRequest
.
-