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

Modifier and Type Field Description

static java.lang.String TYPES_DEPRECATION_MESSAGE

Fields inherited from class org.elasticsearch.index.query.QueryRewriteContext
client, nowInMillis

Constructor Summary

Constructors
Constructor	Description
QueryShardContext(int shardId, IndexSettings indexSettings, BigArrays bigArrays, BitsetFilterCache bitsetFilterCache, java.util.function.BiFunction<MappedFieldType,java.lang.String,IndexFieldData<?>> indexFieldDataLookup, MapperService mapperService, 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)
`QueryShardContext(QueryShardContext source)`

Method Summary

Modifier and Type	Method	Description
`void`	`addNamedQuery(java.lang.String name, org.apache.lucene.search.Query query)`
`boolean`	`allowExpensiveQueries()`
`BigArrays`	`bigArrays()`	Return the `BigArrays` instance for this node.
`org.apache.lucene.search.join.BitSetProducer`	`bitsetFilter(org.apache.lucene.search.Query filter)`
`<FactoryType> FactoryType`	`compile(Script script, ScriptContext<FactoryType> context)`	Compile script using script service
`QueryShardContext`	`convertToShardContext()`	Returns an instance of `QueryShardContext` if available of null otherwise
`java.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 s `DocumentMapper` 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 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 `getClient()`
`BitsetFilterCache`	`getBitsetFilterCache()`
`Client`	`getClient()`
`<IFD extends IndexFieldData<?>> IFD`	`getForField(MappedFieldType fieldType)`
`Index`	`getFullyQualifiedIndex()`	Returns the fully qualified index including a remote cluster alias if applicable, and the index uuid
`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.
`MapperService`	`getMapperService()`	Return the MapperService.
`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
`org.apache.lucene.search.similarities.Similarity`	`getSearchSimilarity()`
`int`	`getShardId()`	Returns the shard ID this context was created for.
`SimilarityService`	`getSimilarityService()`
`java.lang.String[]`	`getTypes()`
`AggregationUsageService`	`getUsageService()`
`ValuesSourceRegistry`	`getValuesSourceRegistry()`
`Index`	`index()`
`boolean`	`indexMatches(java.lang.String pattern)`	Given an index pattern, checks whether it matches against the current shard.
`Version`	`indexVersionCreated()`
`boolean`	`isCacheable()`	Returns `true` iff the result of the processed search request is cacheable.
`SearchLookup`	`lookup()`
`NestedScope`	`nestedScope()`
`long`	`nowInMillis()`	Returns the time in milliseconds that is shared across all resources involved.
`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 current `IndexSearcher`, or `null` 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.
`ParsedQuery`	`toQuery(QueryBuilder queryBuilder)`

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

getWriteableRegistry, getXContentRegistry, hasAsyncActions

Methods inherited from class java.lang.Object

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

Field Details
- TYPES_DEPRECATION_MESSAGE
  
  public static final java.lang.String TYPES_DEPRECATION_MESSAGE
  
  See Also:
  
  Constant Field Values
Constructor Details
- QueryShardContext
  
  public QueryShardContext(int shardId, IndexSettings indexSettings, BigArrays bigArrays, BitsetFilterCache bitsetFilterCache, java.util.function.BiFunction<MappedFieldType,java.lang.String,IndexFieldData<?>> indexFieldDataLookup, MapperService mapperService, 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)
- QueryShardContext
  
  public QueryShardContext(QueryShardContext source)
Method Details
- 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()
- 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
  
  public <IFD extends IndexFieldData<?>> IFD getForField(MappedFieldType fieldType)
- 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()
- 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.
- 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
- getValuesSourceRegistry
  
  public ValuesSourceRegistry 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.
- lookup
  
  public SearchLookup lookup()
- nestedScope
  
  public NestedScope nestedScope()
- indexVersionCreated
  
  public Version 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.
- toQuery
  
  public ParsedQuery toQuery(QueryBuilder queryBuilder)
- index
  
  public Index index()
- compile
  
  public <FactoryType> FactoryType compile(Script script, ScriptContext<FactoryType> context)
  
  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 like getClient()
- 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.
- 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 class QueryRewriteContext
- 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 QueryRewriteContext
- isCacheable
  
  public final boolean isCacheable()
  
  Returns true iff the result of the processed search request is cacheable. Otherwise false
- getShardId
  
  public int getShardId()
  
  Returns the shard ID this context was created for.
- 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 class QueryRewriteContext
- getClient
  
  public Client getClient()
- parseInnerQueryBuilder
  
  public QueryBuilder parseInnerQueryBuilder(org.elasticsearch.common.xcontent.XContentParser parser) throws java.io.IOException
  
  Throws:
  
  java.io.IOException
- convertToShardContext
  
  public final QueryShardContext convertToShardContext()
  
  Description copied from class: QueryRewriteContext
  
  Returns an instance of QueryShardContext if available of null otherwise
  
  Overrides:
  
  convertToShardContext in class QueryRewriteContext
- getIndexSettings
  
  public IndexSettings getIndexSettings()
  
  Returns the index settings for this context. This might return null if the context has not index scope.
- getMapperService
  
  public MapperService getMapperService()
  
  Return the MapperService.
- getIndexReader
  
  public 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).
- searcher
  
  public org.apache.lucene.search.IndexSearcher searcher()
  
  Return the current IndexSearcher, or null if no index reader is available, for instance if this rewrite context is used to index queries (percolation).
- getFullyQualifiedIndex
  
  public Index getFullyQualifiedIndex()
  
  Returns the fully qualified index including a remote cluster alias if applicable, and the index uuid
- bigArrays
  
  public BigArrays bigArrays()
  
  Return the BigArrays instance for this node.
- getSimilarityService
  
  public SimilarityService getSimilarityService()
- getBitsetFilterCache
  
  public BitsetFilterCache getBitsetFilterCache()
- getUsageService
  
  public AggregationUsageService getUsageService()

Class QueryShardContext

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Details

Constructor Details

Method Details