org.apache.flink.table.planner.plan.abilities.source

Class FilterPushDownSpec

java.lang.Object

org.apache.flink.table.planner.plan.abilities.source.SourceAbilitySpecBase

org.apache.flink.table.planner.plan.abilities.source.FilterPushDownSpec

All Implemented Interfaces:

SourceAbilitySpec

public final class FilterPushDownSpec
extends SourceAbilitySpecBase

A sub-class of SourceAbilitySpec that can not only serialize/deserialize the filter to/from JSON, but also can push the filter into a SupportsFilterPushDown.

Field Summary

Fields

Modifier and Type	Field and Description
static String	FIELD_NAME_PREDICATES

Fields inherited from class org.apache.flink.table.planner.plan.abilities.source.SourceAbilitySpecBase

FIELD_NAME_PRODUCED_TYPE

Constructor Summary

Constructors

Constructor and Description
FilterPushDownSpec(List<org.apache.calcite.rex.RexNode> predicates)
FilterPushDownSpec(List<org.apache.calcite.rex.RexNode> predicates, boolean allPredicatesRetained)

Method Summary

Modifier and Type	Method and Description
void	apply(DynamicTableSource tableSource, SourceAbilityContext context) Apply the ability to the given DynamicTableSource.
static SupportsFilterPushDown.Result	apply(List<org.apache.calcite.rex.RexNode> predicates, DynamicTableSource tableSource, SourceAbilityContext context)
boolean	equals(Object o)
String	getDigests(SourceAbilityContext context) Additional digests to generate when this spec is applied to the source.
List<org.apache.calcite.rex.RexNode>	getPredicates()
int	hashCode()
boolean	isAllPredicatesRetained()
boolean	needAdjustFieldReferenceAfterProjection() Does this spec needs adjust field reference after projection.

Methods inherited from class org.apache.flink.table.planner.plan.abilities.source.SourceAbilitySpecBase

getProducedType

Methods inherited from class java.lang.Object

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

Field Detail

FIELD_NAME_PREDICATES

public static final String FIELD_NAME_PREDICATES

See Also:

Constant Field Values

Constructor Detail

FilterPushDownSpec

public FilterPushDownSpec(List<org.apache.calcite.rex.RexNode> predicates,
                          boolean allPredicatesRetained)

FilterPushDownSpec

public FilterPushDownSpec(List<org.apache.calcite.rex.RexNode> predicates)

Method Detail

isAllPredicatesRetained

public boolean isAllPredicatesRetained()

getPredicates

public List<org.apache.calcite.rex.RexNode> getPredicates()

apply

public void apply(DynamicTableSource tableSource,
                  SourceAbilityContext context)

Description copied from interface: SourceAbilitySpec

Apply the ability to the given DynamicTableSource.

apply

public static SupportsFilterPushDown.Result apply(List<org.apache.calcite.rex.RexNode> predicates,
                                                  DynamicTableSource tableSource,
                                                  SourceAbilityContext context)

needAdjustFieldReferenceAfterProjection

public boolean needAdjustFieldReferenceAfterProjection()

Description copied from interface: SourceAbilitySpec

Does this spec needs adjust field reference after projection. If the spec contains RexNode or references fields in scan table, the referenced field indices maybe changed after projection pushdown with scan reuse. Under such case, this method need to return true to notify planner doesn't reuse the scan.

getDigests

public String getDigests(SourceAbilityContext context)

Description copied from interface: SourceAbilitySpec

Additional digests to generate when this spec is applied to the source.

Parameters:

context - The context about the source.

equals

public boolean equals(Object o)

Overrides:

equals in class SourceAbilitySpecBase

hashCode

public int hashCode()

Overrides:

hashCode in class SourceAbilitySpecBase