Module org.elasticsearch.server

Package org.elasticsearch.search.aggregations.support

Class AggregationContext.ProductionAggregationContext

java.lang.Object

org.elasticsearch.search.aggregations.support.AggregationContext

org.elasticsearch.search.aggregations.support.AggregationContext.ProductionAggregationContext

All Implemented Interfaces:

Closeable, AutoCloseable, Releasable

Enclosing class:

AggregationContext

public static class AggregationContext.ProductionAggregationContext
extends AggregationContext

Implementation of AggregationContext for production usage that wraps our ubiquitous SearchExecutionContext and anything else specific to aggregations. Unit tests should generally avoid using this because it requires a huge portion of a real Elasticsearch node.

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.search.aggregations.support.AggregationContext

AggregationContext.ProductionAggregationContext

Constructor Summary

Constructors

Constructor

Description

ProductionAggregationContext(AnalysisRegistry analysisRegistry, SearchExecutionContext context, BigArrays bigArrays, long bytesToPreallocate, Supplier<org.apache.lucene.search.Query> topLevelQuery, AggregationProfiler profiler, MultiBucketConsumerService.MultiBucketConsumer multiBucketConsumer, Supplier<SubSearchContext> subSearchContextBuilder, BitsetFilterCache bitsetFilterCache, int randomSeed, LongSupplier relativeTimeInMillis, Supplier<Boolean> isCancelled, Function<org.apache.lucene.search.Query,org.apache.lucene.search.Query> filterQuery, boolean enableRewriteToFilterByFilter, boolean inSortOrderExecutionRequired)

Method Summary

Modifier and Type	Method	Description
void	addReleasable(Aggregator aggregator)	Cause this aggregation to be released when the search is finished.
BigArrays	bigArrays()	Utility to share and track large arrays.
BitsetFilterCache	bitsetFilterCache()	Get the filter cache.
CircuitBreaker	breaker()	The circuit breaker used to account for aggs.
BucketedSort	buildBucketedSort(SortBuilder<?> sort, int bucketSize, BucketedSort.ExtraData extra)	Build a collector for sorted values specialized for aggregations.
org.apache.lucene.analysis.Analyzer	buildCustomAnalyzer(IndexSettings indexSettings, boolean normalizer, NameOrDefinition tokenizer, List<NameOrDefinition> charFilters, List<NameOrDefinition> tokenFilters)	Creates a new custom analyzer that should be closed when finished being used.
protected IndexFieldData<?>	buildFieldData(MappedFieldType ft)	Build field data.
org.apache.lucene.search.Query	buildQuery(QueryBuilder builder)	Build a query.
Optional<SortAndFormats>	buildSort(List<SortBuilder<?>> sortBuilders)	Compile a sort.
void	close()
<FactoryType> FactoryType	compile(Script script, ScriptContext<FactoryType> scriptContext)	Compile a script.
boolean	enableRewriteToFilterByFilter()	Are aggregations allowed to try to rewrite themselves into FilterByFilterAggregator aggregations? Often FilterByFilterAggregator is faster to execute, but it isn't always.
org.apache.lucene.search.Query	filterQuery(org.apache.lucene.search.Query query)	Add filters from slice or filtered aliases.
MappedFieldType	getFieldType(String path)	Lookup a MappedFieldType by path.
org.apache.lucene.analysis.Analyzer	getIndexAnalyzer(Function<String,NamedAnalyzer> unindexedFieldAnalyzer)	Return the index-time analyzer for the current index
IndexSettings	getIndexSettings()	The settings for the index against which this search is running.
Set<String>	getMatchingFieldNames(String pattern)	Returns a set of field names that match a regex-like pattern All field names in the returned set are guaranteed to resolve to a field
org.apache.lucene.analysis.Analyzer	getNamedAnalyzer(String analyzer)	Returns an existing registered analyzer that should NOT be closed when finished being used.
long	getRelativeTimeInMillis()	How many millis have passed since we started the search?
ValuesSourceRegistry	getValuesSourceRegistry()	The ValuesSourceRegistry to resolve Aggregators and the like.
boolean	isCacheable()	Is this request cacheable? Requests that have non-deterministic queries or scripts aren't cachable.
boolean	isCancelled()	Has the search been cancelled?
boolean	isFieldMapped(String field)	Returns true if the field identified by the provided name is mapped, false otherwise
boolean	isInSortOrderExecutionRequired()	Return true if any of the aggregations in this context is a time-series aggregation that requires an in-sort order execution.
SearchLookup	lookup()	Fetch the shared SearchLookup.
MultiBucketConsumerService.MultiBucketConsumer	multiBucketConsumer()
NestedLookup	nestedLookup()	Get the NestedLookup of this index
NestedScope	nestedScope()	Access the nested scope.
long	nowInMillis()	The time in milliseconds that is shared across all resources involved.
Aggregator	profileIfEnabled(Aggregator agg)	Wrap the aggregator for profiling if profiling is enabled.
boolean	profiling()	Are we profiling the aggregation?
org.apache.lucene.search.Query	query()	The query at the top level of the search in which these aggregations are running.
org.apache.lucene.search.IndexSearcher	searcher()	The searcher that will execute this query.
int	shardRandomSeed()	Get a deterministic random seed based for this particular shard.
Set<String>	sourcePath(String fullName)
SubSearchContext	subSearchContext()	Build a SubSearchContext to power an aggregation fetching top hits.

Methods inherited from class org.elasticsearch.search.aggregations.support.AggregationContext

buildFieldContext, buildFieldContext, getUsageService, hasDocCountField

Methods inherited from class java.lang.Object

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

Constructor Details

ProductionAggregationContext

public ProductionAggregationContext(AnalysisRegistry analysisRegistry,
 SearchExecutionContext context,
 BigArrays bigArrays,
 long bytesToPreallocate,
 Supplier<org.apache.lucene.search.Query> topLevelQuery,
 @Nullable
 AggregationProfiler profiler,
 MultiBucketConsumerService.MultiBucketConsumer multiBucketConsumer,
 Supplier<SubSearchContext> subSearchContextBuilder,
 BitsetFilterCache bitsetFilterCache,
 int randomSeed,
 LongSupplier relativeTimeInMillis,
 Supplier<Boolean> isCancelled,
 Function<org.apache.lucene.search.Query,org.apache.lucene.search.Query> filterQuery,
 boolean enableRewriteToFilterByFilter,
 boolean inSortOrderExecutionRequired)

Method Details

query

public org.apache.lucene.search.Query query()

Description copied from class: AggregationContext

The query at the top level of the search in which these aggregations are running.

Specified by:

query in class AggregationContext

profileIfEnabled

public Aggregator profileIfEnabled(Aggregator agg)
                            throws IOException

Description copied from class: AggregationContext

Wrap the aggregator for profiling if profiling is enabled.

Specified by:

profileIfEnabled in class AggregationContext

Throws:

IOException

profiling

public boolean profiling()

Description copied from class: AggregationContext

Are we profiling the aggregation?

Specified by:

profiling in class AggregationContext

nowInMillis

public long nowInMillis()

Description copied from class: AggregationContext

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

Specified by:

nowInMillis in class AggregationContext

getNamedAnalyzer

public org.apache.lucene.analysis.Analyzer getNamedAnalyzer(String analyzer)
                                                     throws IOException

Description copied from class: AggregationContext

Returns an existing registered analyzer that should NOT be closed when finished being used.

Specified by:

getNamedAnalyzer in class AggregationContext

Parameters:

analyzer - The custom analyzer name

Returns:

The existing named analyzer.

Throws:

IOException

buildCustomAnalyzer

public org.apache.lucene.analysis.Analyzer buildCustomAnalyzer(IndexSettings indexSettings,
 boolean normalizer,
 NameOrDefinition tokenizer,
 List<NameOrDefinition> charFilters,
 List<NameOrDefinition> tokenFilters)
                                                        throws IOException

Description copied from class: AggregationContext

Creates a new custom analyzer that should be closed when finished being used.

Specified by:

buildCustomAnalyzer in class AggregationContext

Parameters:

indexSettings - The current index settings or null

normalizer - Is a normalizer

tokenizer - The tokenizer name or definition to use

charFilters - The char filter name or definition to use

tokenFilters - The token filter name or definition to use

Returns:

A new custom analyzer

Throws:

IOException

buildFieldData

protected IndexFieldData<?> buildFieldData(MappedFieldType ft)

Description copied from class: AggregationContext

Build field data.

Specified by:

buildFieldData in class AggregationContext

getFieldType

public MappedFieldType getFieldType(String path)

Description copied from class: AggregationContext

Lookup a MappedFieldType by path.

Specified by:

getFieldType in class AggregationContext

getMatchingFieldNames

public Set<String> getMatchingFieldNames(String pattern)

Description copied from class: AggregationContext

Returns a set of field names that match a regex-like pattern All field names in the returned set are guaranteed to resolve to a field

Specified by:

getMatchingFieldNames in class AggregationContext

isFieldMapped

public boolean isFieldMapped(String field)

Description copied from class: AggregationContext

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

Specified by:

isFieldMapped in class AggregationContext

compile

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

Description copied from class: AggregationContext

Compile a script.

Specified by:

compile in class AggregationContext

lookup

public SearchLookup lookup()

Description copied from class: AggregationContext

Fetch the shared SearchLookup.

Specified by:

lookup in class AggregationContext

getValuesSourceRegistry

public ValuesSourceRegistry getValuesSourceRegistry()

Description copied from class: AggregationContext

The ValuesSourceRegistry to resolve Aggregators and the like.

Specified by:

getValuesSourceRegistry in class AggregationContext

bigArrays

public BigArrays bigArrays()

Description copied from class: AggregationContext

Utility to share and track large arrays.

Specified by:

bigArrays in class AggregationContext

searcher

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

Description copied from class: AggregationContext

The searcher that will execute this query.

Specified by:

searcher in class AggregationContext

buildQuery

public org.apache.lucene.search.Query buildQuery(QueryBuilder builder)
                                          throws IOException

Description copied from class: AggregationContext

Build a query.

Specified by:

buildQuery in class AggregationContext

Throws:

IOException

filterQuery

public org.apache.lucene.search.Query filterQuery(org.apache.lucene.search.Query query)

Description copied from class: AggregationContext

Add filters from slice or filtered aliases. If you make a new query and don't combine it with the top level query then you must provide it to this method.

Specified by:

filterQuery in class AggregationContext

getIndexSettings

public IndexSettings getIndexSettings()

Description copied from class: AggregationContext

The settings for the index against which this search is running.

Specified by:

getIndexSettings in class AggregationContext

buildSort

public Optional<SortAndFormats> buildSort(List<SortBuilder<?>> sortBuilders)
                                   throws IOException

Description copied from class: AggregationContext

Compile a sort.

Specified by:

buildSort in class AggregationContext

Throws:

IOException

nestedLookup

public NestedLookup nestedLookup()

Description copied from class: AggregationContext

Get the NestedLookup of this index

Specified by:

nestedLookup in class AggregationContext

nestedScope

public NestedScope nestedScope()

Description copied from class: AggregationContext

Access the nested scope. Stay away from this unless you are dealing with nested.

Specified by:

nestedScope in class AggregationContext

subSearchContext

public SubSearchContext subSearchContext()

Description copied from class: AggregationContext

Build a SubSearchContext to power an aggregation fetching top hits. Try to avoid using this because it pulls in a ton of dependencies.

Specified by:

subSearchContext in class AggregationContext

addReleasable

public void addReleasable(Aggregator aggregator)

Description copied from class: AggregationContext

Cause this aggregation to be released when the search is finished.

Specified by:

addReleasable in class AggregationContext

multiBucketConsumer

public MultiBucketConsumerService.MultiBucketConsumer multiBucketConsumer()

Specified by:

multiBucketConsumer in class AggregationContext

bitsetFilterCache

public BitsetFilterCache bitsetFilterCache()

Description copied from class: AggregationContext

Get the filter cache.

Specified by:

bitsetFilterCache in class AggregationContext

buildBucketedSort

public BucketedSort buildBucketedSort(SortBuilder<?> sort,
 int bucketSize,
 BucketedSort.ExtraData extra)
                               throws IOException

Description copied from class: AggregationContext

Build a collector for sorted values specialized for aggregations.

Specified by:

buildBucketedSort in class AggregationContext

Throws:

IOException

shardRandomSeed

public int shardRandomSeed()

Description copied from class: AggregationContext

Get a deterministic random seed based for this particular shard.

Specified by:

shardRandomSeed in class AggregationContext

getRelativeTimeInMillis

public long getRelativeTimeInMillis()

Description copied from class: AggregationContext

How many millis have passed since we started the search?

Specified by:

getRelativeTimeInMillis in class AggregationContext

isCancelled

public boolean isCancelled()

Description copied from class: AggregationContext

Has the search been cancelled?

This'll require a volatile read.

Specified by:

isCancelled in class AggregationContext

breaker

public CircuitBreaker breaker()

Description copied from class: AggregationContext

The circuit breaker used to account for aggs.

Specified by:

breaker in class AggregationContext

getIndexAnalyzer

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

Description copied from class: AggregationContext

Return the index-time analyzer for the current index

Specified by:

getIndexAnalyzer in class AggregationContext

Parameters:

unindexedFieldAnalyzer - a function that builds an analyzer for unindexed fields

isCacheable

public boolean isCacheable()

Description copied from class: AggregationContext

Is this request cacheable? Requests that have non-deterministic queries or scripts aren't cachable.

Specified by:

isCacheable in class AggregationContext

enableRewriteToFilterByFilter

public boolean enableRewriteToFilterByFilter()

Description copied from class: AggregationContext

Are aggregations allowed to try to rewrite themselves into FilterByFilterAggregator aggregations? Often FilterByFilterAggregator is faster to execute, but it isn't always. For now this just hooks into a cluster level setting so users can disable the behavior when the existing heuristics don't detect cases where its slower.

Specified by:

enableRewriteToFilterByFilter in class AggregationContext

isInSortOrderExecutionRequired

public boolean isInSortOrderExecutionRequired()

Description copied from class: AggregationContext

Return true if any of the aggregations in this context is a time-series aggregation that requires an in-sort order execution. A side-effect of such execution is that all leaves are walked simultaneously and therefore we can no longer rely on BucketCollector.getLeafCollector(AggregationExecutionContext) to be called only after the previous leaf was fully collected.

Specified by:

isInSortOrderExecutionRequired in class AggregationContext

sourcePath

public Set<String> sourcePath(String fullName)

Specified by:

sourcePath in class AggregationContext

close

public void close()