Module org.elasticsearch.server

Package org.elasticsearch.index.query

Class FilteredSearchExecutionContext

java.lang.Object

org.elasticsearch.index.query.QueryRewriteContext

org.elasticsearch.index.query.SearchExecutionContext

org.elasticsearch.index.query.FilteredSearchExecutionContext

public class FilteredSearchExecutionContext
extends SearchExecutionContext

This is NOT a simple clone of the SearchExecutionContext. While it does "clone-esque" things, it delegates everything it can to the passed search execution context. Do NOT use this if you mean to clone the context as you are planning to make modifications

Field Summary

Fields inherited from class org.elasticsearch.index.query.QueryRewriteContext

allowedFields, allowExpensiveQueries, allowUnmappedFields, client, fullyQualifiedIndex, indexNameMatcher, indexSettings, mapperService, mappingLookup, mapUnmappedFieldAsString, nowInMillis, runtimeMappings, scriptService, valuesSourceRegistry, writeableRegistry

Constructor Summary

Constructors

Constructor	Description
FilteredSearchExecutionContext(SearchExecutionContext in)

Method Summary

Modifier and Type	Method	Description
void	addNamedQuery(String name, org.apache.lucene.search.Query query)
boolean	allowExpensiveQueries()
org.apache.lucene.search.join.BitSetProducer	bitsetFilter(org.apache.lucene.search.Query filter)
MappedFieldType	buildAnonymousFieldType(String type)	Given a type (eg.
<FactoryType> FactoryType	compile(Script script, ScriptContext<FactoryType> context)	Compile script using script service
boolean	containsBrokenAnalysis(String field)	Does the index analyzer for this field have token filters that may produce backwards offsets in term vectors
CoordinatorRewriteContext	convertToCoordinatorRewriteContext()	Returns an instance of CoordinatorRewriteContext if available or null otherwise
DataRewriteContext	convertToDataRewriteContext()	Returns an instance of DataRewriteContext if available or null otherwise
QueryRewriteContext	convertToIndexMetadataContext()
Map<String,org.apache.lucene.search.Query>	copyNamedQueries()
List<String>	defaultFields()
void	disableCache()	Marks this context as not cacheable.
void	executeAsyncActions(ActionListener listener)	Executes all registered async actions and notifies the listener once it's done.
boolean	fieldExistsInIndex(String fieldname)	Is this field present in the underlying lucene index for the current shard?
protected MappedFieldType	fieldType(String name)
Client	getClient()
org.apache.lucene.search.similarities.Similarity	getDefaultSimilarity()	The default similarity configured in the index settings.
MappedFieldType	getFieldType(String name)	Returns the MappedFieldType for the provided field name.
<IFD extends IndexFieldData<?>> IFD	getForField(MappedFieldType fieldType, MappedFieldType.FielddataOperation fielddataOperation)
Index	getFullyQualifiedIndex()	Returns the fully qualified index including a remote cluster alias if applicable, and the index uuid
org.apache.lucene.analysis.Analyzer	getIndexAnalyzer(Function<String,NamedAnalyzer> unindexedFieldAnalyzer)	Return the index-time analyzer for the current index
IndexAnalyzers	getIndexAnalyzers()
org.apache.lucene.index.IndexReader	getIndexReader()	Return the current IndexReader, or null if no index reader is available, for instance if this rewrite context is used to index queries (percolation).
IndexSettings	getIndexSettings()	Returns the index settings for this context.
Set<String>	getMatchingFieldNames(String pattern)	Returns the names of all mapped fields that match a given pattern All names returned by this method are guaranteed to resolve to a MappedFieldType if passed to QueryRewriteContext.getFieldType(String)
NestedDocuments	getNestedDocuments()
XContentParserConfiguration	getParserConfig()	The registry used to build new XContentParsers.
org.apache.lucene.search.similarities.Similarity	getSearchSimilarity()	The similarity to use in searches, which takes into account per-field configuration.
int	getShardId()	Returns the shard ID this context was created for.
int	getShardRequestIndex()	Returns the shard request ordinal that is used by the main search request to reference this shard.
ValuesSourceRegistry	getValuesSourceRegistry()
NamedWriteableRegistry	getWriteableRegistry()
boolean	hasAsyncActions()	Returns true if there are any registered async actions.
boolean	hasMappings()
Index	index()
boolean	indexMatches(String pattern)	Given an index pattern, checks whether it matches against the current shard.
boolean	indexSortedOnField(String field)
IndexVersion	indexVersionCreated()
boolean	isFieldMapped(String name)	Returns true if the field identified by the provided name is mapped, false otherwise
boolean	isMetadataField(String field)
boolean	isMultiField(String field)
boolean	isSourceEnabled()	Will there be _source.
boolean	isSourceSynthetic()	Does the source need to be rebuilt on the fly?
SearchLookup	lookup()	Get the lookup to use during the search.
MappingLookup.CacheKey	mappingCacheKey()	Cache key for current mapping.
NestedLookup	nestedLookup()
NestedScope	nestedScope()
SourceLoader	newSourceLoader(boolean forceSyntheticSource)	Build something to load source _source.
long	nowInMillis()	Returns the time in milliseconds that is shared across all resources involved.
ParsedDocument	parseDocument(SourceToParse source)	Parse a document with current mapping.
boolean	queryStringAllowLeadingWildcard()
boolean	queryStringAnalyzeWildcard()
boolean	queryStringLenient()
void	registerAsyncAction(BiConsumer<Client,ActionListener<?>> asyncAction)	Registers an async action that must be executed before the next rewrite round in order to make progress.
boolean	rewriteToNamedQuery()	Returns true if Elasticsearch queries with _name must be rewritten to Lucene NamedQuery
org.apache.lucene.search.IndexSearcher	searcher()	Return the current IndexSearcher, or null if no index reader is available, which happens if this rewrite context is used to index queries (percolation).
void	setAllowedFields(Predicate<String> allowedFields)
void	setAllowUnmappedFields(boolean allowUnmappedFields)
void	setLookupProviders(SourceProvider sourceProvider, Function<org.apache.lucene.index.LeafReaderContext,LeafFieldLookupProvider> fieldLookupProvider)	Replace the standard source provider and field lookup provider on the SearchLookup Note that this will replace the current SearchLookup with a new one, but will not update the source provider on previously build lookups.
void	setMapUnmappedFieldAsString(boolean mapUnmappedFieldAsString)
void	setRewriteToNamedQueries()	Instructs to rewrite Elasticsearch queries with _name to Lucene NamedQuery
Set<String>	sourcePath(String fullName)
ParsedQuery	toQuery(QueryBuilder queryBuilder)

Methods inherited from class org.elasticsearch.index.query.SearchExecutionContext

convertToSearchExecutionContext, dimensionFields, failIfFrozen, freezeContext, getAliasFilter, hasNamedQueries, isCacheable, parentPath, requestSize, setAliasFilter

Methods inherited from class org.elasticsearch.index.query.QueryRewriteContext

convertToInnerHitsRewriteContext, getAllFields, getMappingLookup

Methods inherited from class java.lang.Object

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

Constructor Details

FilteredSearchExecutionContext

public FilteredSearchExecutionContext(SearchExecutionContext in)

Method Details

getSearchSimilarity

public org.apache.lucene.search.similarities.Similarity getSearchSimilarity()

Description copied from class: SearchExecutionContext

The similarity to use in searches, which takes into account per-field configuration.

Overrides:

getSearchSimilarity in class SearchExecutionContext

getDefaultSimilarity

public org.apache.lucene.search.similarities.Similarity getDefaultSimilarity()

Description copied from class: SearchExecutionContext

The default similarity configured in the index settings.

Overrides:

getDefaultSimilarity in class SearchExecutionContext

defaultFields

public List<String> defaultFields()

Overrides:

defaultFields in class SearchExecutionContext

queryStringLenient

public boolean queryStringLenient()

Overrides:

queryStringLenient in class SearchExecutionContext

queryStringAnalyzeWildcard

public boolean queryStringAnalyzeWildcard()

Overrides:

queryStringAnalyzeWildcard in class SearchExecutionContext

queryStringAllowLeadingWildcard

public boolean queryStringAllowLeadingWildcard()

Overrides:

queryStringAllowLeadingWildcard in class SearchExecutionContext

bitsetFilter

public org.apache.lucene.search.join.BitSetProducer bitsetFilter(org.apache.lucene.search.Query filter)

Overrides:

bitsetFilter in class SearchExecutionContext

getForField

public <IFD extends IndexFieldData<?>> IFD getForField(MappedFieldType fieldType,
 MappedFieldType.FielddataOperation fielddataOperation)

Overrides:

getForField in class SearchExecutionContext

addNamedQuery

public void addNamedQuery(String name,
 org.apache.lucene.search.Query query)

Overrides:

addNamedQuery in class SearchExecutionContext

copyNamedQueries

public Map<String,org.apache.lucene.search.Query> copyNamedQueries()

Overrides:

copyNamedQueries in class SearchExecutionContext

parseDocument

public ParsedDocument parseDocument(SourceToParse source)
                             throws DocumentParsingException

Description copied from class: SearchExecutionContext

Parse a document with current mapping.

Overrides:

parseDocument in class SearchExecutionContext

Throws:

DocumentParsingException

nestedLookup

public NestedLookup nestedLookup()

Overrides:

nestedLookup in class SearchExecutionContext

hasMappings

public boolean hasMappings()

Overrides:

hasMappings in class SearchExecutionContext

isFieldMapped

public boolean isFieldMapped(String name)

Description copied from class: SearchExecutionContext

Returns true if the field identified by the provided name is mapped, false otherwise

Overrides:

isFieldMapped in class SearchExecutionContext

isMetadataField

public boolean isMetadataField(String field)

Overrides:

isMetadataField in class SearchExecutionContext

isMultiField

public boolean isMultiField(String field)

Overrides:

isMultiField in class SearchExecutionContext

sourcePath

public Set<String> sourcePath(String fullName)

Overrides:

sourcePath in class SearchExecutionContext

isSourceEnabled

public boolean isSourceEnabled()

Description copied from class: SearchExecutionContext

Will there be _source.

Overrides:

isSourceEnabled in class SearchExecutionContext

isSourceSynthetic

public boolean isSourceSynthetic()

Description copied from class: SearchExecutionContext

Does the source need to be rebuilt on the fly?

Overrides:

isSourceSynthetic in class SearchExecutionContext

newSourceLoader

public SourceLoader newSourceLoader(boolean forceSyntheticSource)

Description copied from class: SearchExecutionContext

Build something to load source _source.

Overrides:

newSourceLoader in class SearchExecutionContext

buildAnonymousFieldType

public MappedFieldType buildAnonymousFieldType(String type)

Description copied from class: SearchExecutionContext

Given a type (eg. long, string, ...), returns an anonymous field type that can be used for search operations. Generally used to handle unmapped fields in the context of sorting.

Overrides:

buildAnonymousFieldType in class SearchExecutionContext

getIndexAnalyzer

public org.apache.lucene.analysis.Analyzer getIndexAnalyzer(Function<String,NamedAnalyzer> unindexedFieldAnalyzer)

Description copied from class: SearchExecutionContext

Return the index-time analyzer for the current index

Overrides:

getIndexAnalyzer in class SearchExecutionContext

Parameters:

unindexedFieldAnalyzer - a function that builds an analyzer for unindexed fields

setAllowedFields

public void setAllowedFields(Predicate<String> allowedFields)

Overrides:

setAllowedFields in class SearchExecutionContext

containsBrokenAnalysis

public boolean containsBrokenAnalysis(String field)

Description copied from class: SearchExecutionContext

Does the index analyzer for this field have token filters that may produce backwards offsets in term vectors

Overrides:

containsBrokenAnalysis in class SearchExecutionContext

lookup

public SearchLookup lookup()

Description copied from class: SearchExecutionContext

Get the lookup to use during the search.

Overrides:

lookup in class SearchExecutionContext

setLookupProviders

public void setLookupProviders(SourceProvider sourceProvider,
 Function<org.apache.lucene.index.LeafReaderContext,LeafFieldLookupProvider> fieldLookupProvider)

Description copied from class: SearchExecutionContext

Replace the standard source provider and field lookup provider on the SearchLookup Note that this will replace the current SearchLookup with a new one, but will not update the source provider on previously build lookups. This method should only be called before IndexReader access by the current context

Overrides:

setLookupProviders in class SearchExecutionContext

nestedScope

public NestedScope nestedScope()

Overrides:

nestedScope in class SearchExecutionContext

indexVersionCreated

public IndexVersion indexVersionCreated()

Overrides:

indexVersionCreated in class SearchExecutionContext

indexSortedOnField

public boolean indexSortedOnField(String field)

Overrides:

indexSortedOnField in class SearchExecutionContext

toQuery

public ParsedQuery toQuery(QueryBuilder queryBuilder)

Overrides:

toQuery in class SearchExecutionContext

index

public Index index()

Overrides:

index in class SearchExecutionContext

compile

public <FactoryType> FactoryType compile(Script script,
 ScriptContext<FactoryType> context)

Description copied from class: SearchExecutionContext

Compile script using script service

Overrides:

compile in class SearchExecutionContext

disableCache

public void disableCache()

Description copied from class: SearchExecutionContext

Marks this context as not cacheable. This method fails if SearchExecutionContext.freezeContext() is called before on this context.

Overrides:

disableCache in class SearchExecutionContext

registerAsyncAction

public void registerAsyncAction(BiConsumer<Client,ActionListener<?>> asyncAction)

Description copied from class: QueryRewriteContext

Registers an async action that must be executed before the next rewrite round in order to make progress. This should be used if a rewriteable needs to fetch some external resources in order to be executed ie. a document from an index.

Overrides:

registerAsyncAction in class SearchExecutionContext

executeAsyncActions

public void executeAsyncActions(ActionListener listener)

Description copied from class: QueryRewriteContext

Executes all registered async actions and notifies the listener once it's done. The value that is passed to the listener is always null. The list of registered actions is cleared once this method returns.

Overrides:

executeAsyncActions in class SearchExecutionContext

getShardId

public int getShardId()

Description copied from class: SearchExecutionContext

Returns the shard ID this context was created for.

Overrides:

getShardId in class SearchExecutionContext

getShardRequestIndex

public int getShardRequestIndex()

Description copied from class: SearchExecutionContext

Returns the shard request ordinal that is used by the main search request to reference this shard.

Overrides:

getShardRequestIndex in class SearchExecutionContext

nowInMillis

public long nowInMillis()

Description copied from class: SearchExecutionContext

Returns the time in milliseconds that is shared across all resources involved. Even across shards and nodes.

Overrides:

nowInMillis in class SearchExecutionContext

getClient

public Client getClient()

Overrides:

getClient in class SearchExecutionContext

getIndexReader

public org.apache.lucene.index.IndexReader getIndexReader()

Description copied from class: SearchExecutionContext

Return the current IndexReader, or null if no index reader is available, for instance if this rewrite context is used to index queries (percolation).

Overrides:

getIndexReader in class SearchExecutionContext

searcher

public org.apache.lucene.search.IndexSearcher searcher()

Description copied from class: SearchExecutionContext

Return the current IndexSearcher, or null if no index reader is available, which happens if this rewrite context is used to index queries (percolation).

Overrides:

searcher in class SearchExecutionContext

fieldExistsInIndex

public boolean fieldExistsInIndex(String fieldname)

Description copied from class: SearchExecutionContext

Is this field present in the underlying lucene index for the current shard?

Overrides:

fieldExistsInIndex in class SearchExecutionContext

mappingCacheKey

public MappingLookup.CacheKey mappingCacheKey()

Description copied from class: SearchExecutionContext

Cache key for current mapping.

Overrides:

mappingCacheKey in class SearchExecutionContext

getNestedDocuments

public NestedDocuments getNestedDocuments()

Overrides:

getNestedDocuments in class SearchExecutionContext

getParserConfig

public XContentParserConfiguration getParserConfig()

Description copied from class: QueryRewriteContext

The registry used to build new XContentParsers. Contains registered named parsers needed to parse the query. Used by WrapperQueryBuilder

Overrides:

getParserConfig in class QueryRewriteContext

convertToCoordinatorRewriteContext

public CoordinatorRewriteContext convertToCoordinatorRewriteContext()

Description copied from class: QueryRewriteContext

Returns an instance of CoordinatorRewriteContext if available or null otherwise

Overrides:

convertToCoordinatorRewriteContext in class QueryRewriteContext

convertToIndexMetadataContext

public QueryRewriteContext convertToIndexMetadataContext()

Overrides:

convertToIndexMetadataContext in class QueryRewriteContext

Returns:

an QueryRewriteContext instance that is aware of the mapping and other index metadata or null otherwise.

convertToDataRewriteContext

public DataRewriteContext convertToDataRewriteContext()

Description copied from class: QueryRewriteContext

Returns an instance of DataRewriteContext if available or null otherwise

Overrides:

convertToDataRewriteContext in class QueryRewriteContext

getFieldType

public MappedFieldType getFieldType(String name)

Description copied from class: QueryRewriteContext

Returns the MappedFieldType for the provided field name. If the field is not mapped, the behaviour depends on the index.query.parse.allow_unmapped_fields setting, which defaults to true. In case unmapped fields are allowed, null is returned when the field is not mapped. In case unmapped fields are not allowed, either an exception is thrown or the field is automatically mapped as a text field.

Overrides:

getFieldType in class QueryRewriteContext

See Also:

• QueryRewriteContext.setAllowUnmappedFields(boolean)
• QueryRewriteContext.setMapUnmappedFieldAsString(boolean)

fieldType

protected MappedFieldType fieldType(String name)

Overrides:

fieldType in class QueryRewriteContext

getIndexAnalyzers

public IndexAnalyzers getIndexAnalyzers()

Overrides:

getIndexAnalyzers in class QueryRewriteContext

setAllowUnmappedFields

public void setAllowUnmappedFields(boolean allowUnmappedFields)

Overrides:

setAllowUnmappedFields in class QueryRewriteContext

setMapUnmappedFieldAsString

public void setMapUnmappedFieldAsString(boolean mapUnmappedFieldAsString)

Overrides:

setMapUnmappedFieldAsString in class QueryRewriteContext

getWriteableRegistry

public NamedWriteableRegistry getWriteableRegistry()

Overrides:

getWriteableRegistry in class QueryRewriteContext

getValuesSourceRegistry

public ValuesSourceRegistry getValuesSourceRegistry()

Overrides:

getValuesSourceRegistry in class QueryRewriteContext

allowExpensiveQueries

public boolean allowExpensiveQueries()

Overrides:

allowExpensiveQueries in class QueryRewriteContext

hasAsyncActions

public boolean hasAsyncActions()

Description copied from class: QueryRewriteContext

Returns true if there are any registered async actions.

Overrides:

hasAsyncActions in class QueryRewriteContext

getFullyQualifiedIndex

public Index getFullyQualifiedIndex()

Description copied from class: QueryRewriteContext

Returns the fully qualified index including a remote cluster alias if applicable, and the index uuid

Overrides:

getFullyQualifiedIndex in class QueryRewriteContext

getIndexSettings

public IndexSettings getIndexSettings()

Description copied from class: QueryRewriteContext

Returns the index settings for this context. This might return null if the context has not index scope.

Overrides:

getIndexSettings in class QueryRewriteContext

indexMatches

public boolean indexMatches(String pattern)

Description copied from class: QueryRewriteContext

Given an index pattern, checks whether it matches against the current shard. The pattern may represent a fully qualified index name if the search targets remote shards.

Overrides:

indexMatches in class QueryRewriteContext

getMatchingFieldNames

public Set<String> getMatchingFieldNames(String pattern)

Description copied from class: QueryRewriteContext

Returns the names of all mapped fields that match a given pattern All names returned by this method are guaranteed to resolve to a MappedFieldType if passed to QueryRewriteContext.getFieldType(String)

Overrides:

getMatchingFieldNames in class QueryRewriteContext

Parameters:

pattern - the field name pattern

setRewriteToNamedQueries

public void setRewriteToNamedQueries()

Description copied from class: SearchExecutionContext

Instructs to rewrite Elasticsearch queries with _name to Lucene NamedQuery

Overrides:

setRewriteToNamedQueries in class SearchExecutionContext

rewriteToNamedQuery

public boolean rewriteToNamedQuery()

Description copied from class: SearchExecutionContext

Returns true if Elasticsearch queries with _name must be rewritten to Lucene NamedQuery

Overrides:

rewriteToNamedQuery in class SearchExecutionContext

Returns: