org.apache.calcite.plan

Interface RelRule.Config

All Known Subinterfaces:

AbstractConverter.ExpandConversionRule.Config, AbstractJoinExtractFilterRule.Config, AggregateCaseToFilterRule.Config, AggregateExpandDistinctAggregatesRule.Config, AggregateExpandWithinDistinctRule.Config, AggregateExtractProjectRule.Config, AggregateFilterTransposeRule.Config, AggregateJoinJoinRemoveRule.Config, AggregateJoinRemoveRule.Config, AggregateJoinTransposeRule.Config, AggregateMergeRule.Config, AggregateProjectConstantToDummyJoinRule.Config, AggregateProjectMergeRule.Config, AggregateProjectPullUpConstantsRule.Config, AggregateProjectStarTableRule.Config, AggregateReduceFunctionsRule.Config, AggregateRemoveRule.Config, AggregateStarTableRule.Config, AggregateUnionAggregateRule.Config, AggregateUnionTransposeRule.Config, AggregateValuesRule.Config, Bindables.BindableTableScanRule.Config, CalcMergeRule.Config, CalcRemoveRule.Config, CalcSplitRule.Config, CoerceInputsRule.Config, CommonRelSubExprRule.Config, ConverterRule.Config, DateRangeRules.FilterDateRangeRule.FilterDateRangeRuleConfig, EnumerableBatchNestedLoopJoinRule.Config, EnumerableFilterToCalcRule.Config, EnumerableLimitRule.Config, EnumerableLimitSortRule.Config, EnumerableMergeUnionRule.Config, EnumerableProjectToCalcRule.Config, ExchangeRemoveConstantKeysRule.Config, FilterAggregateTransposeRule.Config, FilterCalcMergeRule.Config, FilterCorrelateRule.Config, FilterFlattenCorrelatedConditionRule.Config, FilterJoinRule.Config, FilterJoinRule.FilterIntoJoinRule.FilterIntoJoinRuleConfig, FilterJoinRule.JoinConditionPushRule.JoinConditionPushRuleConfig, FilterMergeRule.Config, FilterMultiJoinMergeRule.Config, FilterProjectTransposeRule.Config, FilterRemoveIsNotDistinctFromRule.Config, FilterSetOpTransposeRule.Config, FilterTableFunctionTransposeRule.Config, FilterTableScanRule.Config, FilterToCalcRule.Config, IntersectToDistinctRule.Config, JoinAddRedundantSemiJoinRule.Config, JoinAssociateRule.Config, JoinCommuteRule.Config, JoinDeriveIsNotNullFilterRule.Config, JoinExtractFilterRule.Config, JoinProjectTransposeRule.Config, JoinPushExpressionsRule.Config, JoinPushThroughJoinRule.Config, JoinPushTransitivePredicatesRule.Config, JoinToCorrelateRule.Config, JoinToMultiJoinRule.Config, JoinUnionTransposeRule.Config, LoptOptimizeJoinRule.Config, MatchRule.Config, MaterializedViewAggregateRule.Config, MaterializedViewFilterScanRule.Config, MaterializedViewOnlyAggregateRule.Config, MaterializedViewOnlyFilterRule.Config, MaterializedViewOnlyJoinRule.Config, MaterializedViewProjectAggregateRule.Config, MaterializedViewProjectFilterRule.Config, MaterializedViewProjectJoinRule.Config, MaterializedViewRule.Config, MultiJoinOptimizeBushyRule.Config, MultiJoinProjectTransposeRule.Config, ProjectAggregateMergeRule.Config, ProjectCalcMergeRule.Config, ProjectCorrelateTransposeRule.Config, ProjectFilterTransposeRule.Config, ProjectJoinJoinRemoveRule.Config, ProjectJoinRemoveRule.Config, ProjectJoinTransposeRule.Config, ProjectMergeRule.Config, ProjectMultiJoinMergeRule.Config, ProjectRemoveRule.Config, ProjectSetOpTransposeRule.Config, ProjectTableScanRule.Config, ProjectToCalcRule.Config, ProjectToWindowRule.CalcToWindowRule.CalcToWindowRuleConfig, ProjectToWindowRule.Config, ProjectToWindowRule.ProjectToLogicalProjectAndWindowRule.ProjectToLogicalProjectAndWindowRuleConfig, ProjectWindowTransposeRule.Config, PruneEmptyRules.IntersectEmptyPruneRuleConfig, PruneEmptyRules.JoinLeftEmptyRuleConfig, PruneEmptyRules.JoinRightEmptyRuleConfig, PruneEmptyRules.MinusEmptyPruneRuleConfig, PruneEmptyRules.PruneEmptyRule.Config, PruneEmptyRules.RemoveEmptySingleRule.RemoveEmptySingleRuleConfig, PruneEmptyRules.SortFetchZeroRuleConfig, PruneEmptyRules.UnionEmptyPruneRuleConfig, ReduceDecimalsRule.Config, ReduceExpressionsRule.CalcReduceExpressionsRule.CalcReduceExpressionsRuleConfig, ReduceExpressionsRule.Config, ReduceExpressionsRule.FilterReduceExpressionsRule.FilterReduceExpressionsRuleConfig, ReduceExpressionsRule.JoinReduceExpressionsRule.JoinReduceExpressionsRuleConfig, ReduceExpressionsRule.ProjectReduceExpressionsRule.ProjectReduceExpressionsRuleConfig, ReduceExpressionsRule.WindowReduceExpressionsRule.WindowReduceExpressionsRuleConfig, RelDecorrelator.AdjustProjectForCountAggregateRule.AdjustProjectForCountAggregateRuleConfig, RelDecorrelator.Config, RelDecorrelator.RemoveCorrelationForScalarAggregateRule.RemoveCorrelationForScalarAggregateRuleConfig, RelDecorrelator.RemoveCorrelationForScalarProjectRule.RemoveCorrelationForScalarProjectRuleConfig, RelDecorrelator.RemoveSingleAggregateRule.RemoveSingleAggregateRuleConfig, SemiJoinFilterTransposeRule.Config, SemiJoinJoinTransposeRule.Config, SemiJoinProjectTransposeRule.Config, SemiJoinRemoveRule.Config, SemiJoinRule.Config, SemiJoinRule.JoinOnUniqueToSemiJoinRule.JoinOnUniqueToSemiJoinRuleConfig, SemiJoinRule.JoinToSemiJoinRule.JoinToSemiJoinRuleConfig, SemiJoinRule.ProjectToSemiJoinRule.ProjectToSemiJoinRuleConfig, SortJoinCopyRule.Config, SortJoinTransposeRule.Config, SortProjectTransposeRule.Config, SortRemoveConstantKeysRule.Config, SortRemoveRule.Config, SortUnionTransposeRule.Config, SpatialRules.FilterHilbertRule.Config, StreamRules.DeltaAggregateTransposeRule.DeltaAggregateTransposeRuleConfig, StreamRules.DeltaFilterTransposeRule.DeltaFilterTransposeRuleConfig, StreamRules.DeltaJoinTransposeRule.DeltaJoinTransposeRuleConfig, StreamRules.DeltaProjectTransposeRule.DeltaProjectTransposeRuleConfig, StreamRules.DeltaSortTransposeRule.DeltaSortTransposeRuleConfig, StreamRules.DeltaTableScanRule.DeltaTableScanRuleConfig, StreamRules.DeltaTableScanToEmptyRule.DeltaTableScanToEmptyRuleConfig, StreamRules.DeltaUnionTransposeRule.DeltaUnionTransposeRuleConfig, SubQueryRemoveRule.Config, TableScanRule.Config, TraitMatchingRule.Config, UnionEliminatorRule.Config, UnionMergeRule.Config, UnionPullUpConstantsRule.Config, UnionToDistinctRule.Config, ValuesReduceRule.Config

Enclosing class:

RelRule<C extends RelRule.Config>

public static interface RelRule.Config

Rule configuration.

Method Summary

Modifier and Type	Method and Description
default <T> T	as(Class<T> class_) Casts this configuration to another type, usually a sub-class.
@Nullable String	description() Description of the rule instance.
default RelRule.OperandTransform	operandSupplier() Creates the operands for the rule instance.
default RelBuilderFactory	relBuilderFactory() The factory that is used to create a RelBuilder during rule invocations.
RelOptRule	toRule() Creates a rule that uses this configuration.
RelRule.Config	withDescription(@Nullable String description) Sets description().
RelRule.Config	withOperandSupplier(RelRule.OperandTransform transform) Sets operandSupplier().
RelRule.Config	withRelBuilderFactory(RelBuilderFactory factory) Sets relBuilderFactory().

Method Detail

toRule

RelOptRule toRule()

Creates a rule that uses this configuration. Sub-class must override.

as

default <T> T as(Class<T> class_)

Casts this configuration to another type, usually a sub-class.

relBuilderFactory

@Value.Default
default RelBuilderFactory relBuilderFactory()

The factory that is used to create a RelBuilder during rule invocations.

withRelBuilderFactory

RelRule.Config withRelBuilderFactory(RelBuilderFactory factory)

Sets relBuilderFactory().

description

@Nullable
@Nullable String description()

Description of the rule instance.

withDescription

RelRule.Config withDescription(@Nullable String description)

Sets description().

operandSupplier

@Value.Default
default RelRule.OperandTransform operandSupplier()

Creates the operands for the rule instance.

withOperandSupplier

RelRule.Config withOperandSupplier(RelRule.OperandTransform transform)

Sets operandSupplier().