org.apache.calcite.rel.metadata

Class RelMdPredicates

java.lang.Object

org.apache.calcite.rel.metadata.RelMdPredicates

All Implemented Interfaces:

MetadataHandler<BuiltInMetadata.Predicates>

public class RelMdPredicates
extends Object
implements MetadataHandler<BuiltInMetadata.Predicates>

Utility to infer Predicates that are applicable above a RelNode.

This is currently used by JoinPushTransitivePredicatesRule to infer Predicates that can be inferred from one side of a Join to the other.

The PullUp Strategy is sound but not complete. Here are some of the limitations:

1. For Aggregations we only PullUp predicates that only contain Grouping Keys. This can be extended to infer predicates on Aggregation expressions from expressions on the aggregated columns. For e.g.

    select a, max(b) from R1 where b > 7
      → max(b) > 7 or max(b) is null
    

2. For Projections we only look at columns that are projected without any function applied. So:

    select a from R1 where a > 7
      → "a > 7" is pulled up from the Projection.
    select a + 1 from R1 where a + 1 > 7
      → "a + 1 gt; 7" is not pulled up
    

3. There are several restrictions on Joins:
   • We only pullUp inferred predicates for now. Pulling up existing predicates causes an explosion of duplicates. The existing predicates are pushed back down as new predicates. Once we have rules to eliminate duplicate Filter conditions, we should pullUp all predicates.
   • For Left Outer: we infer new predicates from the left and set them as applicable on the Right side. No predicates are pulledUp.
   • Right Outer Joins are handled in an analogous manner.
   • For Full Outer Joins no predicates are pulledUp or inferred.

Field Summary

Fields

Modifier and Type	Field and Description
static RelMetadataProvider	SOURCE

Constructor Summary

Constructors

Constructor and Description
RelMdPredicates()

Method Summary

Modifier and Type	Method and Description
MetadataDef<BuiltInMetadata.Predicates>	getDef()
RelOptPredicateList	getPredicates(Aggregate agg, RelMetadataQuery mq) Infers predicates for an Aggregate.
RelOptPredicateList	getPredicates(Exchange exchange, RelMetadataQuery mq) Infers predicates for an Exchange.
RelOptPredicateList	getPredicates(Filter filter, RelMetadataQuery mq) Add the Filter condition to the pulledPredicates list from the input.
RelOptPredicateList	getPredicates(Intersect intersect, RelMetadataQuery mq) Infers predicates for a Intersect.
RelOptPredicateList	getPredicates(Join join, RelMetadataQuery mq) Infers predicates for a Join (including SemiJoin).
RelOptPredicateList	getPredicates(Minus minus, RelMetadataQuery mq) Infers predicates for a Minus.
RelOptPredicateList	getPredicates(Project project, RelMetadataQuery mq) Infers predicates for a project.
RelOptPredicateList	getPredicates(RelNode rel, RelMetadataQuery mq) Catch-all implementation for BuiltInMetadata.Predicates.getPredicates(), invoked using reflection.
RelOptPredicateList	getPredicates(RelSubset r, RelMetadataQuery mq) Returns the BuiltInMetadata.Predicates.getPredicates() statistic.
RelOptPredicateList	getPredicates(Sort sort, RelMetadataQuery mq) Infers predicates for a Sort.
RelOptPredicateList	getPredicates(TableModify tableModify, RelMetadataQuery mq) Infers predicates for a TableModify.
RelOptPredicateList	getPredicates(TableScan scan, RelMetadataQuery mq) Infers predicates for a table scan.
RelOptPredicateList	getPredicates(Union union, RelMetadataQuery mq) Infers predicates for a Union.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.calcite.rel.metadata.MetadataHandler

handlerMethods

Field Detail

SOURCE

public static final RelMetadataProvider SOURCE

Constructor Detail

RelMdPredicates

public RelMdPredicates()

Method Detail

getDef

public MetadataDef<BuiltInMetadata.Predicates> getDef()

Specified by:

getDef in interface MetadataHandler<BuiltInMetadata.Predicates>

getPredicates

public RelOptPredicateList getPredicates(RelNode rel,
                                         RelMetadataQuery mq)

Catch-all implementation for BuiltInMetadata.Predicates.getPredicates(), invoked using reflection.

See Also:

RelMetadataQuery.getPulledUpPredicates(RelNode)

getPredicates

public RelOptPredicateList getPredicates(TableScan scan,
                                         RelMetadataQuery mq)

Infers predicates for a table scan.

getPredicates

public RelOptPredicateList getPredicates(Project project,
                                         RelMetadataQuery mq)

Infers predicates for a project.

1. create a mapping from input to projection. Map only positions that directly reference an input column.
2. Expressions that only contain above columns are retained in the Project's pullExpressions list.
3. For e.g. expression 'a + e = 9' below will not be pulled up because 'e' is not in the projection list.

    inputPullUpExprs:      {a > 7, b + c < 10, a + e = 9}
    projectionExprs:       {a, b, c, e / 2}
    projectionPullupExprs: {a > 7, b + c < 10}
    

getPredicates

public RelOptPredicateList getPredicates(Filter filter,
                                         RelMetadataQuery mq)

Add the Filter condition to the pulledPredicates list from the input.

getPredicates

public RelOptPredicateList getPredicates(Join join,
                                         RelMetadataQuery mq)

Infers predicates for a Join (including SemiJoin).

getPredicates

public RelOptPredicateList getPredicates(Aggregate agg,
                                         RelMetadataQuery mq)

Infers predicates for an Aggregate.

Pulls up predicates that only contains references to columns in the GroupSet. For e.g.

 inputPullUpExprs : { a > 7, b + c < 10, a + e = 9}
 groupSet         : { a, b}
 pulledUpExprs    : { a > 7}
 

getPredicates

public RelOptPredicateList getPredicates(Union union,
                                         RelMetadataQuery mq)

Infers predicates for a Union.

getPredicates

public RelOptPredicateList getPredicates(Intersect intersect,
                                         RelMetadataQuery mq)

Infers predicates for a Intersect.

getPredicates

public RelOptPredicateList getPredicates(Minus minus,
                                         RelMetadataQuery mq)

Infers predicates for a Minus.

getPredicates

public RelOptPredicateList getPredicates(Sort sort,
                                         RelMetadataQuery mq)

Infers predicates for a Sort.

getPredicates

public RelOptPredicateList getPredicates(TableModify tableModify,
                                         RelMetadataQuery mq)

Infers predicates for a TableModify.

getPredicates

public RelOptPredicateList getPredicates(Exchange exchange,
                                         RelMetadataQuery mq)

Infers predicates for an Exchange.

getPredicates

public RelOptPredicateList getPredicates(RelSubset r,
                                         RelMetadataQuery mq)

Returns the BuiltInMetadata.Predicates.getPredicates() statistic.

See Also:

RelMetadataQuery.getPulledUpPredicates(RelNode)