org.apache.hadoop.hive.ql.optimizer.calcite

Class HiveRelOptUtil

java.lang.Object

org.apache.calcite.plan.RelOptUtil

org.apache.hadoop.hive.ql.optimizer.calcite.HiveRelOptUtil

public class HiveRelOptUtil
extends org.apache.calcite.plan.RelOptUtil

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HiveRelOptUtil.PKFKJoinInfo
static class	HiveRelOptUtil.RewritablePKFKJoinInfo

Nested classes/interfaces inherited from class org.apache.calcite.plan.RelOptUtil

org.apache.calcite.plan.RelOptUtil.Exists, org.apache.calcite.plan.RelOptUtil.InputFinder, org.apache.calcite.plan.RelOptUtil.InputReferencedVisitor, org.apache.calcite.plan.RelOptUtil.Logic, org.apache.calcite.plan.RelOptUtil.RexInputConverter, org.apache.calcite.plan.RelOptUtil.SubQueryType, org.apache.calcite.plan.RelOptUtil.TypeDumper, org.apache.calcite.plan.RelOptUtil.VariableUsedVisitor

Field Summary

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

CALC_PREDICATE, EPSILON, FILTER_PREDICATE, PROJECT_PREDICATE

Constructor Summary

Constructors

Constructor and Description
HiveRelOptUtil()

Method Summary

Modifier and Type	Method and Description
static org.apache.calcite.rel.RelNode	createProject(org.apache.calcite.tools.RelBuilder relBuilder, org.apache.calcite.rel.RelNode child, List<Integer> posList) Creates a relational expression that projects the given fields of the input.
static org.apache.calcite.rel.RelNode	createSingleValueAggRel(org.apache.calcite.plan.RelOptCluster cluster, org.apache.calcite.rel.RelNode rel, org.apache.calcite.rel.core.RelFactories.AggregateFactory aggregateFactory) Creates a LogicalAggregate that removes all duplicates from the result of an underlying relational expression.
static HiveRelOptUtil.PKFKJoinInfo	extractPKFKJoin(org.apache.calcite.rel.core.Join join, List<org.apache.calcite.rex.RexNode> joinFilters, boolean leftInputPotentialFK, org.apache.calcite.rel.metadata.RelMetadataQuery mq) Returns a triple where first value represents whether we could extract a FK-PK join or not, the second value is a pair with the column from left and right input that are used for the FK-PK join, and the third value are the predicates that are not part of the FK-PK condition.
static org.apache.calcite.util.Pair<org.apache.calcite.plan.RelOptTable,List<Integer>>	getColumnOriginSet(org.apache.calcite.rel.RelNode rel, org.apache.calcite.util.ImmutableBitSet colSet)
static List<Integer>	getNewRelDistributionKeys(HiveProject project, org.apache.calcite.rel.RelDistribution distribution) Map Exchange distribution keys to the specified Project columns.
static List<org.apache.calcite.rel.RelFieldCollation>	getNewRelFieldCollations(HiveProject project, org.apache.calcite.rel.RelCollation sortCollation, org.apache.calcite.plan.RelOptCluster cluster) Map Sort and SortExchange keys to the specified Project columns.
static HiveRelOptUtil.RewritablePKFKJoinInfo	isRewritablePKFKJoin(org.apache.calcite.rel.core.Join join, org.apache.calcite.rel.RelNode fkInput, org.apache.calcite.rel.RelNode nonFkInput, org.apache.calcite.rel.metadata.RelMetadataQuery mq)
static boolean	isRowFilteringPlan(org.apache.calcite.rel.metadata.RelMetadataQuery mq, org.apache.calcite.rel.RelNode operator) Given a RelNode, it checks whether there is any filtering condition below.
static org.apache.calcite.rex.RexNode	splitCorrelatedFilterCondition(org.apache.calcite.rel.core.Filter filter, List<org.apache.calcite.rex.RexNode> joinKeys, List<org.apache.calcite.rex.RexNode> correlatedJoinKeys, boolean extractCorrelatedFieldAccess)
static org.apache.calcite.rex.RexNode	splitHiveJoinCondition(List<org.apache.calcite.rel.type.RelDataTypeField> sysFieldList, List<org.apache.calcite.rel.RelNode> inputs, org.apache.calcite.rex.RexNode condition, List<List<org.apache.calcite.rex.RexNode>> joinKeys, List<Integer> filterNulls, List<org.apache.calcite.sql.SqlOperator> rangeOp) Splits out the equi-join (and optionally, a single non-equi) components of a join condition, and returns what's left.
static String	toJsonString(org.apache.calcite.rel.RelNode rel) Converts a relational expression to a string, showing information that will aid to parse the string back.

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

addTrait, adjustKeys, analyzeSimpleEquiJoin, andJoinFilters, areRowTypesEqual, checkProjAndChildInputs, classifyFilters, collapseExpandedIsNotDistinctFromExpr, conjunctions, contains, copyRelHints, copyRelHints, correlationColumns, countJoins, createCastRel, createCastRel, createDistinctRel, createDmlRowType, createEquiJoinCondition, createExistsPlan, createExistsPlan, createExistsPlan, createFilter, createFilter, createFilter, createFilter, createNullFilter, createProject, createProject, createProject, createProject, createProject, createProject, createProject, createProject, createProjectJoinRel, createRename, createRenameRel, createSingleValueAggRel, createSwappedJoinExprs, decomposeConjunction, decomposeConjunction, decomposeDisjunction, deduplicateColumns, disjunctions, dumpPlan, dumpPlan, dumpType, eq, equal, equalType, findAllTableQualifiedNames, findAllTables, findTables, getAllFields, getAllFields2, getColumnConstraints, getContext, getFieldTypeList, getVariablesSet, getVariablesSetAndUsed, getVariablesUsed, go, inferViewPredicates, isDistinctFrom, isEqui, isLimit, isOrder, isPureLimit, isPureOrder, notContainsCorrelation, notContainsWindowedAgg, notContainsWindowedAgg, notContainsWindowedAgg, op, permutation, permutationIgnoreCast, permutationPushDownProject, permute, permute, projectJoinInputs, projectMapping, projectMultiJoin, propagateRelHints, propagateRelHints, pushDownJoinConditions, pushDownJoinConditions, pushDownJoinConditions, pushFilterPastProject, pushPastProject, pushPastProject, pushPastProjectUnlessBloat, registerAbstractRelationalRules, registerAbstractRels, registerAbstractRules, registerDefaultRules, renameIfNecessary, replace, replaceInput, simplifyJoin, splitCorrelatedFilterCondition, splitCorrelatedFilterCondition, splitFilters, splitJoinCondition, splitJoinCondition, splitJoinCondition, splitJoinCondition, toString, toString, validateValueAgainstConstraint, verifyTypeEquivalence

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HiveRelOptUtil

public HiveRelOptUtil()

Method Detail

splitHiveJoinCondition

public static org.apache.calcite.rex.RexNode splitHiveJoinCondition(List<org.apache.calcite.rel.type.RelDataTypeField> sysFieldList,
                                                                    List<org.apache.calcite.rel.RelNode> inputs,
                                                                    org.apache.calcite.rex.RexNode condition,
                                                                    List<List<org.apache.calcite.rex.RexNode>> joinKeys,
                                                                    List<Integer> filterNulls,
                                                                    List<org.apache.calcite.sql.SqlOperator> rangeOp)
                                                             throws CalciteSemanticException

Splits out the equi-join (and optionally, a single non-equi) components of a join condition, and returns what's left. Projection might be required by the caller to provide join keys that are not direct field references.

Parameters:

sysFieldList - list of system fields

inputs - join inputs

condition - join condition

joinKeys - The join keys from the inputs which are equi-join keys

filterNulls - The join key positions for which null values will not match. null values only match for the "is not distinct from" condition.

rangeOp - if null, only locate equi-joins; otherwise, locate a single non-equi join predicate and return its operator in this list; join keys associated with the non-equi join predicate are at the end of the key lists returned

Returns:

What's left, never null

Throws:

CalciteSemanticException

createProject

public static org.apache.calcite.rel.RelNode createProject(org.apache.calcite.tools.RelBuilder relBuilder,
                                                           org.apache.calcite.rel.RelNode child,
                                                           List<Integer> posList)

Creates a relational expression that projects the given fields of the input.

Optimizes if the fields are the identity projection.

Parameters:

relBuilder - RelBuilder

child - Input relational expression

posList - Source of each projected field

Returns:

Relational expression that projects given fields

splitCorrelatedFilterCondition

public static org.apache.calcite.rex.RexNode splitCorrelatedFilterCondition(org.apache.calcite.rel.core.Filter filter,
                                                                            List<org.apache.calcite.rex.RexNode> joinKeys,
                                                                            List<org.apache.calcite.rex.RexNode> correlatedJoinKeys,
                                                                            boolean extractCorrelatedFieldAccess)

createSingleValueAggRel

public static org.apache.calcite.rel.RelNode createSingleValueAggRel(org.apache.calcite.plan.RelOptCluster cluster,
                                                                     org.apache.calcite.rel.RelNode rel,
                                                                     org.apache.calcite.rel.core.RelFactories.AggregateFactory aggregateFactory)

Creates a LogicalAggregate that removes all duplicates from the result of an underlying relational expression.

Parameters:

rel - underlying rel

Returns:

rel implementing SingleValueAgg

isRowFilteringPlan

public static boolean isRowFilteringPlan(org.apache.calcite.rel.metadata.RelMetadataQuery mq,
                                         org.apache.calcite.rel.RelNode operator)

Given a RelNode, it checks whether there is any filtering condition below. Basically we check whether the operators below altered the PK cardinality in any way

extractPKFKJoin

public static HiveRelOptUtil.PKFKJoinInfo extractPKFKJoin(org.apache.calcite.rel.core.Join join,
                                                          List<org.apache.calcite.rex.RexNode> joinFilters,
                                                          boolean leftInputPotentialFK,
                                                          org.apache.calcite.rel.metadata.RelMetadataQuery mq)

Returns a triple where first value represents whether we could extract a FK-PK join or not, the second value is a pair with the column from left and right input that are used for the FK-PK join, and the third value are the predicates that are not part of the FK-PK condition. Currently we can only extract one FK-PK join.

isRewritablePKFKJoin

public static HiveRelOptUtil.RewritablePKFKJoinInfo isRewritablePKFKJoin(org.apache.calcite.rel.core.Join join,
                                                                         org.apache.calcite.rel.RelNode fkInput,
                                                                         org.apache.calcite.rel.RelNode nonFkInput,
                                                                         org.apache.calcite.rel.metadata.RelMetadataQuery mq)

getColumnOriginSet

public static org.apache.calcite.util.Pair<org.apache.calcite.plan.RelOptTable,List<Integer>> getColumnOriginSet(org.apache.calcite.rel.RelNode rel,
                                                                                                                 org.apache.calcite.util.ImmutableBitSet colSet)

toJsonString

public static String toJsonString(org.apache.calcite.rel.RelNode rel)

Converts a relational expression to a string, showing information that will aid to parse the string back.

getNewRelFieldCollations

public static List<org.apache.calcite.rel.RelFieldCollation> getNewRelFieldCollations(HiveProject project,
                                                                                      org.apache.calcite.rel.RelCollation sortCollation,
                                                                                      org.apache.calcite.plan.RelOptCluster cluster)

Map Sort and SortExchange keys to the specified Project columns.

Parameters:

project - the Project

sortCollation - current collation in Sort

cluster - RelOptCluster

Returns:

new collation should be used in the Sort

getNewRelDistributionKeys

public static List<Integer> getNewRelDistributionKeys(HiveProject project,
                                                      org.apache.calcite.rel.RelDistribution distribution)

Map Exchange distribution keys to the specified Project columns.

Parameters:

project - the Project

distribution - current distribution in Exchange

Returns:

new distribution should be used in the Exchange