org.apache.calcite.plan

Class RelOptCluster

java.lang.Object

org.apache.calcite.plan.RelOptCluster

public class RelOptCluster
extends Object

An environment for related relational expressions during the optimization of a query.

Method Summary

Modifier and Type	Method and Description
static RelOptCluster	create(RelOptPlanner planner, RexBuilder rexBuilder) Creates a cluster.
CorrelationId	createCorrel() Constructs a new id for a correlating variable.
HintStrategyTable	getHintStrategies() Returns the hint strategies of this cluster.
MetadataFactory	getMetadataFactory() Deprecated. Use getMetadataQuery().
@Nullable RelMetadataProvider	getMetadataProvider()
RelMetadataQuery	getMetadataQuery() Returns the current RelMetadataQuery.
Supplier<RelMetadataQuery>	getMetadataQuerySupplier() Returns the supplier of RelMetadataQuery.
RexNode	getOriginalExpression() Deprecated.
RelOptPlanner	getPlanner()
RelOptQuery	getQuery() Deprecated.
RexBuilder	getRexBuilder()
RelDataTypeFactory	getTypeFactory()
void	invalidateMetadataQuery() Should be called whenever the current RelMetadataQuery becomes invalid.
void	setHintStrategies(HintStrategyTable hintStrategies) Sets up the hint propagation strategies to be used during rule planning.
void	setMetadataProvider(RelMetadataProvider metadataProvider) Overrides the default metadata provider for this cluster.
void	setMetadataQuerySupplier(Supplier<RelMetadataQuery> mqSupplier) Sets up the customized RelMetadataQuery instance supplier that to use during rule planning.
void	setOriginalExpression(RexNode originalExpression) Deprecated.
RelTraitSet	traitSet() Returns the default trait set for this cluster.
RelTraitSet	traitSetOf(RelTrait... traits) Deprecated. For traitSetOf(t1, t2), use traitSet()().replace(t1).replace(t2).
RelTraitSet	traitSetOf(RelTrait trait)

Methods inherited from class java.lang.Object

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

Method Detail

create

public static RelOptCluster create(RelOptPlanner planner,
                                   RexBuilder rexBuilder)

Creates a cluster.

getQuery

@Deprecated
public RelOptQuery getQuery()

Deprecated.

getOriginalExpression

@Deprecated
public RexNode getOriginalExpression()

Deprecated.

setOriginalExpression

@Deprecated
public void setOriginalExpression(RexNode originalExpression)

Deprecated.

getPlanner

public RelOptPlanner getPlanner()

getTypeFactory

public RelDataTypeFactory getTypeFactory()

getRexBuilder

public RexBuilder getRexBuilder()

getMetadataProvider

public @Nullable RelMetadataProvider getMetadataProvider()

setMetadataProvider

@EnsuresNonNull(value={"this.metadataProvider","this.metadataFactory"})
public void setMetadataProvider(@UnknownInitialization RelOptCluster this,
                                                                                                        RelMetadataProvider metadataProvider)

Overrides the default metadata provider for this cluster.

Parameters:

metadataProvider - custom provider

getMetadataFactory

@Deprecated
public MetadataFactory getMetadataFactory()

Deprecated. Use getMetadataQuery().

Returns a MetadataFactory.

setMetadataQuerySupplier

@EnsuresNonNull(value="this.mqSupplier")
public void setMetadataQuerySupplier(@UnknownInitialization RelOptCluster this,
                                                                              Supplier<RelMetadataQuery> mqSupplier)

Sets up the customized RelMetadataQuery instance supplier that to use during rule planning.

Note that the mqSupplier should return a fresh new RelMetadataQuery instance because the instance would be cached in this cluster, and we may invalidate and re-generate it for each RelOptRuleCall cycle.

getMetadataQuery

public RelMetadataQuery getMetadataQuery()

Returns the current RelMetadataQuery.

This method might be changed or moved in future. If you have a RelOptRuleCall available, for example if you are in a RelOptRule.onMatch(RelOptRuleCall) method, then use RelOptRuleCall.getMetadataQuery() instead.

getMetadataQuerySupplier

public Supplier<RelMetadataQuery> getMetadataQuerySupplier()

Returns the supplier of RelMetadataQuery.

invalidateMetadataQuery

public void invalidateMetadataQuery()

Should be called whenever the current RelMetadataQuery becomes invalid. Typically invoked from RelOptRuleCall.transformTo(org.apache.calcite.rel.RelNode, java.util.Map<org.apache.calcite.rel.RelNode, org.apache.calcite.rel.RelNode>, org.apache.calcite.plan.RelHintsPropagator).

setHintStrategies

public void setHintStrategies(HintStrategyTable hintStrategies)

Sets up the hint propagation strategies to be used during rule planning.

Use RelOptNode.getCluster().getHintStrategies() to fetch the hint strategies.

Note that this method is only for internal use; the cluster hintStrategies would be always set up with the instance configured by SqlToRelConverter.Config.

Parameters:

hintStrategies - The specified hint strategies to override the default one(empty)

getHintStrategies

public HintStrategyTable getHintStrategies()

Returns the hint strategies of this cluster. It is immutable during the whole planning phrase.

createCorrel

public CorrelationId createCorrel()

Constructs a new id for a correlating variable. It is unique within the whole query.

traitSet

public RelTraitSet traitSet()

Returns the default trait set for this cluster.

traitSetOf

@Deprecated
public RelTraitSet traitSetOf(RelTrait... traits)

Deprecated. For traitSetOf(t1, t2), use traitSet()().replace(t1).replace(t2).

traitSetOf

public RelTraitSet traitSetOf(RelTrait trait)