org.apache.seatunnel.api.source

接口 SourceSplitEnumerator<SplitT extends SourceSplit,StateT>

类型参数:

SplitT - source split type

所有超级接口:

AutoCloseable, CheckpointListener

public interface SourceSplitEnumerator<SplitT extends SourceSplit,StateT>
extends AutoCloseable, CheckpointListener

The SourceSplitEnumerator is responsible for enumerating the splits of a source. It will run at master.

嵌套类概要

嵌套类

限定符和类型	接口和说明
static interface	SourceSplitEnumerator.Context<SplitT extends SourceSplit>

方法概要

限定符和类型	方法和说明
void	addSplitsBack(List<SplitT> splits, int subtaskId) Add a split back to the split enumerator.
void	close() Called to close the enumerator, in case it holds on to any resources, like threads or network connections.
int	currentUnassignedSplitSize()
default void	handleSourceEvent(int subtaskId, SourceEvent sourceEvent) Handle the source event from SourceReader.
void	handleSplitRequest(int subtaskId)
void	open()
void	registerReader(int subtaskId)
void	run() The method is executed by the engine only once.
StateT	snapshotState(long checkpointId) If the source is bounded, checkpoint is not triggered.

从接口继承的方法 org.apache.seatunnel.api.state.CheckpointListener

notifyCheckpointAborted, notifyCheckpointComplete

方法详细资料

open

void open()

run

void run()
  throws Exception

The method is executed by the engine only once.

抛出:

Exception

close

void close()
    throws IOException

Called to close the enumerator, in case it holds on to any resources, like threads or network connections.

指定者:

close 在接口中 AutoCloseable

抛出:

IOException

addSplitsBack

void addSplitsBack(List<SplitT> splits,
                   int subtaskId)

Add a split back to the split enumerator. It will only happen when a SourceReader fails and there are splits assigned to it after the last successful checkpoint.

参数:

splits - The split to add back to the enumerator for reassignment.

subtaskId - The id of the subtask to which the returned splits belong.

currentUnassignedSplitSize

int currentUnassignedSplitSize()

handleSplitRequest

void handleSplitRequest(int subtaskId)

registerReader

void registerReader(int subtaskId)

snapshotState

StateT snapshotState(long checkpointId)
              throws Exception

If the source is bounded, checkpoint is not triggered.

抛出:

Exception

handleSourceEvent

default void handleSourceEvent(int subtaskId,
                               SourceEvent sourceEvent)

Handle the source event from SourceReader.

参数:

subtaskId - The id of the subtask to which the source event from.

sourceEvent - source event.