org.apache.flink.table.planner.plan.nodes.exec.stream

Class StreamExecSink

java.lang.Object

org.apache.flink.table.planner.plan.nodes.exec.ExecNodeBase<Object>

org.apache.flink.table.planner.plan.nodes.exec.common.CommonExecSink

org.apache.flink.table.planner.plan.nodes.exec.stream.StreamExecSink

All Implemented Interfaces:

ExecNode<Object>, ExecNodeTranslator<Object>, FusionCodegenExecNode, MultipleTransformationTranslator<Object>, StreamExecNode<Object>

@ExecNodeMetadata(name="stream-exec-sink",
                  version=1,
                  consumedOptions={"table.exec.sink.not-null-enforcer","table.exec.sink.type-length-enforcer","table.exec.sink.upsert-materialize","table.exec.sink.keyed-shuffle","table.exec.sink.rowtime-inserter"},
                  producedTransformations={"constraint-validator","partitioner","upsert-materialize","timestamp-inserter","sink"},
                  minPlanVersion=v1_15,
                  minStateVersion=v1_15)
public class StreamExecSink
extends CommonExecSink
implements StreamExecNode<Object>

Stream ExecNode to write data into an external sink defined by a DynamicTableSink.

Field Summary

Fields

Modifier and Type	Field and Description
static String	FIELD_NAME_INPUT_CHANGELOG_MODE
static String	FIELD_NAME_INPUT_UPSERT_KEY
static String	FIELD_NAME_REQUIRE_UPSERT_MATERIALIZE
static String	STATE_NAME New introduced state metadata to enable operator-level state TTL configuration.

Fields inherited from class org.apache.flink.table.planner.plan.nodes.exec.common.CommonExecSink

CONSTRAINT_VALIDATOR_TRANSFORMATION, FIELD_NAME_DYNAMIC_TABLE_SINK, PARTITIONER_TRANSFORMATION, ROW_KIND_SETTER, SINK_TRANSFORMATION, sinkParallelismConfigured, tableSinkSpec, TIMESTAMP_INSERTER_TRANSFORMATION, UPSERT_MATERIALIZE_TRANSFORMATION

Fields inherited from interface org.apache.flink.table.planner.plan.nodes.exec.ExecNode

FIELD_NAME_CONFIGURATION, FIELD_NAME_DESCRIPTION, FIELD_NAME_ID, FIELD_NAME_INPUT_PROPERTIES, FIELD_NAME_OUTPUT_TYPE, FIELD_NAME_STATE, FIELD_NAME_TYPE

Constructor Summary

Constructors

Constructor and Description
StreamExecSink(int id, ExecNodeContext context, org.apache.flink.configuration.ReadableConfig persistedConfig, DynamicTableSinkSpec tableSinkSpec, org.apache.flink.table.connector.ChangelogMode inputChangelogMode, boolean upsertMaterialize, List<StateMetadata> stateMetadataList, int[] inputUpsertKey, List<InputProperty> inputProperties, org.apache.flink.table.types.logical.LogicalType outputType, String description)
StreamExecSink(org.apache.flink.configuration.ReadableConfig tableConfig, DynamicTableSinkSpec tableSinkSpec, org.apache.flink.table.connector.ChangelogMode inputChangelogMode, InputProperty inputProperty, org.apache.flink.table.types.logical.LogicalType outputType, boolean upsertMaterialize, int[] inputUpsertKey, String description)

Method Summary

Modifier and Type	Method and Description
protected org.apache.flink.api.dag.Transformation<org.apache.flink.table.data.RowData>	applyUpsertMaterialize(org.apache.flink.api.dag.Transformation<org.apache.flink.table.data.RowData> inputTransform, int[] primaryKeys, int sinkParallelism, ExecNodeConfig config, ClassLoader classLoader, org.apache.flink.table.types.logical.RowType physicalRowType, int[] inputUpsertKey)
protected org.apache.flink.api.dag.Transformation<Object>	translateToPlanInternal(PlannerBase planner, ExecNodeConfig config) Internal method, translates this node into a Flink operator.

Methods inherited from class org.apache.flink.table.planner.plan.nodes.exec.common.CommonExecSink

createSinkTransformation, getPhysicalRowType, getPrimaryKeyIndices, getSimplifiedName, getTableSinkSpec

Methods inherited from class org.apache.flink.table.planner.plan.nodes.exec.ExecNodeBase

accept, createFormattedTransformationDescription, createFormattedTransformationName, createTransformationDescription, createTransformationMeta, createTransformationMeta, createTransformationName, createTransformationUid, getContextFromAnnotation, getDescription, getId, getInputEdges, getInputProperties, getOutputType, getPersistedConfig, getTransformation, inputsContainSingleton, replaceInputEdge, setCompiled, setInputEdges, supportFusionCodegen, translateToFusionCodegenSpec, translateToFusionCodegenSpecInternal, translateToPlan

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.flink.table.planner.plan.nodes.exec.ExecNode

accept, getDescription, getId, getInputEdges, getInputProperties, getOutputType, replaceInputEdge, setCompiled, setInputEdges

Methods inherited from interface org.apache.flink.table.planner.plan.nodes.exec.ExecNodeTranslator

translateToPlan

Methods inherited from interface org.apache.flink.table.planner.plan.nodes.exec.FusionCodegenExecNode

supportFusionCodegen, translateToFusionCodegenSpec

Field Detail

FIELD_NAME_INPUT_CHANGELOG_MODE

public static final String FIELD_NAME_INPUT_CHANGELOG_MODE

See Also:

Constant Field Values

FIELD_NAME_REQUIRE_UPSERT_MATERIALIZE

public static final String FIELD_NAME_REQUIRE_UPSERT_MATERIALIZE

See Also:

Constant Field Values

FIELD_NAME_INPUT_UPSERT_KEY

public static final String FIELD_NAME_INPUT_UPSERT_KEY

See Also:

Constant Field Values

STATE_NAME

public static final String STATE_NAME

New introduced state metadata to enable operator-level state TTL configuration.

See Also:

Constant Field Values

Constructor Detail

StreamExecSink

public StreamExecSink(org.apache.flink.configuration.ReadableConfig tableConfig,
                      DynamicTableSinkSpec tableSinkSpec,
                      org.apache.flink.table.connector.ChangelogMode inputChangelogMode,
                      InputProperty inputProperty,
                      org.apache.flink.table.types.logical.LogicalType outputType,
                      boolean upsertMaterialize,
                      int[] inputUpsertKey,
                      String description)

StreamExecSink

public StreamExecSink(int id,
                      ExecNodeContext context,
                      org.apache.flink.configuration.ReadableConfig persistedConfig,
                      DynamicTableSinkSpec tableSinkSpec,
                      org.apache.flink.table.connector.ChangelogMode inputChangelogMode,
                      boolean upsertMaterialize,
                      @Nullable
                      List<StateMetadata> stateMetadataList,
                      int[] inputUpsertKey,
                      List<InputProperty> inputProperties,
                      org.apache.flink.table.types.logical.LogicalType outputType,
                      String description)

Method Detail

translateToPlanInternal

protected org.apache.flink.api.dag.Transformation<Object> translateToPlanInternal(PlannerBase planner,
                                                                                  ExecNodeConfig config)

Description copied from class: ExecNodeBase

Internal method, translates this node into a Flink operator.

Specified by:

translateToPlanInternal in class ExecNodeBase<Object>

Parameters:

planner - The planner.

config - per-ExecNode configuration that contains the merged configuration from various layers which all the nodes implementing this method should use, instead of retrieving configuration from the planner. For more details check ExecNodeConfig.

applyUpsertMaterialize

protected org.apache.flink.api.dag.Transformation<org.apache.flink.table.data.RowData> applyUpsertMaterialize(org.apache.flink.api.dag.Transformation<org.apache.flink.table.data.RowData> inputTransform,
                                                                                                              int[] primaryKeys,
                                                                                                              int sinkParallelism,
                                                                                                              ExecNodeConfig config,
                                                                                                              ClassLoader classLoader,
                                                                                                              org.apache.flink.table.types.logical.RowType physicalRowType,
                                                                                                              int[] inputUpsertKey)

Specified by:

applyUpsertMaterialize in class CommonExecSink