Module org.elasticsearch.compute

Package org.elasticsearch.compute.aggregation

Interface GroupingAggregatorFunction

All Superinterfaces:

AutoCloseable, Closeable, Releasable

All Known Implementing Classes:

CountApproximateGroupingAggregatorFunction, CountGroupingAggregatorFunction, DenseVectorCountApproximateGroupingAggregatorFunction, DenseVectorCountGroupingAggregatorFunction, DimensionValuesByteRefGroupingAggregatorFunction, FilteredGroupingAggregatorFunction, FirstDocIdGroupingAggregatorFunction, FromPartialGroupingAggregatorFunction, IncreaseExponentialHistogramGroupingAggregatorFunction, PresentGroupingAggregatorFunction, RateDoubleGroupingAggregatorFunction, RateIntGroupingAggregatorFunction, RateLongGroupingAggregatorFunction, ToPartialGroupingAggregatorFunction, WindowGroupingAggregatorFunction

public interface GroupingAggregatorFunction
extends Releasable

Applies some grouping function like min or avg to many values, grouped into buckets.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	GroupingAggregatorFunction.AddInput	Consume group ids to cause the GroupingAggregatorFunction to group values at a particular position into a particular group.
static final record	GroupingAggregatorFunction.IntermediateAddInput
static interface	GroupingAggregatorFunction.PreparedForEvaluation	View into the agg that's prepared to emit results.

Method Summary

Modifier and Type	Method	Description
void	addIntermediateInput(int positionOffset, IntArrayBlock groupIdVector, Page page)	Add data produced by prepareEvaluateIntermediate(org.elasticsearch.compute.data.IntVector, org.elasticsearch.compute.aggregation.GroupingAggregatorEvaluationContext).
void	addIntermediateInput(int positionOffset, IntBigArrayBlock groupIdVector, Page page)	Add data produced by prepareEvaluateIntermediate(org.elasticsearch.compute.data.IntVector, org.elasticsearch.compute.aggregation.GroupingAggregatorEvaluationContext).
void	addIntermediateInput(int positionOffset, IntVector groupIdVector, Page page)	Add data produced by prepareEvaluateIntermediate(org.elasticsearch.compute.data.IntVector, org.elasticsearch.compute.aggregation.GroupingAggregatorEvaluationContext).
int	intermediateBlockCount()	The number of blocks used by intermediate state.
GroupingAggregatorFunction.PreparedForEvaluation	prepareEvaluateFinal(IntVector selected, GroupingAggregatorEvaluationContext ctx)	Prepare to build the final results for this aggregation.
GroupingAggregatorFunction.PreparedForEvaluation	prepareEvaluateIntermediate(IntVector selected, GroupingAggregatorEvaluationContext ctx)	Prepare to build the intermediate results for this aggregation.
default GroupingAggregatorFunction.AddInput	prepareProcessIntermediateInputPage(SeenGroupIds seenGroupIds, Page page)	Prepare to process a single page of intermediate input.
GroupingAggregatorFunction.AddInput	prepareProcessRawInputPage(SeenGroupIds seenGroupIds, Page page)	Prepare to process a single page of raw input.
void	selectedMayContainUnseenGroups(SeenGroupIds seenGroupIds)	Call this to signal to the aggregation that the selected parameter that's passed to prepareEvaluateIntermediate(org.elasticsearch.compute.data.IntVector, org.elasticsearch.compute.aggregation.GroupingAggregatorEvaluationContext) or prepareEvaluateFinal(org.elasticsearch.compute.data.IntVector, org.elasticsearch.compute.aggregation.GroupingAggregatorEvaluationContext) may reference groups that haven't been seen.

Methods inherited from interface org.elasticsearch.core.Releasable

close

Method Details

prepareProcessRawInputPage

GroupingAggregatorFunction.AddInput prepareProcessRawInputPage(SeenGroupIds seenGroupIds,
 Page page)

Prepare to process a single page of raw input.

This should load the input Blocks and check their types and select an optimal path and return that path as an GroupingAggregatorFunction.AddInput.

Returns null to opt out of the callback loop for this page entirely, e.g. when the values block is all-null and contributes nothing to the aggregation.

prepareProcessIntermediateInputPage

default GroupingAggregatorFunction.AddInput prepareProcessIntermediateInputPage(SeenGroupIds seenGroupIds,
 Page page)

Prepare to process a single page of intermediate input. This should load the input Blocks and check their types and select an optimal path and return that path as an GroupingAggregatorFunction.AddInput. Returns null to opt out of the callback loop for this page entirely, e.g. when the values block is all-null and contributes nothing to the aggregation.

selectedMayContainUnseenGroups

void selectedMayContainUnseenGroups(SeenGroupIds seenGroupIds)

Call this to signal to the aggregation that the selected parameter that's passed to prepareEvaluateIntermediate(org.elasticsearch.compute.data.IntVector, org.elasticsearch.compute.aggregation.GroupingAggregatorEvaluationContext) or prepareEvaluateFinal(org.elasticsearch.compute.data.IntVector, org.elasticsearch.compute.aggregation.GroupingAggregatorEvaluationContext) may reference groups that haven't been seen. This puts the underlying storage into a mode where it'll track which group ids have been seen, even if that increases the overhead.

addIntermediateInput

void addIntermediateInput(int positionOffset,
 IntArrayBlock groupIdVector,
 Page page)

Add data produced by prepareEvaluateIntermediate(org.elasticsearch.compute.data.IntVector, org.elasticsearch.compute.aggregation.GroupingAggregatorEvaluationContext).

addIntermediateInput

void addIntermediateInput(int positionOffset,
 IntBigArrayBlock groupIdVector,
 Page page)

Add data produced by prepareEvaluateIntermediate(org.elasticsearch.compute.data.IntVector, org.elasticsearch.compute.aggregation.GroupingAggregatorEvaluationContext).

addIntermediateInput

void addIntermediateInput(int positionOffset,
 IntVector groupIdVector,
 Page page)

Add data produced by prepareEvaluateIntermediate(org.elasticsearch.compute.data.IntVector, org.elasticsearch.compute.aggregation.GroupingAggregatorEvaluationContext).

prepareEvaluateIntermediate

GroupingAggregatorFunction.PreparedForEvaluation prepareEvaluateIntermediate(IntVector selected,
 GroupingAggregatorEvaluationContext ctx)

Prepare to build the intermediate results for this aggregation.

Parameters:

selected - the groupIds that have been selected to be included in the results. Always ascending.

prepareEvaluateFinal

GroupingAggregatorFunction.PreparedForEvaluation prepareEvaluateFinal(IntVector selected,
 GroupingAggregatorEvaluationContext ctx)

Prepare to build the final results for this aggregation.

Parameters:

selected - the groupIds that have been selected to be included in the results. Always ascending.

This function is called in the coordinator node after all intermediate results have been gathered from the worker nodes, and aggregated into intermediate blocks.

intermediateBlockCount

int intermediateBlockCount()

The number of blocks used by intermediate state.