org.elasticsearch.index.query

Class QueryShardContext

java.lang.Object

org.elasticsearch.index.query.QueryRewriteContext

org.elasticsearch.index.query.QueryShardContext

public class QueryShardContext
extends QueryRewriteContext

Context object used to create lucene queries on the shard level.

Field Summary

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

client, nowInMillis, reader, scriptService

Constructor Summary

Constructors

Constructor and Description
QueryShardContext(int shardId, IndexSettings indexSettings, BitsetFilterCache bitsetFilterCache, IndexFieldDataService indexFieldDataService, MapperService mapperService, SimilarityService similarityService, ScriptService scriptService, NamedXContentRegistry xContentRegistry, Client client, org.apache.lucene.index.IndexReader reader, java.util.function.LongSupplier nowInMillis)
QueryShardContext(QueryShardContext source)

Method Summary

Modifier and Type	Method and Description
void	addNamedQuery(java.lang.String name, org.apache.lucene.search.Query query)
org.apache.lucene.search.join.BitSetProducer	bitsetFilter(org.apache.lucene.search.Query filter)
java.util.Map<java.lang.String,org.apache.lucene.search.Query>	copyNamedQueries()
java.lang.String	defaultField()
DocumentMapper	documentMapper(java.lang.String type) Returns s DocumentMapper instance for the given type.
protected void	failIfFrozen() This method fails if freezeContext() is called before on this context.
MappedFieldType	fieldMapper(java.lang.String name)
void	freezeContext() if this method is called the query context will throw exception if methods are accessed that could yield different results across executions like getTemplateBytes(Script)
Client	getClient() Returns a clients to fetch resources from local or remove nodes.
ExecutableScript	getExecutableScript(Script script, ScriptContext context) Compiles (or retrieves from cache) and binds the parameters to the provided script
<IFD extends IndexFieldData<?>> IFD	getForField(MappedFieldType mapper)
IndexAnalyzers	getIndexAnalyzers()
java.util.function.Function<java.util.Map<java.lang.String,java.lang.Object>,ExecutableScript>	getLazyExecutableScript(Script script, ScriptContext context) Returns a lazily created ExecutableScript that is compiled immediately but can be pulled later once all parameters are available.
java.util.function.Function<java.util.Map<java.lang.String,java.lang.Object>,SearchScript>	getLazySearchScript(Script script, ScriptContext context) Returns a lazily created SearchScript that is compiled immediately but can be pulled later once all parameters are available.
ObjectMapper	getObjectMapper(java.lang.String name)
org.apache.lucene.analysis.Analyzer	getSearchAnalyzer(MappedFieldType fieldType) Gets the search analyzer for the given field, or the default if there is none present for the field TODO: remove this by moving defaults into mappers themselves
org.apache.lucene.analysis.Analyzer	getSearchQuoteAnalyzer(MappedFieldType fieldType) Gets the search quote analyzer for the given field, or the default if there is none present for the field TODO: remove this by moving defaults into mappers themselves
SearchScript	getSearchScript(Script script, ScriptContext context) Compiles (or retrieves from cache) and binds the parameters to the provided script
org.apache.lucene.search.similarities.Similarity	getSearchSimilarity()
int	getShardId() Returns the shard ID this context was created for.
BytesReference	getTemplateBytes(Script template)
java.lang.String[]	getTypes()
Index	index()
Version	indexVersionCreated()
boolean	isCachable() Returns true iff the result of the processed search request is cachable.
boolean	isFilter() Return whether we are currently parsing a filter or a query.
SearchLookup	lookup()
boolean	matchesIndices(java.lang.String... indices)
NestedScope	nestedScope()
long	nowInMillis()
MapperQueryParser	queryParser(QueryParserSettings settings)
boolean	queryStringAllowLeadingWildcard()
boolean	queryStringAnalyzeWildcard()
boolean	queryStringLenient()
java.util.Collection<java.lang.String>	queryTypes() Returns the narrowed down explicit types, or, if not set, all types.
void	setAllowUnmappedFields(boolean allowUnmappedFields)
void	setIsFilter(boolean isFilter) Public for testing only! Sets whether we are currently parsing a filter or a query
void	setMapUnmappedFieldAsString(boolean mapUnmappedFieldAsString)
void	setTypes(java.lang.String... types)
java.util.Collection<java.lang.String>	simpleMatchToIndexNames(java.lang.String pattern) Returns all the fields that match a given pattern.
ParsedQuery	toFilter(QueryBuilder queryBuilder)
ParsedQuery	toQuery(QueryBuilder queryBuilder)

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

getIndexReader, getIndexSettings, getMapperService, getXContentRegistry, newParseContext, newParseContextWithLegacyScriptLanguage

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryShardContext

public QueryShardContext(int shardId,
                         IndexSettings indexSettings,
                         BitsetFilterCache bitsetFilterCache,
                         IndexFieldDataService indexFieldDataService,
                         MapperService mapperService,
                         SimilarityService similarityService,
                         ScriptService scriptService,
                         NamedXContentRegistry xContentRegistry,
                         Client client,
                         org.apache.lucene.index.IndexReader reader,
                         java.util.function.LongSupplier nowInMillis)

QueryShardContext

public QueryShardContext(QueryShardContext source)

Method Detail

setTypes

public void setTypes(java.lang.String... types)

getTypes

public java.lang.String[] getTypes()

getIndexAnalyzers

public IndexAnalyzers getIndexAnalyzers()

getSearchSimilarity

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

defaultField

public java.lang.String defaultField()

queryStringLenient

public boolean queryStringLenient()

queryStringAnalyzeWildcard

public boolean queryStringAnalyzeWildcard()

queryStringAllowLeadingWildcard

public boolean queryStringAllowLeadingWildcard()

queryParser

public MapperQueryParser queryParser(QueryParserSettings settings)

bitsetFilter

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

getForField

public <IFD extends IndexFieldData<?>> IFD getForField(MappedFieldType mapper)

addNamedQuery

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

copyNamedQueries

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

isFilter

public boolean isFilter()

Return whether we are currently parsing a filter or a query.

setIsFilter

public void setIsFilter(boolean isFilter)

Public for testing only! Sets whether we are currently parsing a filter or a query

simpleMatchToIndexNames

public java.util.Collection<java.lang.String> simpleMatchToIndexNames(java.lang.String pattern)

Returns all the fields that match a given pattern. If prefixed with a type then the fields will be returned with a type prefix.

fieldMapper

public MappedFieldType fieldMapper(java.lang.String name)

getObjectMapper

public ObjectMapper getObjectMapper(java.lang.String name)

documentMapper

public DocumentMapper documentMapper(java.lang.String type)

Returns s DocumentMapper instance for the given type. Delegates to MapperService.documentMapper(String)

getSearchAnalyzer

public org.apache.lucene.analysis.Analyzer getSearchAnalyzer(MappedFieldType fieldType)

Gets the search analyzer for the given field, or the default if there is none present for the field TODO: remove this by moving defaults into mappers themselves

getSearchQuoteAnalyzer

public org.apache.lucene.analysis.Analyzer getSearchQuoteAnalyzer(MappedFieldType fieldType)

Gets the search quote analyzer for the given field, or the default if there is none present for the field TODO: remove this by moving defaults into mappers themselves

setAllowUnmappedFields

public void setAllowUnmappedFields(boolean allowUnmappedFields)

setMapUnmappedFieldAsString

public void setMapUnmappedFieldAsString(boolean mapUnmappedFieldAsString)

queryTypes

public java.util.Collection<java.lang.String> queryTypes()

Returns the narrowed down explicit types, or, if not set, all types.

lookup

public SearchLookup lookup()

nestedScope

public NestedScope nestedScope()

indexVersionCreated

public Version indexVersionCreated()

matchesIndices

public boolean matchesIndices(java.lang.String... indices)

toFilter

public ParsedQuery toFilter(QueryBuilder queryBuilder)

toQuery

public ParsedQuery toQuery(QueryBuilder queryBuilder)

index

public final Index index()

getSearchScript

public final SearchScript getSearchScript(Script script,
                                          ScriptContext context)

Compiles (or retrieves from cache) and binds the parameters to the provided script

getLazySearchScript

public final java.util.function.Function<java.util.Map<java.lang.String,java.lang.Object>,SearchScript> getLazySearchScript(Script script,
                                                                                                                            ScriptContext context)

Returns a lazily created SearchScript that is compiled immediately but can be pulled later once all parameters are available.

getExecutableScript

public final ExecutableScript getExecutableScript(Script script,
                                                  ScriptContext context)

Compiles (or retrieves from cache) and binds the parameters to the provided script

getLazyExecutableScript

public final java.util.function.Function<java.util.Map<java.lang.String,java.lang.Object>,ExecutableScript> getLazyExecutableScript(Script script,
                                                                                                                                    ScriptContext context)

Returns a lazily created ExecutableScript that is compiled immediately but can be pulled later once all parameters are available.

freezeContext

public final void freezeContext()

if this method is called the query context will throw exception if methods are accessed that could yield different results across executions like getTemplateBytes(Script)

failIfFrozen

protected final void failIfFrozen()

This method fails if freezeContext() is called before on this context. This is used to seal. This methods and all methods that call it should be final to ensure that setting the request as not cacheable and the freezing behaviour of this class cannot be bypassed. This is important so we can trust when this class says a request can be cached.

getTemplateBytes

public final BytesReference getTemplateBytes(Script template)

Overrides:

getTemplateBytes in class QueryRewriteContext

isCachable

public final boolean isCachable()

Returns true iff the result of the processed search request is cachable. Otherwise false

getShardId

public int getShardId()

Returns the shard ID this context was created for.

nowInMillis

public final long nowInMillis()

Overrides:

nowInMillis in class QueryRewriteContext

getClient

public Client getClient()

Description copied from class: QueryRewriteContext

Returns a clients to fetch resources from local or remove nodes.

Overrides:

getClient in class QueryRewriteContext