org.apache.calcite.rel.rules

Class AbstractMaterializedViewRule.MaterializedViewJoinRule

java.lang.Object

org.apache.calcite.plan.RelOptRule

org.apache.calcite.rel.rules.AbstractMaterializedViewRule

org.apache.calcite.rel.rules.AbstractMaterializedViewRule.MaterializedViewJoinRule

Direct Known Subclasses:

AbstractMaterializedViewRule.MaterializedViewOnlyFilterRule, AbstractMaterializedViewRule.MaterializedViewOnlyJoinRule, AbstractMaterializedViewRule.MaterializedViewProjectFilterRule, AbstractMaterializedViewRule.MaterializedViewProjectJoinRule

Enclosing class:

AbstractMaterializedViewRule

private abstract static class AbstractMaterializedViewRule.MaterializedViewJoinRule
extends AbstractMaterializedViewRule

Materialized view rewriting for join

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.calcite.rel.rules.AbstractMaterializedViewRule

AbstractMaterializedViewRule.MaterializedViewOnlyAggregateRule, AbstractMaterializedViewRule.MaterializedViewOnlyFilterRule, AbstractMaterializedViewRule.MaterializedViewOnlyJoinRule, AbstractMaterializedViewRule.MaterializedViewProjectAggregateRule, AbstractMaterializedViewRule.MaterializedViewProjectFilterRule, AbstractMaterializedViewRule.MaterializedViewProjectJoinRule

Field Summary

Fields inherited from class org.apache.calcite.rel.rules.AbstractMaterializedViewRule

fastBailOut, generateUnionRewriting, INSTANCE_AGGREGATE, INSTANCE_FILTER, INSTANCE_JOIN, INSTANCE_PROJECT_AGGREGATE, INSTANCE_PROJECT_FILTER, INSTANCE_PROJECT_JOIN, unionRewritingPullProgram

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

description, operands, relBuilderFactory

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MaterializedViewJoinRule(RelOptRuleOperand operand, RelBuilderFactory relBuilderFactory, String description, boolean generateUnionRewriting, HepProgram unionRewritingPullProgram, boolean fastBailOut) Creates a MaterializedViewJoinRule.

Method Summary

Modifier and Type	Method and Description
protected AbstractMaterializedViewRule.ViewPartialRewriting	compensateViewPartial(RelBuilder relBuilder, RexBuilder rexBuilder, RelMetadataQuery mq, RelNode input, Project topProject, RelNode node, Set<RexTableInputRef.RelTableRef> queryTableRefs, AbstractMaterializedViewRule.EquivalenceClasses queryEC, Project topViewProject, RelNode viewNode, Set<RexTableInputRef.RelTableRef> viewTableRefs) It checks whether the query can be rewritten using the view even though the query uses additional tables.
protected RelNode	createUnion(RelBuilder relBuilder, RexBuilder rexBuilder, RelNode topProject, RelNode unionInputQuery, RelNode unionInputView) If the view will be used in a union rewriting, this method is responsible for generating the union and any other operator needed on top of it, e.g., a Project operator.
protected boolean	isValidPlan(Project topProject, RelNode node, RelMetadataQuery mq)
Pair<RelNode,RelNode>	pushFilterToOriginalViewPlan(RelBuilder builder, RelNode topViewProject, RelNode viewNode, RexNode cond) Once we create a compensation predicate, this method is responsible for pushing the resulting filter through the view nodes.
protected RelNode	rewriteQuery(RelBuilder relBuilder, RexBuilder rexBuilder, RexSimplify simplify, RelMetadataQuery mq, RexNode compensationColumnsEquiPred, RexNode otherCompensationPred, Project topProject, RelNode node, com.google.common.collect.BiMap<RexTableInputRef.RelTableRef,RexTableInputRef.RelTableRef> viewToQueryTableMapping, AbstractMaterializedViewRule.EquivalenceClasses viewEC, AbstractMaterializedViewRule.EquivalenceClasses queryEC) If the view will be used in a union rewriting, this method is responsible for rewriting the query branch of the union using the given compensation predicate.
protected RelNode	rewriteView(RelBuilder relBuilder, RexBuilder rexBuilder, RexSimplify simplify, RelMetadataQuery mq, AbstractMaterializedViewRule.MatchModality matchModality, boolean unionRewriting, RelNode input, Project topProject, RelNode node, Project topViewProject, RelNode viewNode, com.google.common.collect.BiMap<RexTableInputRef.RelTableRef,RexTableInputRef.RelTableRef> queryToViewTableMapping, AbstractMaterializedViewRule.EquivalenceClasses queryEC) This method is responsible for rewriting the query using the given view query.

Methods inherited from class org.apache.calcite.rel.rules.AbstractMaterializedViewRule

perform

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

MaterializedViewJoinRule

protected MaterializedViewJoinRule(RelOptRuleOperand operand,
                                   RelBuilderFactory relBuilderFactory,
                                   String description,
                                   boolean generateUnionRewriting,
                                   HepProgram unionRewritingPullProgram,
                                   boolean fastBailOut)

Creates a MaterializedViewJoinRule.

Method Detail

isValidPlan

protected boolean isValidPlan(Project topProject,
                              RelNode node,
                              RelMetadataQuery mq)

Specified by:

isValidPlan in class AbstractMaterializedViewRule

compensateViewPartial

protected AbstractMaterializedViewRule.ViewPartialRewriting compensateViewPartial(RelBuilder relBuilder,
                                                                                  RexBuilder rexBuilder,
                                                                                  RelMetadataQuery mq,
                                                                                  RelNode input,
                                                                                  Project topProject,
                                                                                  RelNode node,
                                                                                  Set<RexTableInputRef.RelTableRef> queryTableRefs,
                                                                                  AbstractMaterializedViewRule.EquivalenceClasses queryEC,
                                                                                  Project topViewProject,
                                                                                  RelNode viewNode,
                                                                                  Set<RexTableInputRef.RelTableRef> viewTableRefs)

Description copied from class: AbstractMaterializedViewRule

It checks whether the query can be rewritten using the view even though the query uses additional tables.

Rules implementing the method should follow different approaches depending on the operators they rewrite.

Specified by:

compensateViewPartial in class AbstractMaterializedViewRule

rewriteQuery

protected RelNode rewriteQuery(RelBuilder relBuilder,
                               RexBuilder rexBuilder,
                               RexSimplify simplify,
                               RelMetadataQuery mq,
                               RexNode compensationColumnsEquiPred,
                               RexNode otherCompensationPred,
                               Project topProject,
                               RelNode node,
                               com.google.common.collect.BiMap<RexTableInputRef.RelTableRef,RexTableInputRef.RelTableRef> viewToQueryTableMapping,
                               AbstractMaterializedViewRule.EquivalenceClasses viewEC,
                               AbstractMaterializedViewRule.EquivalenceClasses queryEC)

Description copied from class: AbstractMaterializedViewRule

If the view will be used in a union rewriting, this method is responsible for rewriting the query branch of the union using the given compensation predicate.

If a rewriting can be produced, we return that rewriting. If it cannot be produced, we will return null.

Specified by:

rewriteQuery in class AbstractMaterializedViewRule

createUnion

protected RelNode createUnion(RelBuilder relBuilder,
                              RexBuilder rexBuilder,
                              RelNode topProject,
                              RelNode unionInputQuery,
                              RelNode unionInputView)

Description copied from class: AbstractMaterializedViewRule

If the view will be used in a union rewriting, this method is responsible for generating the union and any other operator needed on top of it, e.g., a Project operator.

Specified by:

createUnion in class AbstractMaterializedViewRule

rewriteView

protected RelNode rewriteView(RelBuilder relBuilder,
                              RexBuilder rexBuilder,
                              RexSimplify simplify,
                              RelMetadataQuery mq,
                              AbstractMaterializedViewRule.MatchModality matchModality,
                              boolean unionRewriting,
                              RelNode input,
                              Project topProject,
                              RelNode node,
                              Project topViewProject,
                              RelNode viewNode,
                              com.google.common.collect.BiMap<RexTableInputRef.RelTableRef,RexTableInputRef.RelTableRef> queryToViewTableMapping,
                              AbstractMaterializedViewRule.EquivalenceClasses queryEC)

Description copied from class: AbstractMaterializedViewRule

This method is responsible for rewriting the query using the given view query.

The input node is a Scan on the view table and possibly a compensation Filter on top. If a rewriting can be produced, we return that rewriting. If it cannot be produced, we will return null.

Specified by:

rewriteView in class AbstractMaterializedViewRule

pushFilterToOriginalViewPlan

public Pair<RelNode,RelNode> pushFilterToOriginalViewPlan(RelBuilder builder,
                                                          RelNode topViewProject,
                                                          RelNode viewNode,
                                                          RexNode cond)

Description copied from class: AbstractMaterializedViewRule

Once we create a compensation predicate, this method is responsible for pushing the resulting filter through the view nodes. This might be useful for rewritings containing Aggregate operators, as some of the grouping columns might be removed, which results in additional matching possibilities.

The method will return a pair of nodes: the new top project on the left and the new node on the right.

Specified by:

pushFilterToOriginalViewPlan in class AbstractMaterializedViewRule