Custom Calcite Rule to remove redundant references #16402
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,164 @@ | ||
| /* | ||
| * 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 org.apache.druid.sql.calcite.rule.logical; | ||
|
|
||
| import com.google.common.collect.ImmutableList; | ||
| import com.google.common.collect.Sets; | ||
| import org.apache.calcite.plan.RelOptRule; | ||
| import org.apache.calcite.plan.RelOptRuleCall; | ||
| import org.apache.calcite.plan.RelOptUtil; | ||
| import org.apache.calcite.rel.RelNode; | ||
| import org.apache.calcite.rel.core.Aggregate; | ||
| import org.apache.calcite.rel.core.Aggregate.Group; | ||
| import org.apache.calcite.rel.core.AggregateCall; | ||
| import org.apache.calcite.rel.core.Project; | ||
| import org.apache.calcite.rel.rules.TransformationRule; | ||
| import org.apache.calcite.rex.RexInputRef; | ||
| import org.apache.calcite.rex.RexNode; | ||
| import org.apache.calcite.tools.RelBuilder; | ||
| import org.apache.calcite.util.ImmutableBitSet; | ||
| import org.apache.calcite.util.Util; | ||
| import org.apache.calcite.util.mapping.Mappings; | ||
| import org.checkerframework.checker.nullness.qual.Nullable; | ||
| import org.immutables.value.Value; | ||
|
|
||
| import java.util.ArrayList; | ||
| import java.util.HashMap; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
| import java.util.Objects; | ||
| import java.util.Set; | ||
|
|
||
| /** | ||
| * Planner rule that recognizes a {@link Aggregate} | ||
| * on top of a {@link Project} and if possible | ||
| * aggregate through the project or removes the project. | ||
| * <p> | ||
| * This is updated version of {@link org.apache.calcite.rel.rules.AggregateProjectMergeRule} | ||
| * to be able to handle expressions. | ||
| */ | ||
| @Value.Enclosing | ||
| public class DruidAggregateRemoveRedundancyRule | ||
| extends RelOptRule | ||
| implements TransformationRule | ||
| { | ||
|
|
||
| /** | ||
| * Creates a DruidAggregateRemoveRedundancyRule. | ||
| */ | ||
| private static final DruidAggregateRemoveRedundancyRule INSTANCE = new DruidAggregateRemoveRedundancyRule(); | ||
|
|
||
| private DruidAggregateRemoveRedundancyRule() | ||
| { | ||
| super(operand(Aggregate.class, operand(Project.class, any()))); | ||
|
Check notice Code scanning / CodeQL Deprecated method or constructor invocation Note Check notice Code scanning / CodeQL Deprecated method or constructor invocation Note Check notice Code scanning / CodeQL Deprecated method or constructor invocation Note |
||
| } | ||
|
|
||
| public static DruidAggregateRemoveRedundancyRule instance() | ||
| { | ||
| return INSTANCE; | ||
| } | ||
|
|
||
| @Override | ||
| public void onMatch(RelOptRuleCall call) | ||
| { | ||
| final Aggregate aggregate = call.rel(0); | ||
| final Project project = call.rel(1); | ||
| RelNode x = apply(call, aggregate, project); | ||
| if (x != null) { | ||
| call.transformTo(x); | ||
| call.getPlanner().prune(aggregate); | ||
| } | ||
| } | ||
|
|
||
| public static @Nullable RelNode apply(RelOptRuleCall call, Aggregate aggregate, Project project) | ||
| { | ||
| final Set<Integer> interestingFields = RelOptUtil.getAllFields(aggregate); | ||
| if (interestingFields.isEmpty()) { | ||
| return null; | ||
| } | ||
| final Map<Integer, Integer> map = new HashMap<>(); | ||
| final Map<RexNode, Integer> assignedRefForExpr = new HashMap<>(); | ||
| List<RexNode> newRexNodes = new ArrayList<>(); | ||
| for (int source : interestingFields) { | ||
| final RexNode rex = project.getProjects().get(source); | ||
| if (!assignedRefForExpr.containsKey(rex)) { | ||
| RexNode newNode = new RexInputRef(source, rex.getType()); | ||
| assignedRefForExpr.put(rex, newRexNodes.size()); | ||
| newRexNodes.add(newNode); | ||
| } | ||
| map.put(source, assignedRefForExpr.get(rex)); | ||
| } | ||
|
|
||
| if (newRexNodes.size() == project.getProjects().size()) { | ||
| return null; | ||
| } | ||
|
|
||
| final ImmutableBitSet newGroupSet = aggregate.getGroupSet().permute(map); | ||
| ImmutableList<ImmutableBitSet> newGroupingSets = null; | ||
| if (aggregate.getGroupType() != Group.SIMPLE) { | ||
| newGroupingSets = | ||
| ImmutableBitSet.ORDERING.immutableSortedCopy( | ||
| Sets.newTreeSet(ImmutableBitSet.permute(aggregate.getGroupSets(), map))); | ||
| } | ||
|
|
||
| final ImmutableList.Builder<AggregateCall> aggCalls = ImmutableList.builder(); | ||
| final int sourceCount = aggregate.getInput().getRowType().getFieldCount(); | ||
| final int targetCount = newRexNodes.size(); | ||
| final Mappings.TargetMapping targetMapping = Mappings.target(map, sourceCount, targetCount); | ||
| for (AggregateCall aggregateCall : aggregate.getAggCallList()) { | ||
| aggCalls.add(aggregateCall.transform(targetMapping)); | ||
| } | ||
|
|
||
| final RelBuilder relBuilder = call.builder(); | ||
| relBuilder.push(project); | ||
| relBuilder.project(newRexNodes); | ||
|
|
||
| final Aggregate newAggregate = | ||
| aggregate.copy(aggregate.getTraitSet(), relBuilder.build(), | ||
| newGroupSet, newGroupingSets, aggCalls.build() | ||
| ); | ||
| relBuilder.push(newAggregate); | ||
|
|
||
| final List<Integer> newKeys = | ||
| Util.transform( | ||
| aggregate.getGroupSet().asList(), | ||
| key -> Objects.requireNonNull( | ||
| map.get(key), | ||
| () -> "no value found for key " + key + " in " + map | ||
| ) | ||
| ); | ||
|
|
||
| // Add a project if the group set is not in the same order or | ||
| // contains duplicates. | ||
| if (!newKeys.equals(newGroupSet.asList())) { | ||
| final List<Integer> posList = new ArrayList<>(); | ||
| for (int newKey : newKeys) { | ||
| posList.add(newGroupSet.indexOf(newKey)); | ||
| } | ||
| for (int i = newAggregate.getGroupCount(); | ||
| i < newAggregate.getRowType().getFieldCount(); i++) { | ||
| posList.add(i); | ||
| } | ||
| relBuilder.project(relBuilder.fields(posList)); | ||
| } | ||
|
|
||
| return relBuilder.build(); | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
pass by comment, is this the correct way to handle any errors coming out of the agg factory?
A couple of things that I find ambiguous :
Grouping Aggregation [%s] is not supportedseems like misleading message incase there's an actual bug in the agg factoryCannotBuildQueryExceptiononly takes in the message of the exception, which would make things harder to debug without a stack if there's an exception.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@rohangarg Thanks for the comment.
I have updated the exception message to remove not supported. I think the exception here would only be caused by the Precondition checks and that could be easily understood by the exception message
Made the exception look similar to the one we have in
EarliestLatestBySqlAggregatorand return null.anyways, In the end
DruidQuerywould throwCannotBuildQueryException. So it made sense to not throw in the aggregator class.Does this look good to you now?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the fixups :)
A couple of things I would check are :
If both those things look fine, then it is good to go from my side too
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah, for 1, I was actually mentioning the meaningfulness of planning error message which would get surfaced if a query can't get planned. It does look reasonable to me.
For 2, thanks for the clarification.
LGTM