Package org.elasticsearch.index.query
Class SearchExecutionContext
java.lang.Object
org.elasticsearch.index.query.QueryRewriteContext
org.elasticsearch.index.query.SearchExecutionContext
public class SearchExecutionContext extends QueryRewriteContext
The context used to execute a search request on a shard. It provides access
to required information like mapping definitions and document data.
This context is used in several components of search execution, including
building queries and fetching hits.
-
Field Summary
Fields inherited from class org.elasticsearch.index.query.QueryRewriteContext
client, nowInMillis
-
Constructor Summary
Constructors Constructor Description SearchExecutionContext(int shardId, int shardRequestIndex, IndexSettings indexSettings, BitsetFilterCache bitsetFilterCache, TriFunction<MappedFieldType,java.lang.String,java.util.function.Supplier<SearchLookup>,IndexFieldData<?>> indexFieldDataLookup, MapperService mapperService, MappingLookup mappingLookup, SimilarityService similarityService, ScriptService scriptService, org.elasticsearch.common.xcontent.NamedXContentRegistry xContentRegistry, NamedWriteableRegistry namedWriteableRegistry, Client client, org.apache.lucene.search.IndexSearcher searcher, java.util.function.LongSupplier nowInMillis, java.lang.String clusterAlias, java.util.function.Predicate<java.lang.String> indexNameMatcher, java.util.function.BooleanSupplier allowExpensiveQueries, ValuesSourceRegistry valuesSourceRegistry, java.util.Map<java.lang.String,java.lang.Object> runtimeMappings)
Build a SearchExecutionContext.SearchExecutionContext(SearchExecutionContext source)
-
Method Summary
Modifier and Type Method Description void
addNamedQuery(java.lang.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(java.lang.String type)
Given a type (eg.<FactoryType>
FactoryTypecompile(Script script, ScriptContext<FactoryType> context)
Compile script using script serviceboolean
containsBrokenAnalysis(java.lang.String field)
Does the index analyzer for this field have token filters that may produce backwards offsets in term vectorsSearchExecutionContext
convertToSearchExecutionContext()
Returns an instance ofSearchExecutionContext
if available of null otherwisejava.util.Map<java.lang.String,org.apache.lucene.search.Query>
copyNamedQueries()
java.util.List<java.lang.String>
defaultFields()
DocumentMapper
documentMapper(java.lang.String type)
Returns sDocumentMapper
instance for the given type.void
executeAsyncActions(ActionListener listener)
Executes all registered async actions and notifies the listener once it's done.protected void
failIfFrozen()
This method fails iffreezeContext()
is called before on this context.void
freezeContext()
if this method is called the query context will throw exception if methods are accessed that could yield different results across executions likegetClient()
Client
getClient()
MappedFieldType
getFieldType(java.lang.String name)
Returns theMappedFieldType
for the provided field name.java.util.Collection<MappedFieldType>
getFieldTypes()
Returns the registered mapped field types.<IFD extends IndexFieldData<?>>
IFDgetForField(MappedFieldType fieldType)
Index
getFullyQualifiedIndex()
Returns the fully qualified index including a remote cluster alias if applicable, and the index uuidorg.apache.lucene.analysis.Analyzer
getIndexAnalyzer(java.util.function.Function<java.lang.String,NamedAnalyzer> unindexedFieldAnalyzer)
Return the index-time analyzer for the current indexIndexAnalyzers
getIndexAnalyzers()
org.apache.lucene.index.IndexReader
getIndexReader()
Return the currentIndexReader
, ornull
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.NestedDocuments
getNestedDocuments()
java.lang.String
getNestedParent(java.lang.String nestedPath)
Given a nested object path, returns the path to its nested parent In particular, if a nested field `foo` contains an object field `bar.baz`, then calling this method with `foo.bar.baz` will return the path `foo`, skipping over the object-but-not-nested `foo.bar`ObjectMapper
getObjectMapper(java.lang.String name)
org.apache.lucene.search.similarities.Similarity
getSearchSimilarity()
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.java.lang.String
getType()
java.lang.String[]
getTypes()
ValuesSourceRegistry
getValuesSourceRegistry()
boolean
hasMappings()
boolean
hasNested()
Index
index()
boolean
indexMatches(java.lang.String pattern)
Given an index pattern, checks whether it matches against the current shard.boolean
indexSortedOnField(java.lang.String field)
Version
indexVersionCreated()
boolean
isCacheable()
Returnstrue
iff the result of the processed search request is cacheable.boolean
isFieldMapped(java.lang.String name)
Returns true if the field identified by the provided name is mapped, false otherwiseboolean
isMetadataField(java.lang.String field)
boolean
isSourceEnabled()
SearchLookup
lookup()
Get the lookup to use during the search.MappingLookup.CacheKey
mappingCacheKey()
Cache key for current mapping.java.util.List<ObjectMapper>
nestedMappings()
NestedScope
nestedScope()
long
nowInMillis()
Returns the time in milliseconds that is shared across all resources involved.ParsedDocument
parseDocument(SourceToParse source)
Parse a document with current mapping.QueryBuilder
parseInnerQueryBuilder(org.elasticsearch.common.xcontent.XContentParser parser)
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
registerAsyncAction(java.util.function.BiConsumer<Client,ActionListener<?>> asyncAction)
Registers an async action that must be executed before the next rewrite round in order to make progress.org.apache.lucene.search.IndexSearcher
searcher()
Return the currentIndexSearcher
, ornull
if no index reader is available, for instance if this rewrite context is used to index queries (percolation).void
setAllowUnmappedFields(boolean allowUnmappedFields)
void
setMapUnmappedFieldAsString(boolean mapUnmappedFieldAsString)
void
setTypes(java.lang.String... types)
java.util.Set<java.lang.String>
simpleMatchToIndexNames(java.lang.String pattern)
Returns all the fields that match a given pattern.java.util.Set<java.lang.String>
sourcePath(java.lang.String fullName)
ParsedQuery
toQuery(QueryBuilder queryBuilder)
Methods inherited from class org.elasticsearch.index.query.QueryRewriteContext
convertToCoordinatorRewriteContext, getWriteableRegistry, getXContentRegistry, hasAsyncActions
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Constructor Details
-
SearchExecutionContext
public SearchExecutionContext(int shardId, int shardRequestIndex, IndexSettings indexSettings, BitsetFilterCache bitsetFilterCache, TriFunction<MappedFieldType,java.lang.String,java.util.function.Supplier<SearchLookup>,IndexFieldData<?>> indexFieldDataLookup, MapperService mapperService, MappingLookup mappingLookup, SimilarityService similarityService, ScriptService scriptService, org.elasticsearch.common.xcontent.NamedXContentRegistry xContentRegistry, NamedWriteableRegistry namedWriteableRegistry, Client client, org.apache.lucene.search.IndexSearcher searcher, java.util.function.LongSupplier nowInMillis, java.lang.String clusterAlias, java.util.function.Predicate<java.lang.String> indexNameMatcher, java.util.function.BooleanSupplier allowExpensiveQueries, ValuesSourceRegistry valuesSourceRegistry, java.util.Map<java.lang.String,java.lang.Object> runtimeMappings)Build a SearchExecutionContext. -
SearchExecutionContext
-
-
Method Details
-
setTypes
public void setTypes(java.lang.String... types) -
getTypes
public java.lang.String[] getTypes() -
getSearchSimilarity
public org.apache.lucene.search.similarities.Similarity getSearchSimilarity() -
defaultFields
public java.util.List<java.lang.String> defaultFields() -
queryStringLenient
public boolean queryStringLenient() -
queryStringAnalyzeWildcard
public boolean queryStringAnalyzeWildcard() -
queryStringAllowLeadingWildcard
public boolean queryStringAllowLeadingWildcard() -
bitsetFilter
public org.apache.lucene.search.join.BitSetProducer bitsetFilter(org.apache.lucene.search.Query filter) -
allowExpensiveQueries
public boolean allowExpensiveQueries() -
getForField
-
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() -
parseDocument
Parse a document with current mapping.- Throws:
MapperParsingException
-
hasNested
public boolean hasNested() -
hasMappings
public boolean hasMappings() -
nestedMappings
-
simpleMatchToIndexNames
public java.util.Set<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. -
getFieldType
Returns theMappedFieldType
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.- Throws:
QueryShardException
- if unmapped fields are not allowed and automatically mapping unmapped fields as text is disabled.- See Also:
setAllowUnmappedFields(boolean)
,setMapUnmappedFieldAsString(boolean)
-
getFieldTypes
Returns the registered mapped field types. -
isFieldMapped
public boolean isFieldMapped(java.lang.String name)Returns true if the field identified by the provided name is mapped, false otherwise -
getObjectMapper
-
isMetadataField
public boolean isMetadataField(java.lang.String field) -
sourcePath
public java.util.Set<java.lang.String> sourcePath(java.lang.String fullName) -
isSourceEnabled
public boolean isSourceEnabled() -
documentMapper
Returns sDocumentMapper
instance for the given type. Delegates toMapperService.documentMapper(String)
-
buildAnonymousFieldType
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. -
getIndexAnalyzers
-
getIndexAnalyzer
public org.apache.lucene.analysis.Analyzer getIndexAnalyzer(java.util.function.Function<java.lang.String,NamedAnalyzer> unindexedFieldAnalyzer)Return the index-time analyzer for the current index- Parameters:
unindexedFieldAnalyzer
- a function that builds an analyzer for unindexed fields
-
getValuesSourceRegistry
-
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. -
containsBrokenAnalysis
public boolean containsBrokenAnalysis(java.lang.String field)Does the index analyzer for this field have token filters that may produce backwards offsets in term vectors -
lookup
Get the lookup to use during the search. -
nestedScope
-
indexVersionCreated
-
indexMatches
public boolean indexMatches(java.lang.String pattern)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. -
indexSortedOnField
public boolean indexSortedOnField(java.lang.String field) -
toQuery
-
index
-
compile
Compile script using script service -
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 likegetClient()
-
failIfFrozen
protected final void failIfFrozen()This method fails iffreezeContext()
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. -
registerAsyncAction
public void registerAsyncAction(java.util.function.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 rewriteabel needs to fetch some external resources in order to be executed ie. a document from an index.- Overrides:
registerAsyncAction
in classQueryRewriteContext
-
executeAsyncActions
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 alwaysnull
. The list of registered actions is cleared once this method returns.- Overrides:
executeAsyncActions
in classQueryRewriteContext
-
isCacheable
public final boolean isCacheable()Returnstrue
iff the result of the processed search request is cacheable. Otherwisefalse
-
getShardId
public int getShardId()Returns the shard ID this context was created for. -
getShardRequestIndex
public int getShardRequestIndex()Returns the shard request ordinal that is used by the main search request to reference this shard. -
nowInMillis
public final long nowInMillis()Description copied from class:QueryRewriteContext
Returns the time in milliseconds that is shared across all resources involved. Even across shards and nodes.- Overrides:
nowInMillis
in classQueryRewriteContext
-
getClient
-
parseInnerQueryBuilder
public QueryBuilder parseInnerQueryBuilder(org.elasticsearch.common.xcontent.XContentParser parser) throws java.io.IOException- Throws:
java.io.IOException
-
convertToSearchExecutionContext
Description copied from class:QueryRewriteContext
Returns an instance ofSearchExecutionContext
if available of null otherwise- Overrides:
convertToSearchExecutionContext
in classQueryRewriteContext
-
getIndexSettings
Returns the index settings for this context. This might return null if the context has not index scope. -
getType
public java.lang.String getType() -
getIndexReader
public org.apache.lucene.index.IndexReader getIndexReader()Return the currentIndexReader
, ornull
if no index reader is available, for instance if this rewrite context is used to index queries (percolation). -
searcher
public org.apache.lucene.search.IndexSearcher searcher()Return the currentIndexSearcher
, ornull
if no index reader is available, for instance if this rewrite context is used to index queries (percolation). -
getFullyQualifiedIndex
Returns the fully qualified index including a remote cluster alias if applicable, and the index uuid -
mappingCacheKey
Cache key for current mapping. -
getNestedParent
public java.lang.String getNestedParent(java.lang.String nestedPath)Given a nested object path, returns the path to its nested parent In particular, if a nested field `foo` contains an object field `bar.baz`, then calling this method with `foo.bar.baz` will return the path `foo`, skipping over the object-but-not-nested `foo.bar` -
getNestedDocuments
-