org.apache.calcite.rel.rules

Class SortJoinCopyRule

java.lang.Object

org.apache.calcite.plan.RelOptRule

org.apache.calcite.plan.RelRule<SortJoinCopyRule.Config>

org.apache.calcite.rel.rules.SortJoinCopyRule

All Implemented Interfaces:

TransformationRule

@Value.Enclosing
public class SortJoinCopyRule
extends RelRule<SortJoinCopyRule.Config>
implements TransformationRule

Planner rule that copies a Sort past a Join without its limit and offset. The original Sort is preserved but can be potentially removed by SortRemoveRule if redundant.

Some examples where SortJoinCopyRule can be useful: allowing a Sort to be incorporated in an index scan; facilitating the use of operators requiring sorted inputs; and allowing the sort to be performed on a possibly smaller result.

See Also:

CoreRules.SORT_JOIN_COPY

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SortJoinCopyRule.Config Rule configuration.

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

RelRule.Done, RelRule.MatchHandler<R extends RelOptRule>, RelRule.OperandBuilder, RelRule.OperandDetailBuilder<R extends RelNode>, RelRule.OperandTransform

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

RelOptRule.ConverterRelOptRuleOperand

Field Summary

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

config

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

description, operands, relBuilderFactory

Constructor Summary

Constructors

Modifier	Constructor and Description
	SortJoinCopyRule(Class<? extends Sort> sortClass, Class<? extends Join> joinClass, RelBuilderFactory relBuilderFactory) Deprecated.
protected	SortJoinCopyRule(SortJoinCopyRule.Config config) Creates a SortJoinCopyRule.

Method Summary

Modifier and Type	Method and Description
void	onMatch(RelOptRuleCall call) Receives notification about a rule match.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

SortJoinCopyRule

protected SortJoinCopyRule(SortJoinCopyRule.Config config)

Creates a SortJoinCopyRule.

SortJoinCopyRule

@Deprecated
public SortJoinCopyRule(Class<? extends Sort> sortClass,
                                    Class<? extends Join> joinClass,
                                    RelBuilderFactory relBuilderFactory)

Deprecated.

Method Detail

onMatch

public void onMatch(RelOptRuleCall call)

Description copied from class: RelOptRule

Receives notification about a rule match. At the time that this method is called, call.rels holds the set of relational expressions which match the operands to the rule; call.rels[0] is the root expression.

Typically a rule would check that the nodes are valid matches, creates a new expression, then calls back 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) to register the expression.

Specified by:

onMatch in class RelOptRule

Parameters:

call - Rule call

See Also:

RelOptRule.matches(RelOptRuleCall)