com.hazelcast.org.apache.calcite.rel.rules.AggregateUnionAggregateRule Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to you under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.hazelcast.org.apache.calcite.rel.rules;
import com.hazelcast.org.apache.calcite.plan.RelOptRuleCall;
import com.hazelcast.org.apache.calcite.plan.RelOptUtil;
import com.hazelcast.org.apache.calcite.plan.RelRule;
import com.hazelcast.org.apache.calcite.rel.RelNode;
import com.hazelcast.org.apache.calcite.rel.core.Aggregate;
import com.hazelcast.org.apache.calcite.rel.core.RelFactories;
import com.hazelcast.org.apache.calcite.rel.core.Union;
import com.hazelcast.org.apache.calcite.rel.logical.LogicalAggregate;
import com.hazelcast.org.apache.calcite.rel.logical.LogicalUnion;
import com.hazelcast.org.apache.calcite.tools.RelBuilder;
import com.hazelcast.org.apache.calcite.tools.RelBuilderFactory;
import org.immutables.value.Value;
/**
* Planner rule that matches
* {@link com.hazelcast.org.apache.calcite.rel.core.Aggregate}s beneath a
* {@link com.hazelcast.org.apache.calcite.rel.core.Union} and pulls them up, so
* that a single
* {@link com.hazelcast.org.apache.calcite.rel.core.Aggregate} removes duplicates.
*
* This rule only handles cases where the
* {@link com.hazelcast.org.apache.calcite.rel.core.Union}s
* still have only two inputs.
*
* @see CoreRules#AGGREGATE_UNION_AGGREGATE
* @see CoreRules#AGGREGATE_UNION_AGGREGATE_FIRST
* @see CoreRules#AGGREGATE_UNION_AGGREGATE_SECOND
*/
@Value.Enclosing
public class AggregateUnionAggregateRule
extends RelRule
implements TransformationRule {
/** Creates an AggregateUnionAggregateRule. */
protected AggregateUnionAggregateRule(Config config) {
super(config);
}
@Deprecated // to be removed before 2.0
public AggregateUnionAggregateRule(Class aggregateClass,
Class unionClass,
Class firstUnionInputClass,
Class secondUnionInputClass,
RelBuilderFactory relBuilderFactory,
String desc) {
this(Config.DEFAULT
.withRelBuilderFactory(relBuilderFactory)
.withDescription(desc)
.as(Config.class)
.withOperandFor(aggregateClass, unionClass, firstUnionInputClass,
secondUnionInputClass));
}
@Deprecated // to be removed before 2.0
public AggregateUnionAggregateRule(Class aggregateClass,
RelFactories.AggregateFactory aggregateFactory,
Class unionClass,
RelFactories.SetOpFactory setOpFactory) {
this(aggregateClass, unionClass, RelNode.class, RelNode.class,
RelBuilder.proto(aggregateFactory, setOpFactory),
"AggregateUnionAggregateRule");
}
//~ Methods ----------------------------------------------------------------
/**
* Returns an input with the same row type with the input Aggregate,
* create a Project node if needed.
*/
private static RelNode getInputWithSameRowType(Aggregate bottomAggRel) {
if (RelOptUtil.areRowTypesEqual(
bottomAggRel.getRowType(),
bottomAggRel.getInput(0).getRowType(),
false)) {
return bottomAggRel.getInput(0);
} else {
return RelOptUtil.createProject(
bottomAggRel.getInput(),
bottomAggRel.getGroupSet().asList());
}
}
@Override public void onMatch(RelOptRuleCall call) {
final Aggregate topAggRel = call.rel(0);
final Union union = call.rel(1);
// If distincts haven't been removed yet, defer invoking this rule
if (!union.all) {
return;
}
final RelBuilder relBuilder = call.builder();
final Aggregate bottomAggRel;
if (call.rel(3) instanceof Aggregate) {
// Aggregate is the second input
bottomAggRel = call.rel(3);
relBuilder.push(call.rel(2))
.push(getInputWithSameRowType(bottomAggRel));
} else if (call.rel(2) instanceof Aggregate) {
// Aggregate is the first input
bottomAggRel = call.rel(2);
relBuilder.push(getInputWithSameRowType(bottomAggRel))
.push(call.rel(3));
} else {
return;
}
// Only pull up aggregates if they are there just to remove distincts
if (!topAggRel.getAggCallList().isEmpty()
|| !bottomAggRel.getAggCallList().isEmpty()) {
return;
}
relBuilder.union(true);
relBuilder.rename(union.getRowType().getFieldNames());
relBuilder.aggregate(relBuilder.groupKey(topAggRel.getGroupSet()),
topAggRel.getAggCallList());
call.transformTo(relBuilder.build());
}
/** Rule configuration. */
@Value.Immutable
public interface Config extends RelRule.Config {
Config DEFAULT = ImmutableAggregateUnionAggregateRule.Config.of()
.withDescription("AggregateUnionAggregateRule")
.withOperandFor(LogicalAggregate.class, LogicalUnion.class,
RelNode.class, RelNode.class);
Config AGG_FIRST = DEFAULT
.withDescription("AggregateUnionAggregateRule:first-input-agg")
.as(Config.class)
.withOperandFor(LogicalAggregate.class, LogicalUnion.class,
LogicalAggregate.class, RelNode.class);
Config AGG_SECOND = DEFAULT
.withDescription("AggregateUnionAggregateRule:second-input-agg")
.as(Config.class)
.withOperandFor(LogicalAggregate.class, LogicalUnion.class,
RelNode.class, LogicalAggregate.class);
@Override default AggregateUnionAggregateRule toRule() {
return new AggregateUnionAggregateRule(this);
}
/** Defines an operand tree for the given classes. */
default Config withOperandFor(Class aggregateClass,
Class unionClass,
Class firstUnionInputClass,
Class secondUnionInputClass) {
return withOperandSupplier(b0 ->
b0.operand(aggregateClass)
.predicate(Aggregate::isSimple)
.oneInput(b1 ->
b1.operand(unionClass).inputs(
b2 -> b2.operand(firstUnionInputClass).anyInputs(),
b3 -> b3.operand(secondUnionInputClass).anyInputs())))
.as(Config.class);
}
}
}