org.apache.seatunnel.api.sink

接口 SeaTunnelSink<IN,StateT,CommitInfoT,AggregatedCommitInfoT>

类型参数:

IN - The data class by sink accept. Only support SeaTunnelRow at now.

StateT - The state should be saved when job execute, this class should implement interface Serializable.

CommitInfoT - The commit message class return by SinkWriter.prepareCommit(), then SinkCommitter or SinkAggregatedCommitter and handle it, this class should implement interface Serializable.

AggregatedCommitInfoT - The aggregated commit message class, combine by CommitInfoT. SinkAggregatedCommitter handle it, this class should implement interface Serializable.

所有超级接口:

PluginIdentifierInterface, SeaTunnelJobAware, SeaTunnelPluginLifeCycle, Serializable

public interface SeaTunnelSink<IN,StateT,CommitInfoT,AggregatedCommitInfoT>
extends Serializable, PluginIdentifierInterface, SeaTunnelPluginLifeCycle, SeaTunnelJobAware

The SeaTunnel sink interface, developer should implement this class when create a sink connector.

方法概要

限定符和类型	方法和说明
default Optional<SinkAggregatedCommitter<CommitInfoT,AggregatedCommitInfoT>>	createAggregatedCommitter() This method will be called to create SinkAggregatedCommitter
default Optional<SinkCommitter<CommitInfoT>>	createCommitter() This method will be called to create SinkCommitter
SinkWriter<IN,CommitInfoT,StateT>	createWriter(SinkWriter.Context context) This method will be called to creat SinkWriter
default Optional<Serializer<AggregatedCommitInfoT>>	getAggregatedCommitInfoSerializer() Get AggregatedCommitInfoT serializer.
default Optional<Serializer<CommitInfoT>>	getCommitInfoSerializer() Get CommitInfoT serializer.
default SeaTunnelDataType<IN>	getConsumedType() 已过时。 instead by Factory
default Optional<Serializer<StateT>>	getWriterStateSerializer() Get StateT serializer.
default SinkWriter<IN,CommitInfoT,StateT>	restoreWriter(SinkWriter.Context context, List<StateT> states)
default void	setTypeInfo(SeaTunnelRowType seaTunnelRowType) 已过时。 instead by Factory

从接口继承的方法 org.apache.seatunnel.api.common.PluginIdentifierInterface

getPluginName

从接口继承的方法 org.apache.seatunnel.api.common.SeaTunnelPluginLifeCycle

prepare

从接口继承的方法 org.apache.seatunnel.api.source.SeaTunnelJobAware

setJobContext

方法详细资料

setTypeInfo

@Deprecated
default void setTypeInfo(SeaTunnelRowType seaTunnelRowType)

已过时。 instead by Factory

Set the row type info of sink row data. This method will be automatically called by translation.

参数:

seaTunnelRowType - The row type info of sink.

getConsumedType

@Deprecated
default SeaTunnelDataType<IN> getConsumedType()

已过时。 instead by Factory

Get the data type of the records consumed by this sink.

返回:

SeaTunnel data type.

createWriter

SinkWriter<IN,CommitInfoT,StateT> createWriter(SinkWriter.Context context)
                                        throws IOException

This method will be called to creat SinkWriter

参数:

context - The sink context

返回:

Return sink writer instance

抛出:

IOException - throws IOException when createWriter failed.

restoreWriter

default SinkWriter<IN,CommitInfoT,StateT> restoreWriter(SinkWriter.Context context,
                                                        List<StateT> states)
                                                 throws IOException

抛出:

IOException

getWriterStateSerializer

default Optional<Serializer<StateT>> getWriterStateSerializer()

Get StateT serializer. So that StateT can be transferred across processes

返回:

Serializer of StateT

createCommitter

default Optional<SinkCommitter<CommitInfoT>> createCommitter()
                                                      throws IOException

This method will be called to create SinkCommitter

返回:

Return sink committer instance

抛出:

IOException - throws IOException when createCommitter failed.

getCommitInfoSerializer

default Optional<Serializer<CommitInfoT>> getCommitInfoSerializer()

Get CommitInfoT serializer. So that CommitInfoT can be transferred across processes

返回:

Serializer of CommitInfoT

createAggregatedCommitter

default Optional<SinkAggregatedCommitter<CommitInfoT,AggregatedCommitInfoT>> createAggregatedCommitter()
                                                                                                throws IOException

This method will be called to create SinkAggregatedCommitter

返回:

Return sink aggregated committer instance

抛出:

IOException - throws IOException when createAggregatedCommitter failed.

getAggregatedCommitInfoSerializer

default Optional<Serializer<AggregatedCommitInfoT>> getAggregatedCommitInfoSerializer()

Get AggregatedCommitInfoT serializer. So that AggregatedCommitInfoT can be transferred across processes

返回:

Serializer of AggregatedCommitInfoT