Package org.apache.calcite.rel.logical

Class LogicalAggregate

java.lang.Object

org.apache.calcite.rel.AbstractRelNode

org.apache.calcite.rel.SingleRel

org.apache.calcite.rel.core.Aggregate

org.apache.calcite.rel.logical.LogicalAggregate

All Implemented Interfaces:

Cloneable, RelOptNode, Hintable, RelNode

public final class LogicalAggregate
extends Aggregate

LogicalAggregate is a relational operator which eliminates duplicates and computes totals.

Rules:

• AggregateProjectPullUpConstantsRule
• AggregateExpandDistinctAggregatesRule
• AggregateReduceFunctionsRule.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.calcite.rel.core.Aggregate

Aggregate.AggCallBinding, Aggregate.Group, Aggregate.PercentileDiscAggCallBinding

Nested classes/interfaces inherited from interface org.apache.calcite.rel.RelNode

RelNode.Context

Field Summary

Fields inherited from class org.apache.calcite.rel.core.Aggregate

aggCalls, groupSet, groupSets, hints, indicator, IS_NOT_GRAND_TOTAL, IS_SIMPLE, NO_INDICATOR

Fields inherited from class org.apache.calcite.rel.SingleRel

input

Fields inherited from class org.apache.calcite.rel.AbstractRelNode

digest, id, rowType, traitSet

Constructor Summary

Constructors

Constructor	Description
LogicalAggregate(RelOptCluster cluster, RelTraitSet traitSet, List<RelHint> hints, RelNode input, ImmutableBitSet groupSet, @Nullable List<ImmutableBitSet> groupSets, List<AggregateCall> aggCalls)	Creates a LogicalAggregate.
LogicalAggregate(RelOptCluster cluster, RelTraitSet traitSet, RelNode input, boolean indicator, ImmutableBitSet groupSet, List<ImmutableBitSet> groupSets, List<AggregateCall> aggCalls)	Deprecated.
LogicalAggregate(RelOptCluster cluster, RelTraitSet traitSet, RelNode input, ImmutableBitSet groupSet, List<ImmutableBitSet> groupSets, List<AggregateCall> aggCalls)	Deprecated.
LogicalAggregate(RelOptCluster cluster, RelNode input, boolean indicator, ImmutableBitSet groupSet, List<ImmutableBitSet> groupSets, List<AggregateCall> aggCalls)	Deprecated.
LogicalAggregate(RelInput input)	Creates a LogicalAggregate by parsing serialized output.

Method Summary

Modifier and Type	Method	Description
RelNode	accept(RelShuttle shuttle)	Accepts a visit from a shuttle.
LogicalAggregate	copy(RelTraitSet traitSet, RelNode input, ImmutableBitSet groupSet, @Nullable List<ImmutableBitSet> groupSets, List<AggregateCall> aggCalls)	Creates a copy of this aggregate.
static LogicalAggregate	create(RelNode input, boolean indicator, ImmutableBitSet groupSet, List<ImmutableBitSet> groupSets, List<AggregateCall> aggCalls)	Deprecated.
static LogicalAggregate	create(RelNode input, List<RelHint> hints, ImmutableBitSet groupSet, @Nullable List<ImmutableBitSet> groupSets, List<AggregateCall> aggCalls)	Creates a LogicalAggregate.
static LogicalAggregate	create(RelNode input, ImmutableBitSet groupSet, List<ImmutableBitSet> groupSets, List<AggregateCall> aggCalls)	Deprecated.
RelNode	withHints(List<RelHint> hintList)	Returns a new relational expression with the specified hints hintList.

Methods inherited from class org.apache.calcite.rel.core.Aggregate

checkIndicator, computeSelfCost, containsDistinctCall, copy, copy, deriveRowType, deriveRowType, estimateRowCount, explainTerms, getAggCallList, getGroupCount, getGroupSet, getGroupSets, getGroupType, getHints, getIndicatorCount, getNamedAggCalls, isNotGrandTotal, isSimple, isValid, noIndicator

Methods inherited from class org.apache.calcite.rel.SingleRel

childrenAccept, getInput, getInputs, replaceInput

Methods inherited from class org.apache.calcite.rel.AbstractRelNode

accept, collectVariablesSet, collectVariablesUsed, deepEquals, deepHashCode, equals, explain, getCluster, getConvention, getCorrelVariable, getDescription, getDigest, getExpectedInputRowType, getId, getInput, getRelDigest, getRelTypeName, getRowType, getTable, getTraitSet, getVariablesSet, hashCode, isEnforcer, metadata, onRegister, recomputeDigest, register, sole, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.calcite.rel.hint.Hintable

attachHints

Methods inherited from interface org.apache.calcite.rel.RelNode

explain, fieldIsNullable

Constructor Details

LogicalAggregate

public LogicalAggregate(RelOptCluster cluster,
 RelTraitSet traitSet,
 List<RelHint> hints,
 RelNode input,
 ImmutableBitSet groupSet,
 @Nullable List<ImmutableBitSet> groupSets,
 List<AggregateCall> aggCalls)

Creates a LogicalAggregate.

Use create(org.apache.calcite.rel.RelNode, java.util.List<org.apache.calcite.rel.hint.RelHint>, org.apache.calcite.util.ImmutableBitSet, java.util.List<org.apache.calcite.util.ImmutableBitSet>, java.util.List<org.apache.calcite.rel.core.AggregateCall>) unless you know what you're doing.

Parameters:

cluster - Cluster that this relational expression belongs to

traitSet - Traits

hints - Hints for this relational expression

input - Input relational expression

groupSet - Bit set of grouping fields

groupSets - Grouping sets, or null to use just groupSet

aggCalls - Array of aggregates to compute, not null

LogicalAggregate

@Deprecated
public LogicalAggregate(RelOptCluster cluster,
 RelTraitSet traitSet,
 RelNode input,
 ImmutableBitSet groupSet,
 List<ImmutableBitSet> groupSets,
 List<AggregateCall> aggCalls)

Deprecated.

LogicalAggregate

@Deprecated
public LogicalAggregate(RelOptCluster cluster,
 RelTraitSet traitSet,
 RelNode input,
 boolean indicator,
 ImmutableBitSet groupSet,
 List<ImmutableBitSet> groupSets,
 List<AggregateCall> aggCalls)

Deprecated.

LogicalAggregate

@Deprecated
public LogicalAggregate(RelOptCluster cluster,
 RelNode input,
 boolean indicator,
 ImmutableBitSet groupSet,
 List<ImmutableBitSet> groupSets,
 List<AggregateCall> aggCalls)

Deprecated.

LogicalAggregate

public LogicalAggregate(RelInput input)

Creates a LogicalAggregate by parsing serialized output.

Method Details

create

public static LogicalAggregate create(RelNode input,
 List<RelHint> hints,
 ImmutableBitSet groupSet,
 @Nullable List<ImmutableBitSet> groupSets,
 List<AggregateCall> aggCalls)

Creates a LogicalAggregate.

create

@Deprecated
public static LogicalAggregate create(RelNode input,
 ImmutableBitSet groupSet,
 List<ImmutableBitSet> groupSets,
 List<AggregateCall> aggCalls)

Deprecated.

create

@Deprecated
public static LogicalAggregate create(RelNode input,
 boolean indicator,
 ImmutableBitSet groupSet,
 List<ImmutableBitSet> groupSets,
 List<AggregateCall> aggCalls)

Deprecated.

copy

public LogicalAggregate copy(RelTraitSet traitSet,
 RelNode input,
 ImmutableBitSet groupSet,
 @Nullable List<ImmutableBitSet> groupSets,
 List<AggregateCall> aggCalls)

Description copied from class: Aggregate

Creates a copy of this aggregate.

Specified by:

copy in class Aggregate

Parameters:

traitSet - Traits

input - Input

groupSet - Bit set of grouping fields

groupSets - List of all grouping sets; null for just groupSet

aggCalls - Collection of calls to aggregate functions

Returns:

New Aggregate if any parameter differs from the value of this Aggregate, or just this if all the parameters are the same

See Also:

• Aggregate.copy(org.apache.calcite.plan.RelTraitSet, java.util.List)

accept

public RelNode accept(RelShuttle shuttle)

Description copied from interface: RelNode

Accepts a visit from a shuttle.

Specified by:

accept in interface RelNode

Overrides:

accept in class AbstractRelNode

Parameters:

shuttle - Shuttle

Returns:

A copy of this node incorporating changes made by the shuttle to this node's children

withHints

public RelNode withHints(List<RelHint> hintList)

Description copied from interface: Hintable

Returns a new relational expression with the specified hints hintList.

This method should be overridden by every logical node that supports hint. It is only for internal use during decorrelation.

Sub-class should return a new copy of the relational expression.

The default implementation returns the relational expression directly only because not every kind of relational expression supports hints.

Returns:

Relational expression with set up hints