java.lang.Object

org.elasticsearch.search.internal.SearchContext

All Implemented Interfaces:: java.io.Closeable, java.lang.AutoCloseable, Releasable

Direct Known Subclasses:: FilteredSearchContext

public abstract class SearchContext
extends java.lang.Object
implements Releasable

This class encapsulates the state needed to execute a search. It holds a reference to the shards point in time snapshot (IndexReader / ContextIndexSearcher) and allows passing on state from one query / fetch phase to another.

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`DEFAULT_TERMINATE_AFTER`
`static int`	`DEFAULT_TRACK_TOTAL_HITS_UP_TO`
`static int`	`TRACK_TOTAL_HITS_ACCURATE`
`static int`	`TRACK_TOTAL_HITS_DISABLED`

Constructor Summary

Constructors

Modifier Constructor Description

protected SearchContext()

Method Summary

Modifier and Type	Method	Description
`void`	`addReleasable(Releasable releasable)`	Adds a releasable that will be freed when this context is closed.
`abstract void`	`addRescore(RescoreContext rescore)`
`abstract void`	`addSearchExt(SearchExtBuilder searchExtBuilder)`
`abstract SearchContextAggregations`	`aggregations()`
`abstract SearchContext`	`aggregations(SearchContextAggregations aggregations)`
`abstract org.apache.lucene.search.Query`	`aliasFilter()`
`void`	`assignRescoreDocIds(RescoreDocIds rescoreDocIds)`
`abstract BigArrays`	`bigArrays()`
`abstract BitsetFilterCache`	`bitsetFilterCache()`
`abstract org.apache.lucene.search.Query`	`buildFilteredQuery(org.apache.lucene.search.Query query)`	Automatically apply all required filters to the given query such as alias filters, types filters, etc.
`void`	`close()`
`abstract CollapseContext`	`collapse()`
`abstract SearchContext`	`collapse(CollapseContext collapse)`
`abstract DfsSearchResult`	`dfsResult()`
`abstract int[]`	`docIdsToLoad()`
`abstract SearchContext`	`docIdsToLoad(int[] docIdsToLoad, int docsIdsToLoadFrom, int docsIdsToLoadSize)`
`abstract int`	`docIdsToLoadFrom()`
`abstract int`	`docIdsToLoadSize()`
`protected abstract void`	`doClose()`
`abstract FetchDocValuesContext`	`docValuesContext()`
`abstract SearchContext`	`docValuesContext(FetchDocValuesContext docValuesContext)`
`abstract boolean`	`explain()`
`abstract void`	`explain(boolean explain)`
`abstract FetchFieldsContext`	`fetchFieldsContext()`	The context related to retrieving fields.
`abstract SearchContext`	`fetchFieldsContext(FetchFieldsContext fetchFieldsContext)`	Sets the context related to retrieving fields.
`abstract FetchPhase`	`fetchPhase()`
`abstract FetchSearchResult`	`fetchResult()`
`abstract FetchSourceContext`	`fetchSourceContext()`
`abstract SearchContext`	`fetchSourceContext(FetchSourceContext fetchSourceContext)`
`abstract MappedFieldType`	`fieldType(java.lang.String name)`	Given the full name of a field, returns its `MappedFieldType`.
`abstract int`	`from()`
`abstract SearchContext`	`from(int from)`
`abstract ObjectMapper`	`getObjectMapper(java.lang.String name)`
`abstract Profilers`	`getProfilers()`	Return a handle over the profilers for the current search request, or `null` if profiling is not enabled.
`abstract QueryShardContext`	`getQueryShardContext()`
`abstract long`	`getRelativeTimeInMillis()`	Returns time in milliseconds that can be used for relative time calculations.
`abstract SearchExtBuilder`	`getSearchExt(java.lang.String name)`
`abstract SearchShardTask`	`getTask()`
`abstract java.util.List<java.lang.String>`	`groupStats()`
`abstract void`	`groupStats(java.util.List<java.lang.String> groupStats)`
`abstract boolean`	`hasFetchSourceContext()`
`boolean`	`hasOnlySuggest()`
`abstract boolean`	`hasScriptFields()`
`abstract boolean`	`hasStoredFields()`
`abstract boolean`	`hasStoredFieldsContext()`
`abstract SearchHighlightContext`	`highlight()`
`abstract void`	`highlight(SearchHighlightContext highlight)`
`abstract ShardSearchContextId`	`id()`
`abstract IndexShard`	`indexShard()`
`InnerHitsContext`	`innerHits()`
`abstract boolean`	`isCancelled()`
`abstract boolean`	`lowLevelCancellation()`	Indicates if the current index should perform frequent low level search cancellation check.
`abstract MapperService`	`mapperService()`
`abstract java.lang.Float`	`minimumScore()`
`abstract SearchContext`	`minimumScore(float minimumScore)`
`abstract int`	`numberOfShards()`
`abstract ParsedQuery`	`parsedPostFilter()`
`abstract SearchContext`	`parsedPostFilter(ParsedQuery postFilter)`
`abstract ParsedQuery`	`parsedQuery()`
`abstract SearchContext`	`parsedQuery(ParsedQuery query)`
`abstract void`	`preProcess(boolean rewrite)`	Should be called before executing the main query and after all other parameters have been set.
`abstract org.apache.lucene.search.Query`	`query()`	The query to execute, might be rewritten.
`abstract float`	`queryBoost()`
`abstract java.util.Map<java.lang.Class<?>,org.apache.lucene.search.Collector>`	`queryCollectors()`	Return a view of the additional query collectors that should be run for this context.
`abstract QuerySearchResult`	`queryResult()`
`abstract ReaderContext`	`readerContext()`
`abstract ShardSearchRequest`	`request()`
`abstract java.util.List<RescoreContext>`	`rescore()`
`RescoreDocIds`	`rescoreDocIds()`
`abstract ScriptFieldsContext`	`scriptFields()`
`abstract ScrollContext`	`scrollContext()`
`abstract org.apache.lucene.search.FieldDoc`	`searchAfter()`
`abstract SearchContext`	`searchAfter(org.apache.lucene.search.FieldDoc searchAfter)`
`abstract ContextIndexSearcher`	`searcher()`
`abstract SearchType`	`searchType()`
`abstract boolean`	`seqNoAndPrimaryTerm()`	indicates whether the sequence number and primary term of the last modification to each hit should be returned
`abstract void`	`seqNoAndPrimaryTerm(boolean seqNoAndPrimaryTerm)`	controls whether the sequence number and primary term of the last modification to each hit should be returned
`abstract void`	`setTask(SearchShardTask task)`
`abstract SearchShardTarget`	`shardTarget()`
`abstract SimilarityService`	`similarityService()`
`abstract int`	`size()`
`abstract SearchContext`	`size(int size)`
`abstract SortAndFormats`	`sort()`
`abstract SearchContext`	`sort(SortAndFormats sort)`
`abstract java.lang.String`	`source()`
`abstract boolean`	`sourceRequested()`	A shortcut function to see whether there is a fetchSourceContext and it says the source is requested.
`abstract StoredFieldsContext`	`storedFieldsContext()`
`abstract SearchContext`	`storedFieldsContext(StoredFieldsContext storedFieldsContext)`
`abstract boolean`	`storedFieldsRequested()`	A shortcut function to see whether there is a storedFieldsContext and it says the fields are requested.
`abstract SuggestionSearchContext`	`suggest()`
`abstract void`	`suggest(SuggestionSearchContext suggest)`
`abstract int`	`terminateAfter()`
`abstract void`	`terminateAfter(int terminateAfter)`
`abstract org.elasticsearch.common.unit.TimeValue`	`timeout()`
`abstract void`	`timeout(org.elasticsearch.common.unit.TimeValue timeout)`
`java.lang.String`	`toString()`
`abstract boolean`	`trackScores()`
`abstract SearchContext`	`trackScores(boolean trackScores)`
`abstract int`	`trackTotalHitsUpTo()`	Indicates the total number of hits to count accurately.
`abstract SearchContext`	`trackTotalHitsUpTo(int trackTotalHits)`
`abstract boolean`	`version()`
`abstract void`	`version(boolean version)`

Methods inherited from class java.lang.Object

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

Field Details
- DEFAULT_TERMINATE_AFTER
  
  public static final int DEFAULT_TERMINATE_AFTER
  
  See Also:
  
  Constant Field Values
- TRACK_TOTAL_HITS_ACCURATE
  
  public static final int TRACK_TOTAL_HITS_ACCURATE
  
  See Also:
  
  Constant Field Values
- TRACK_TOTAL_HITS_DISABLED
  
  public static final int TRACK_TOTAL_HITS_DISABLED
  
  See Also:
  
  Constant Field Values
- DEFAULT_TRACK_TOTAL_HITS_UP_TO
  
  public static final int DEFAULT_TRACK_TOTAL_HITS_UP_TO
  
  See Also:
  
  Constant Field Values
Constructor Details
- SearchContext
  
  protected SearchContext()
Method Details
- setTask
  
  public abstract void setTask(SearchShardTask task)
- getTask
  
  public abstract SearchShardTask getTask()
- isCancelled
  
  public abstract boolean isCancelled()
- close
  
  public final void close()
  
  Specified by:
  
  close in interface java.lang.AutoCloseable
  
  Specified by:
  
  close in interface java.io.Closeable
  
  Specified by:
  
  close in interface Releasable
- doClose
  
  protected abstract void doClose()
- preProcess
  
  public abstract void preProcess(boolean rewrite)
  
  Should be called before executing the main query and after all other parameters have been set.
  
  Parameters:
  
  rewrite - if the set query should be rewritten against the searcher returned from searcher()
- buildFilteredQuery
  
  public abstract org.apache.lucene.search.Query buildFilteredQuery(org.apache.lucene.search.Query query)
  
  Automatically apply all required filters to the given query such as alias filters, types filters, etc.
- id
  
  public abstract ShardSearchContextId id()
- source
  
  public abstract java.lang.String source()
- request
  
  public abstract ShardSearchRequest request()
- searchType
  
  public abstract SearchType searchType()
- shardTarget
  
  public abstract SearchShardTarget shardTarget()
- numberOfShards
  
  public abstract int numberOfShards()
- queryBoost
  
  public abstract float queryBoost()
- scrollContext
  
  public abstract ScrollContext scrollContext()
- aggregations
  
  public abstract SearchContextAggregations aggregations()
- aggregations
  
  public abstract SearchContext aggregations(SearchContextAggregations aggregations)
- addSearchExt
  
  public abstract void addSearchExt(SearchExtBuilder searchExtBuilder)
- getSearchExt
  
  public abstract SearchExtBuilder getSearchExt(java.lang.String name)
- highlight
  
  public abstract SearchHighlightContext highlight()
- highlight
  
  public abstract void highlight(SearchHighlightContext highlight)
- innerHits
  
  public InnerHitsContext innerHits()
- suggest
  
  public abstract SuggestionSearchContext suggest()
- suggest
  
  public abstract void suggest(SuggestionSearchContext suggest)
- rescore
  
  public abstract java.util.List<RescoreContext> rescore()
  
  Returns:
  
  list of all rescore contexts. empty if there aren't any.
- addRescore
  
  public abstract void addRescore(RescoreContext rescore)
- rescoreDocIds
  
  public final RescoreDocIds rescoreDocIds()
- assignRescoreDocIds
  
  public final void assignRescoreDocIds(RescoreDocIds rescoreDocIds)
- hasScriptFields
  
  public abstract boolean hasScriptFields()
- scriptFields
  
  public abstract ScriptFieldsContext scriptFields()
- sourceRequested
  
  public abstract boolean sourceRequested()
  
  A shortcut function to see whether there is a fetchSourceContext and it says the source is requested.
- hasFetchSourceContext
  
  public abstract boolean hasFetchSourceContext()
- fetchSourceContext
  
  public abstract FetchSourceContext fetchSourceContext()
- fetchSourceContext
  
  public abstract SearchContext fetchSourceContext(FetchSourceContext fetchSourceContext)
- docValuesContext
  
  public abstract FetchDocValuesContext docValuesContext()
- docValuesContext
  
  public abstract SearchContext docValuesContext(FetchDocValuesContext docValuesContext)
- fetchFieldsContext
  
  public abstract FetchFieldsContext fetchFieldsContext()
  
  The context related to retrieving fields.
- fetchFieldsContext
  
  public abstract SearchContext fetchFieldsContext(FetchFieldsContext fetchFieldsContext)
  
  Sets the context related to retrieving fields.
- searcher
  
  public abstract ContextIndexSearcher searcher()
- indexShard
  
  public abstract IndexShard indexShard()
- mapperService
  
  public abstract MapperService mapperService()
- similarityService
  
  public abstract SimilarityService similarityService()
- bigArrays
  
  public abstract BigArrays bigArrays()
- bitsetFilterCache
  
  public abstract BitsetFilterCache bitsetFilterCache()
- timeout
  
  public abstract org.elasticsearch.common.unit.TimeValue timeout()
- timeout
  
  public abstract void timeout(org.elasticsearch.common.unit.TimeValue timeout)
- terminateAfter
  
  public abstract int terminateAfter()
- terminateAfter
  
  public abstract void terminateAfter(int terminateAfter)
- lowLevelCancellation
  
  public abstract boolean lowLevelCancellation()
  
  Indicates if the current index should perform frequent low level search cancellation check. 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.
- minimumScore
  
  public abstract SearchContext minimumScore(float minimumScore)
- minimumScore
  
  public abstract java.lang.Float minimumScore()
- sort
  
  public abstract SearchContext sort(SortAndFormats sort)
- sort
  
  public abstract SortAndFormats sort()
- trackScores
  
  public abstract SearchContext trackScores(boolean trackScores)
- trackScores
  
  public abstract boolean trackScores()
- trackTotalHitsUpTo
  
  public abstract SearchContext trackTotalHitsUpTo(int trackTotalHits)
- trackTotalHitsUpTo
  
  public abstract int trackTotalHitsUpTo()
  
  Indicates the total number of hits to count accurately. Defaults to DEFAULT_TRACK_TOTAL_HITS_UP_TO.
- searchAfter
  
  public abstract SearchContext searchAfter(org.apache.lucene.search.FieldDoc searchAfter)
- searchAfter
  
  public abstract org.apache.lucene.search.FieldDoc searchAfter()
- collapse
  
  public abstract SearchContext collapse(CollapseContext collapse)
- collapse
  
  public abstract CollapseContext collapse()
- parsedPostFilter
  
  public abstract SearchContext parsedPostFilter(ParsedQuery postFilter)
- parsedPostFilter
  
  public abstract ParsedQuery parsedPostFilter()
- aliasFilter
  
  public abstract org.apache.lucene.search.Query aliasFilter()
- parsedQuery
  
  public abstract SearchContext parsedQuery(ParsedQuery query)
- parsedQuery
  
  public abstract ParsedQuery parsedQuery()
- query
  
  public abstract org.apache.lucene.search.Query query()
  
  The query to execute, might be rewritten.
- from
  
  public abstract int from()
- from
  
  public abstract SearchContext from(int from)
- size
  
  public abstract int size()
- size
  
  public abstract SearchContext size(int size)
- hasStoredFields
  
  public abstract boolean hasStoredFields()
- hasStoredFieldsContext
  
  public abstract boolean hasStoredFieldsContext()
- storedFieldsRequested
  
  public abstract boolean storedFieldsRequested()
  
  A shortcut function to see whether there is a storedFieldsContext and it says the fields are requested.
- storedFieldsContext
  
  public abstract StoredFieldsContext storedFieldsContext()
- storedFieldsContext
  
  public abstract SearchContext storedFieldsContext(StoredFieldsContext storedFieldsContext)
- explain
  
  public abstract boolean explain()
- explain
  
  public abstract void explain(boolean explain)
- groupStats
  
  @Nullable public abstract java.util.List<java.lang.String> groupStats()
- groupStats
  
  public abstract void groupStats(java.util.List<java.lang.String> groupStats)
- version
  
  public abstract boolean version()
- version
  
  public abstract void version(boolean version)
- seqNoAndPrimaryTerm
  
  public abstract boolean seqNoAndPrimaryTerm()
  
  indicates whether the sequence number and primary term of the last modification to each hit should be returned
- seqNoAndPrimaryTerm
  
  public abstract void seqNoAndPrimaryTerm(boolean seqNoAndPrimaryTerm)
  
  controls whether the sequence number and primary term of the last modification to each hit should be returned
- docIdsToLoad
  
  public abstract int[] docIdsToLoad()
- docIdsToLoadFrom
  
  public abstract int docIdsToLoadFrom()
- docIdsToLoadSize
  
  public abstract int docIdsToLoadSize()
- docIdsToLoad
  
  public abstract SearchContext docIdsToLoad(int[] docIdsToLoad, int docsIdsToLoadFrom, int docsIdsToLoadSize)
- dfsResult
  
  public abstract DfsSearchResult dfsResult()
- queryResult
  
  public abstract QuerySearchResult queryResult()
- fetchPhase
  
  public abstract FetchPhase fetchPhase()
- fetchResult
  
  public abstract FetchSearchResult fetchResult()
- getProfilers
  
  public abstract Profilers getProfilers()
  
  Return a handle over the profilers for the current search request, or null if profiling is not enabled.
- addReleasable
  
  public void addReleasable(Releasable releasable)
  
  Adds a releasable that will be freed when this context is closed.
- hasOnlySuggest
  
  public final boolean hasOnlySuggest()
  
  Returns:
  
  true if the request contains only suggest
- fieldType
  
  public abstract MappedFieldType fieldType(java.lang.String name)
  
  Given the full name of a field, returns its MappedFieldType.
- getObjectMapper
  
  public abstract ObjectMapper getObjectMapper(java.lang.String name)
- getRelativeTimeInMillis
  
  public abstract long getRelativeTimeInMillis()
  
  Returns time in milliseconds that can be used for relative time calculations. WARN: This is not the epoch time.
- queryCollectors
  
  public abstract java.util.Map<java.lang.Class<?>,org.apache.lucene.search.Collector> queryCollectors()
  
  Return a view of the additional query collectors that should be run for this context.
- getQueryShardContext
  
  public abstract QueryShardContext getQueryShardContext()
- toString
  
  public java.lang.String toString()
  
  Overrides:
  
  toString in class java.lang.Object
- readerContext
  
  public abstract ReaderContext readerContext()

Class SearchContext

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Details

Constructor Details

Method Details