org.apache.seatunnel.api.source

接口 SeaTunnelSource<T,SplitT extends SourceSplit,StateT extends Serializable>

类型参数:

T - The type of records produced by the source.

SplitT - The type of splits handled by the source.

StateT - The type of checkpoint states.

所有超级接口:

PluginIdentifierInterface, SeaTunnelJobAware, SeaTunnelPluginLifeCycle, Serializable

public interface SeaTunnelSource<T,SplitT extends SourceSplit,StateT extends Serializable>
extends Serializable, PluginIdentifierInterface, SeaTunnelPluginLifeCycle, SeaTunnelJobAware

The interface for Source. It acts like a factory class that helps construct the SourceSplitEnumerator and SourceReader and corresponding serializers.

方法概要

限定符和类型	方法和说明
SourceSplitEnumerator<SplitT,StateT>	createEnumerator(SourceSplitEnumerator.Context<SplitT> enumeratorContext) Create source split enumerator, used to generate splits.
SourceReader<T,SplitT>	createReader(SourceReader.Context readerContext) Create source reader, used to produce data.
Boundedness	getBoundedness() Get the boundedness of this source.
default Serializer<StateT>	getEnumeratorStateSerializer() Create enumerator state serializer, used to serialize/deserialize checkpoint state.
default List<CatalogTable>	getProducedCatalogTables() Get the catalog tables output by this source, It is recommended that all connectors implement this method instead of getProducedType().
default SeaTunnelDataType<T>	getProducedType() 已过时。 Please use getProducedCatalogTables()
default Serializer<SplitT>	getSplitSerializer() Create split serializer, use to serialize/deserialize split generated by SourceSplitEnumerator.
SourceSplitEnumerator<SplitT,StateT>	restoreEnumerator(SourceSplitEnumerator.Context<SplitT> enumeratorContext, StateT checkpointState) Create source split enumerator, used to generate splits.

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

getPluginName

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

prepare

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

setJobContext

方法详细资料

getBoundedness

Boundedness getBoundedness()

Get the boundedness of this source.

返回:

the boundedness of this source.

getProducedType

@Deprecated
default SeaTunnelDataType<T> getProducedType()

已过时。 Please use getProducedCatalogTables()

Get the data type of the records produced by this source.

返回:

SeaTunnel data type.

getProducedCatalogTables

default List<CatalogTable> getProducedCatalogTables()

Get the catalog tables output by this source, It is recommended that all connectors implement this method instead of getProducedType(). CatalogTable contains more information to help downstream support more accurate and complete synchronization capabilities.

createReader

SourceReader<T,SplitT> createReader(SourceReader.Context readerContext)
                             throws Exception

Create source reader, used to produce data.

参数:

readerContext - reader context.

返回:

source reader.

抛出:

Exception - when create reader failed.

getSplitSerializer

default Serializer<SplitT> getSplitSerializer()

Create split serializer, use to serialize/deserialize split generated by SourceSplitEnumerator.

返回:

split serializer.

createEnumerator

SourceSplitEnumerator<SplitT,StateT> createEnumerator(SourceSplitEnumerator.Context<SplitT> enumeratorContext)
                                               throws Exception

Create source split enumerator, used to generate splits. This method will be called only once when start a source.

参数:

enumeratorContext - enumerator context.

返回:

source split enumerator.

抛出:

Exception - when create enumerator failed.

restoreEnumerator

SourceSplitEnumerator<SplitT,StateT> restoreEnumerator(SourceSplitEnumerator.Context<SplitT> enumeratorContext,
                                                       StateT checkpointState)
                                                throws Exception

Create source split enumerator, used to generate splits. This method will be called when restore from checkpoint.

参数:

enumeratorContext - enumerator context.

checkpointState - checkpoint state.

返回:

source split enumerator.

抛出:

Exception - when create enumerator failed.

getEnumeratorStateSerializer

default Serializer<StateT> getEnumeratorStateSerializer()

Create enumerator state serializer, used to serialize/deserialize checkpoint state.

返回:

enumerator state serializer.