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

Class HiveRelFieldTrimmer

java.lang.Object

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

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

All Implemented Interfaces:

org.apache.calcite.util.ReflectiveVisitor

Direct Known Subclasses:

HiveCardinalityPreservingJoinOptimization

public class HiveRelFieldTrimmer
extends RelFieldTrimmer

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.hadoop.hive.ql.optimizer.calcite.rules.RelFieldTrimmer

RelFieldTrimmer.TrimResult

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.slf4j.Logger	LOG

Fields inherited from class org.apache.hadoop.hive.ql.optimizer.calcite.rules.RelFieldTrimmer

REL_BUILDER, trimFieldsDispatcher

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	HiveRelFieldTrimmer(boolean fetchStats)

Method Summary

Modifier and Type	Method and Description
static HiveRelFieldTrimmer	get() Returns a HiveRelFieldTrimmer instance that does not retrieve stats.
static HiveRelFieldTrimmer	get(boolean fetchStats) Returns a HiveRelFieldTrimmer instance that can retrieve stats.
static HiveRelFieldTrimmer	get(boolean fetchStats, boolean useLMFBasedDispatcher) Returns a HiveRelFieldTrimmer instance that can retrieve stats and use a custom dispatcher.
static void	initializeFieldTrimmerClass(List<Class<? extends org.apache.calcite.rel.RelNode>> nodeClasses) This method can be called at startup time to pre-register all the Hive classes that may be visited during the planning phase.
protected void	register(List<Class<? extends org.apache.calcite.rel.RelNode>> nodeClasses) This method can be called to pre-register all the classes that may be visited during the planning phase.
protected RelFieldTrimmer.TrimResult	result(org.apache.calcite.rel.RelNode r, org.apache.calcite.util.mapping.Mapping mapping)
org.apache.calcite.rel.RelNode	trim(org.apache.calcite.tools.RelBuilder relBuilder, org.apache.calcite.rel.RelNode root) Trims unused fields from a relational expression.
org.apache.calcite.rel.RelNode	trim(org.apache.calcite.tools.RelBuilder relBuilder, org.apache.calcite.rel.RelNode root, ColumnAccessInfo columnAccessInfo, Map<HiveProject,Table> viewToTableSchema)
protected RelFieldTrimmer.TrimResult	trimChild(org.apache.calcite.rel.RelNode rel, org.apache.calcite.rel.RelNode input, org.apache.calcite.util.ImmutableBitSet fieldsUsed, Set<org.apache.calcite.rel.type.RelDataTypeField> extraFields) Trims the fields of an input relational expression.
RelFieldTrimmer.TrimResult	trimFields(org.apache.calcite.rel.core.Aggregate aggregate, org.apache.calcite.util.ImmutableBitSet fieldsUsed, Set<org.apache.calcite.rel.type.RelDataTypeField> extraFields) Variant of RelFieldTrimmer.trimFields(RelNode, ImmutableBitSet, Set) for LogicalAggregate.
RelFieldTrimmer.TrimResult	trimFields(org.apache.calcite.adapter.druid.DruidQuery dq, org.apache.calcite.util.ImmutableBitSet fieldsUsed, Set<org.apache.calcite.rel.type.RelDataTypeField> extraFields) Variant of RelFieldTrimmer.trimFields(RelNode, ImmutableBitSet, Set) for DruidQuery.
RelFieldTrimmer.TrimResult	trimFields(HiveMultiJoin join, org.apache.calcite.util.ImmutableBitSet fieldsUsed, Set<org.apache.calcite.rel.type.RelDataTypeField> extraFields) Variant of RelFieldTrimmer.trimFields(RelNode, ImmutableBitSet, Set) for HiveMultiJoin.
RelFieldTrimmer.TrimResult	trimFields(HiveSortExchange exchange, org.apache.calcite.util.ImmutableBitSet fieldsUsed, Set<org.apache.calcite.rel.type.RelDataTypeField> extraFields)
RelFieldTrimmer.TrimResult	trimFields(HiveTableFunctionScan tabFun, org.apache.calcite.util.ImmutableBitSet fieldsUsed, Set<org.apache.calcite.rel.type.RelDataTypeField> extraFields) Variant of RelFieldTrimmer.trimFields(RelNode, ImmutableBitSet, Set) for HiveTableFunctionScan.
RelFieldTrimmer.TrimResult	trimFields(HiveTableScan tableAccessRel, org.apache.calcite.util.ImmutableBitSet fieldsUsed, Set<org.apache.calcite.rel.type.RelDataTypeField> extraFields)
RelFieldTrimmer.TrimResult	trimFields(org.apache.calcite.rel.core.Project project, org.apache.calcite.util.ImmutableBitSet fieldsUsed, Set<org.apache.calcite.rel.type.RelDataTypeField> extraFields) Variant of RelFieldTrimmer.trimFields(RelNode, ImmutableBitSet, Set) for LogicalProject.

Methods inherited from class org.apache.hadoop.hive.ql.optimizer.calcite.rules.RelFieldTrimmer

createMapping, dispatchTrimFields, dummyProject, trimChildRestore, trimFields, trimFields, trimFields, trimFields, trimFields, trimFields, trimFields, trimFields, trimFields

Methods inherited from class java.lang.Object

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

Field Detail

LOG

protected static final org.slf4j.Logger LOG

Constructor Detail

HiveRelFieldTrimmer

protected HiveRelFieldTrimmer(boolean fetchStats)

Method Detail

get

public static HiveRelFieldTrimmer get()

Returns a HiveRelFieldTrimmer instance that does not retrieve stats.

get

public static HiveRelFieldTrimmer get(boolean fetchStats)

Returns a HiveRelFieldTrimmer instance that can retrieve stats.

get

public static HiveRelFieldTrimmer get(boolean fetchStats,
                                      boolean useLMFBasedDispatcher)

Returns a HiveRelFieldTrimmer instance that can retrieve stats and use a custom dispatcher.

trim

public org.apache.calcite.rel.RelNode trim(org.apache.calcite.tools.RelBuilder relBuilder,
                                           org.apache.calcite.rel.RelNode root)

Trims unused fields from a relational expression.

We presume that all fields of the relational expression are wanted by its consumer, so only trim fields that are not used within the tree.

Overrides:

trim in class RelFieldTrimmer

Parameters:

root - Root node of relational expression

relBuilder - Rel builder

Returns:

Trimmed relational expression

trim

public org.apache.calcite.rel.RelNode trim(org.apache.calcite.tools.RelBuilder relBuilder,
                                           org.apache.calcite.rel.RelNode root,
                                           ColumnAccessInfo columnAccessInfo,
                                           Map<HiveProject,Table> viewToTableSchema)

trimChild

protected RelFieldTrimmer.TrimResult trimChild(org.apache.calcite.rel.RelNode rel,
                                               org.apache.calcite.rel.RelNode input,
                                               org.apache.calcite.util.ImmutableBitSet fieldsUsed,
                                               Set<org.apache.calcite.rel.type.RelDataTypeField> extraFields)

Trims the fields of an input relational expression.

Overrides:

trimChild in class RelFieldTrimmer

Parameters:

rel - Relational expression

input - Input relational expression, whose fields to trim

fieldsUsed - Bitmap of fields needed by the consumer

Returns:

New relational expression and its field mapping

trimFields

public RelFieldTrimmer.TrimResult trimFields(HiveMultiJoin join,
                                             org.apache.calcite.util.ImmutableBitSet fieldsUsed,
                                             Set<org.apache.calcite.rel.type.RelDataTypeField> extraFields)

Variant of RelFieldTrimmer.trimFields(RelNode, ImmutableBitSet, Set) for HiveMultiJoin.

trimFields

public RelFieldTrimmer.TrimResult trimFields(org.apache.calcite.adapter.druid.DruidQuery dq,
                                             org.apache.calcite.util.ImmutableBitSet fieldsUsed,
                                             Set<org.apache.calcite.rel.type.RelDataTypeField> extraFields)

Variant of RelFieldTrimmer.trimFields(RelNode, ImmutableBitSet, Set) for DruidQuery.

trimFields

public RelFieldTrimmer.TrimResult trimFields(org.apache.calcite.rel.core.Aggregate aggregate,
                                             org.apache.calcite.util.ImmutableBitSet fieldsUsed,
                                             Set<org.apache.calcite.rel.type.RelDataTypeField> extraFields)

Description copied from class: RelFieldTrimmer

Variant of RelFieldTrimmer.trimFields(RelNode, ImmutableBitSet, Set) for LogicalAggregate.

Overrides:

trimFields in class RelFieldTrimmer

trimFields

public RelFieldTrimmer.TrimResult trimFields(org.apache.calcite.rel.core.Project project,
                                             org.apache.calcite.util.ImmutableBitSet fieldsUsed,
                                             Set<org.apache.calcite.rel.type.RelDataTypeField> extraFields)

Variant of RelFieldTrimmer.trimFields(RelNode, ImmutableBitSet, Set) for LogicalProject.

Overrides:

trimFields in class RelFieldTrimmer

trimFields

public RelFieldTrimmer.TrimResult trimFields(HiveTableScan tableAccessRel,
                                             org.apache.calcite.util.ImmutableBitSet fieldsUsed,
                                             Set<org.apache.calcite.rel.type.RelDataTypeField> extraFields)

result

protected RelFieldTrimmer.TrimResult result(org.apache.calcite.rel.RelNode r,
                                            org.apache.calcite.util.mapping.Mapping mapping)

Overrides:

result in class RelFieldTrimmer

trimFields

public RelFieldTrimmer.TrimResult trimFields(HiveTableFunctionScan tabFun,
                                             org.apache.calcite.util.ImmutableBitSet fieldsUsed,
                                             Set<org.apache.calcite.rel.type.RelDataTypeField> extraFields)

Variant of RelFieldTrimmer.trimFields(RelNode, ImmutableBitSet, Set) for HiveTableFunctionScan. Copied RelFieldTrimmer.trimFields( org.apache.calcite.rel.logical.LogicalTableFunctionScan, ImmutableBitSet, Set) and replaced tabFun to HiveTableFunctionScan. Proper fix would be implement this in calcite.

register

protected void register(List<Class<? extends org.apache.calcite.rel.RelNode>> nodeClasses)
                 throws Throwable

This method can be called to pre-register all the classes that may be visited during the planning phase.

Throws:

Throwable

initializeFieldTrimmerClass

public static void initializeFieldTrimmerClass(List<Class<? extends org.apache.calcite.rel.RelNode>> nodeClasses)

This method can be called at startup time to pre-register all the Hive classes that may be visited during the planning phase.

trimFields

public RelFieldTrimmer.TrimResult trimFields(HiveSortExchange exchange,
                                             org.apache.calcite.util.ImmutableBitSet fieldsUsed,
                                             Set<org.apache.calcite.rel.type.RelDataTypeField> extraFields)