org.apache.calcite.rel.rules

Class AggregateUnionAggregateRule

java.lang.Object

org.apache.calcite.plan.RelOptRule

org.apache.calcite.rel.rules.AggregateUnionAggregateRule

public class AggregateUnionAggregateRule
extends RelOptRule

Planner rule that matches Aggregates beneath a Union and pulls them up, so that a single Aggregate removes duplicates.

This rule only handles cases where the Unions still have only two inputs.

Field Summary

Fields

Modifier and Type	Field and Description
static AggregateUnionAggregateRule	AGG_ON_FIRST_INPUT Instance that matches an Aggregate as the left input of Union.
static AggregateUnionAggregateRule	AGG_ON_SECOND_INPUT Instance that matches an Aggregate as the right input of Union.
static AggregateUnionAggregateRule	INSTANCE Instance that matches an Aggregate as either input of Union.

Fields inherited from class org.apache.calcite.plan.RelOptRule

description, operands, relBuilderFactory

Constructor Summary

Constructors

Constructor and Description
AggregateUnionAggregateRule(Class<? extends Aggregate> aggregateClass, Class<? extends Union> unionClass, Class<? extends RelNode> firstUnionInputClass, Class<? extends RelNode> secondUnionInputClass, RelBuilderFactory relBuilderFactory, String desc) Creates a AggregateUnionAggregateRule.
AggregateUnionAggregateRule(Class<? extends Aggregate> aggregateClass, RelFactories.AggregateFactory aggregateFactory, Class<? extends Union> unionClass, RelFactories.SetOpFactory setOpFactory) Deprecated.

Method Summary

Modifier and Type	Method and Description
void	onMatch(RelOptRuleCall call) Receives notification about a rule match.

Methods inherited from class org.apache.calcite.plan.RelOptRule

any, convert, convert, convertList, convertOperand, equals, equals, getOperand, getOperands, getOutConvention, getOutTrait, hashCode, matches, none, operand, operand, operand, operand, operand, some, toString, unordered

Methods inherited from class java.lang.Object

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

Field Detail

AGG_ON_FIRST_INPUT

public static final AggregateUnionAggregateRule AGG_ON_FIRST_INPUT

Instance that matches an Aggregate as the left input of Union.

AGG_ON_SECOND_INPUT

public static final AggregateUnionAggregateRule AGG_ON_SECOND_INPUT

Instance that matches an Aggregate as the right input of Union.

INSTANCE

public static final AggregateUnionAggregateRule INSTANCE

Instance that matches an Aggregate as either input of Union.

Because it matches RelNode for each input of Union, it will create O(N ^ 2) matches, which may cost too much during the popMatch phase in VolcanoPlanner. If efficiency is a concern, we recommend that you use AGG_ON_FIRST_INPUT and AGG_ON_SECOND_INPUT instead.

Constructor Detail

AggregateUnionAggregateRule

public AggregateUnionAggregateRule(Class<? extends Aggregate> aggregateClass,
                                   Class<? extends Union> unionClass,
                                   Class<? extends RelNode> firstUnionInputClass,
                                   Class<? extends RelNode> secondUnionInputClass,
                                   RelBuilderFactory relBuilderFactory,
                                   String desc)

Creates a AggregateUnionAggregateRule.

AggregateUnionAggregateRule

@Deprecated
public AggregateUnionAggregateRule(Class<? extends Aggregate> aggregateClass,
                                               RelFactories.AggregateFactory aggregateFactory,
                                               Class<? extends Union> unionClass,
                                               RelFactories.SetOpFactory setOpFactory)

Deprecated.

Method Detail

onMatch

public void onMatch(RelOptRuleCall call)

Description copied from class: RelOptRule

Receives notification about a rule match. At the time that this method is called, call.rels holds the set of relational expressions which match the operands to the rule; call.rels[0] is the root expression.

Typically a rule would check that the nodes are valid matches, creates a new expression, then calls back RelOptRuleCall.transformTo(org.apache.calcite.rel.RelNode, java.util.Map<org.apache.calcite.rel.RelNode, org.apache.calcite.rel.RelNode>) to register the expression.

Specified by:

onMatch in class RelOptRule

Parameters:

call - Rule call

See Also:

RelOptRule.matches(RelOptRuleCall)