org.elasticsearch.search.internal

Class SearchContext

java.lang.Object

org.elasticsearch.common.DelegatingHasContextAndHeaders

org.elasticsearch.search.internal.SearchContext

All Implemented Interfaces:

AutoCloseable, HasContext, HasContextAndHeaders, HasHeaders, Releasable, RefCounted

Direct Known Subclasses:

DefaultSearchContext, FilteredSearchContext, PercolateContext

public abstract class SearchContext
extends DelegatingHasContextAndHeaders
implements Releasable, RefCounted

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. This class also implements RefCounted since in some situations like in SearchService a SearchContext can be closed concurrently due to independent events ie. when an index gets removed. To prevent accessing closed IndexReader / IndexSearcher instances the SearchContext can be guarded by a reference count and fail if it's been closed by an external event.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SearchContext.Lifetime The life time of an object that is used during search execution.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_TERMINATE_AFTER
protected ParseFieldMatcher	parseFieldMatcher

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SearchContext(ParseFieldMatcher parseFieldMatcher, HasContextAndHeaders contextHeaders)

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	accessed(long accessTime)
void	addReleasable(Releasable releasable, SearchContext.Lifetime lifetime) Schedule the release of a resource.
abstract void	addRescore(RescoreSearchContext rescore)
abstract SearchContextAggregations	aggregations()
abstract SearchContext	aggregations(SearchContextAggregations aggregations)
abstract org.apache.lucene.search.Query	aliasFilter()
protected void	alreadyClosed()
abstract AnalysisService	analysisService()
abstract BigArrays	bigArrays()
abstract BitsetFilterCache	bitsetFilterCache()
void	clearReleasables(SearchContext.Lifetime lifetime)
void	close()
static SearchContext	current()
void	decRef() Decreases the refCount of this instance.
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 void	emptyFieldNames()
abstract boolean	explain()
abstract void	explain(boolean explain)
abstract FetchSearchResult	fetchResult()
abstract FetchSourceContext	fetchSourceContext()
abstract SearchContext	fetchSourceContext(FetchSourceContext fetchSourceContext)
abstract IndexFieldDataService	fieldData()
abstract List<String>	fieldNames()
abstract int	from()
abstract SearchContext	from(int from)
abstract <SubPhaseContext extends FetchSubPhaseContext> SubPhaseContext	getFetchSubPhaseContext(FetchSubPhase.ContextFactory<SubPhaseContext> contextFactory)
abstract ObjectMapper	getObjectMapper(String name)
abstract long	getOriginNanoTime()
abstract Profilers	getProfilers() Return a handle over the profilers for the current search request, or null if profiling is not enabled.
abstract List<String>	groupStats()
abstract void	groupStats(List<String> groupStats)
abstract boolean	hasFetchSourceContext()
abstract boolean	hasFieldNames()
abstract boolean	hasScriptFields()
abstract boolean	hasTypes()
abstract SearchContextHighlight	highlight()
abstract void	highlight(SearchContextHighlight highlight)
abstract long	id()
void	incRef() Increments the refCount of this instance.
abstract IndexShard	indexShard()
InnerHitsContext	innerHits()
abstract long	keepAlive()
abstract void	keepAlive(long keepAlive)
abstract long	lastAccessTime()
abstract SearchLookup	lookup()
abstract MapperService	mapperService()
abstract Float	minimumScore()
abstract SearchContext	minimumScore(float minimumScore)
long	nowInMillis()
protected abstract long	nowInMillisImpl()
boolean	nowInMillisUsed()
abstract int	numberOfShards()
abstract PageCacheRecycler	pageCacheRecycler()
abstract ParsedQuery	parsedPostFilter()
abstract SearchContext	parsedPostFilter(ParsedQuery postFilter)
abstract ParsedQuery	parsedQuery()
abstract SearchContext	parsedQuery(ParsedQuery query)
ParseFieldMatcher	parseFieldMatcher()
abstract void	preProcess() 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 SearchContext	queryBoost(float queryBoost)
abstract Map<Class<?>,org.apache.lucene.search.Collector>	queryCollectors() Return a view of the additional query collectors that should be run for this context.
abstract IndexQueryParserService	queryParserService()
abstract QuerySearchResult	queryResult()
int	refCount() Returns the current reference count.
static void	removeCurrent()
abstract ShardSearchRequest	request()
abstract List<RescoreSearchContext>	rescore()
abstract ScanContext	scanContext()
abstract ScriptFieldsContext	scriptFields()
abstract ScriptService	scriptService()
abstract ScrollContext	scrollContext()
abstract SearchContext	scrollContext(ScrollContext scroll)
abstract ContextIndexSearcher	searcher()
abstract org.apache.lucene.search.Query	searchFilter(String[] types)
abstract SearchType	searchType()
abstract SearchContext	searchType(SearchType searchType)
static void	setCurrent(SearchContext value)
abstract SearchShardTarget	shardTarget()
abstract SimilarityService	similarityService()
abstract int	size()
abstract SearchContext	size(int size)
abstract MappedFieldType	smartNameFieldType(String name)
abstract MappedFieldType	smartNameFieldTypeFromAnyType(String name) Looks up the given field, but does not restrict to fields in the types set on this context.
abstract org.apache.lucene.search.Sort	sort()
abstract SearchContext	sort(org.apache.lucene.search.Sort sort)
abstract String	source()
abstract boolean	sourceRequested() A shortcut function to see whether there is a fetchSourceContext and it says the source is requested.
abstract SuggestionSearchContext	suggest()
abstract void	suggest(SuggestionSearchContext suggest)
abstract int	terminateAfter()
abstract void	terminateAfter(int terminateAfter)
abstract org.apache.lucene.util.Counter	timeEstimateCounter()
abstract long	timeoutInMillis()
abstract void	timeoutInMillis(long timeoutInMillis)
abstract boolean	trackScores()
abstract SearchContext	trackScores(boolean trackScores)
boolean	tryIncRef() Tries to increment the refCount of this instance.
abstract String[]	types()
abstract boolean	version()
abstract void	version(boolean version)

Methods inherited from class org.elasticsearch.common.DelegatingHasContextAndHeaders

contextSize, copyContextAndHeadersFrom, copyContextFrom, copyHeadersFrom, getContext, getFromContext, getFromContext, getHeader, getHeaders, hasHeader, hasInContext, isContextEmpty, putAllInContext, putHeader, putInContext

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_TERMINATE_AFTER

public static final int DEFAULT_TERMINATE_AFTER

See Also:

Constant Field Values

parseFieldMatcher

protected final ParseFieldMatcher parseFieldMatcher

Constructor Detail

SearchContext

protected SearchContext(ParseFieldMatcher parseFieldMatcher,
             HasContextAndHeaders contextHeaders)

Method Detail

setCurrent

public static void setCurrent(SearchContext value)

removeCurrent

public static void removeCurrent()

current

public static SearchContext current()

parseFieldMatcher

public ParseFieldMatcher parseFieldMatcher()

close

public final void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Releasable

doClose

protected abstract void doClose()

preProcess

public abstract void preProcess()

Should be called before executing the main query and after all other parameters have been set.

searchFilter

public abstract org.apache.lucene.search.Query searchFilter(String[] types)

id

public abstract long id()

source

public abstract String source()

request

public abstract ShardSearchRequest request()

searchType

public abstract SearchType searchType()

searchType

public abstract SearchContext searchType(SearchType searchType)

shardTarget

public abstract SearchShardTarget shardTarget()

numberOfShards

public abstract int numberOfShards()

hasTypes

public abstract boolean hasTypes()

types

public abstract String[] types()

queryBoost

public abstract float queryBoost()

queryBoost

public abstract SearchContext queryBoost(float queryBoost)

getOriginNanoTime

public abstract long getOriginNanoTime()

nowInMillis

public final long nowInMillis()

nowInMillisUsed

public final boolean nowInMillisUsed()

nowInMillisImpl

protected abstract long nowInMillisImpl()

scrollContext

public abstract ScrollContext scrollContext()

scrollContext

public abstract SearchContext scrollContext(ScrollContext scroll)

aggregations

public abstract SearchContextAggregations aggregations()

aggregations

public abstract SearchContext aggregations(SearchContextAggregations aggregations)

getFetchSubPhaseContext

public abstract <SubPhaseContext extends FetchSubPhaseContext> SubPhaseContext getFetchSubPhaseContext(FetchSubPhase.ContextFactory<SubPhaseContext> contextFactory)

highlight

public abstract SearchContextHighlight highlight()

highlight

public abstract void highlight(SearchContextHighlight highlight)

innerHits

public InnerHitsContext innerHits()

suggest

public abstract SuggestionSearchContext suggest()

suggest

public abstract void suggest(SuggestionSearchContext suggest)

rescore

public abstract List<RescoreSearchContext> rescore()

Returns:

list of all rescore contexts. empty if there aren't any.

addRescore

public abstract void addRescore(RescoreSearchContext rescore)

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)

searcher

public abstract ContextIndexSearcher searcher()

indexShard

public abstract IndexShard indexShard()

mapperService

public abstract MapperService mapperService()

analysisService

public abstract AnalysisService analysisService()

queryParserService

public abstract IndexQueryParserService queryParserService()

similarityService

public abstract SimilarityService similarityService()

scriptService

public abstract ScriptService scriptService()

pageCacheRecycler

public abstract PageCacheRecycler pageCacheRecycler()

bigArrays

public abstract BigArrays bigArrays()

bitsetFilterCache

public abstract BitsetFilterCache bitsetFilterCache()

fieldData

public abstract IndexFieldDataService fieldData()

timeoutInMillis

public abstract long timeoutInMillis()

timeoutInMillis

public abstract void timeoutInMillis(long timeoutInMillis)

terminateAfter

public abstract int terminateAfter()

terminateAfter

public abstract void terminateAfter(int terminateAfter)

minimumScore

public abstract SearchContext minimumScore(float minimumScore)

minimumScore

public abstract Float minimumScore()

sort

public abstract SearchContext sort(org.apache.lucene.search.Sort sort)

sort

public abstract org.apache.lucene.search.Sort sort()

trackScores

public abstract SearchContext trackScores(boolean trackScores)

trackScores

public abstract boolean trackScores()

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)

hasFieldNames

public abstract boolean hasFieldNames()

fieldNames

public abstract List<String> fieldNames()

emptyFieldNames

public abstract void emptyFieldNames()

explain

public abstract boolean explain()

explain

public abstract void explain(boolean explain)

groupStats

@Nullable
public abstract List<String> groupStats()

groupStats

public abstract void groupStats(List<String> groupStats)

version

public abstract boolean version()

version

public abstract void version(boolean version)

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)

accessed

public abstract void accessed(long accessTime)

lastAccessTime

public abstract long lastAccessTime()

keepAlive

public abstract long keepAlive()

keepAlive

public abstract void keepAlive(long keepAlive)

lookup

public abstract SearchLookup lookup()

dfsResult

public abstract DfsSearchResult dfsResult()

queryResult

public abstract QuerySearchResult queryResult()

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,
                 SearchContext.Lifetime lifetime)

Schedule the release of a resource. The time when Releasable.close() will be called on this object is function of the provided SearchContext.Lifetime.

clearReleasables

public void clearReleasables(SearchContext.Lifetime lifetime)

scanContext

public abstract ScanContext scanContext()

smartNameFieldType

public abstract MappedFieldType smartNameFieldType(String name)

smartNameFieldTypeFromAnyType

public abstract MappedFieldType smartNameFieldTypeFromAnyType(String name)

Looks up the given field, but does not restrict to fields in the types set on this context.

getObjectMapper

public abstract ObjectMapper getObjectMapper(String name)

timeEstimateCounter

public abstract org.apache.lucene.util.Counter timeEstimateCounter()

queryCollectors

public abstract Map<Class<?>,org.apache.lucene.search.Collector> queryCollectors()

Return a view of the additional query collectors that should be run for this context.

incRef

public final void incRef()

Description copied from interface: RefCounted

Increments the refCount of this instance.

Specified by:

incRef in interface RefCounted

See Also:

RefCounted.decRef(), RefCounted.tryIncRef()

tryIncRef

public final boolean tryIncRef()

Description copied from interface: RefCounted

Tries to increment the refCount of this instance. This method will return true iff the refCount was

Specified by:

tryIncRef in interface RefCounted

See Also:

RefCounted.decRef(), RefCounted.incRef()

decRef

public final void decRef()

Description copied from interface: RefCounted

Decreases the refCount of this instance. If the refCount drops to 0, then this instance is considered as closed and should not be used anymore.

Specified by:

decRef in interface RefCounted

See Also:

RefCounted.incRef()

alreadyClosed

protected void alreadyClosed()

refCount

public int refCount()

Returns the current reference count.