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

Class ReadingMetadataSpec

java.lang.Object

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

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

All Implemented Interfaces:

SourceAbilitySpec

public final class ReadingMetadataSpec
extends SourceAbilitySpecBase

A sub-class of SourceAbilitySpec that can not only serialize/deserialize the metadata columns to/from JSON, but also can read the metadata columns from SupportsReadingMetadata.

Field Summary

Fields

Modifier and Type	Field and Description
static String	FIELD_NAME_METADATA_KEYS

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

FIELD_NAME_PRODUCED_TYPE

Constructor Summary

Constructors

Constructor and Description
ReadingMetadataSpec(List<String> metadataKeys, org.apache.flink.table.types.logical.RowType producedType)

Method Summary

Modifier and Type	Method and Description
void	apply(org.apache.flink.table.connector.source.DynamicTableSource tableSource, SourceAbilityContext context) Apply the ability to the given DynamicTableSource.
boolean	equals(Object o)
String	getDigests(SourceAbilityContext context) Additional digests to generate when this spec is applied to the source.
List<String>	getMetadataKeys()
int	hashCode()
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_METADATA_KEYS

public static final String FIELD_NAME_METADATA_KEYS

See Also:

Constant Field Values

Constructor Detail

ReadingMetadataSpec

public ReadingMetadataSpec(List<String> metadataKeys,
                           org.apache.flink.table.types.logical.RowType producedType)

Method Detail

getMetadataKeys

public List<String> getMetadataKeys()

apply

public void apply(org.apache.flink.table.connector.source.DynamicTableSource tableSource,
                  SourceAbilityContext context)

Description copied from interface: SourceAbilitySpec

Apply the ability to the given DynamicTableSource.

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