org.apache.flink.api.connector.sink

接口 Sink<InputT,CommT,WriterStateT,GlobalCommT>

类型参数:

InputT - The type of the sink's input

CommT - The type of information needed to commit data staged by the sink

WriterStateT - The type of the sink writer's state

GlobalCommT - The type of the aggregated committable

所有超级接口:

Serializable

已过时。

Please use Sink or a derivative.

@Deprecated
 @PublicEvolving
public interface Sink<InputT,CommT,WriterStateT,GlobalCommT>
extends Serializable

This interface lets the sink developer build a simple sink topology, which could guarantee the exactly once semantics in both batch and stream execution mode if there is a Committer or GlobalCommitter. 1. The SinkWriter is responsible for producing the committable. 2. The Committer is responsible for committing a single committable. 3. The GlobalCommitter is responsible for committing an aggregated committable, which we call the global committable. The GlobalCommitter is always executed with a parallelism of 1. Note: Developers need to ensure the idempotence of Committer and GlobalCommitter.

A sink must always have a writer, but committer and global committer are each optional and all combinations are valid.

The Sink needs to be serializable. All configuration should be validated eagerly. The respective sink parts are transient and will only be created in the subtasks on the taskmanagers.

嵌套类概要

嵌套类

限定符和类型	接口和说明
static interface	Sink.InitContext 已过时。 Please migrate to Sink and use Sink.InitContext.
static interface	Sink.ProcessingTimeService 已过时。 Please migrate to Sink and use ProcessingTimeService.

方法概要

限定符和类型	方法和说明
Optional<Committer<CommT>>	createCommitter() 已过时。 Creates a Committer which is part of a 2-phase-commit protocol.
Optional<GlobalCommitter<CommT,GlobalCommT>>	createGlobalCommitter() 已过时。 Creates a GlobalCommitter which is part of a 2-phase-commit protocol.
SinkWriter<InputT,CommT,WriterStateT>	createWriter(Sink.InitContext context, List<WriterStateT> states) 已过时。 Create a SinkWriter.
Optional<SimpleVersionedSerializer<CommT>>	getCommittableSerializer() 已过时。 Returns the serializer of the committable type.
default Collection<String>	getCompatibleStateNames() 已过时。 A list of state names of sinks from which the state can be restored.
Optional<SimpleVersionedSerializer<GlobalCommT>>	getGlobalCommittableSerializer() 已过时。 Returns the serializer of the aggregated committable type.
Optional<SimpleVersionedSerializer<WriterStateT>>	getWriterStateSerializer() 已过时。 Any stateful sink needs to provide this state serializer and implement SinkWriter.snapshotState(long) properly.

方法详细资料

createWriter

SinkWriter<InputT,CommT,WriterStateT> createWriter(Sink.InitContext context,
                                                   List<WriterStateT> states)
                                            throws IOException

已过时。

Create a SinkWriter. If the application is resumed from a checkpoint or savepoint and the sink is stateful, it will receive the corresponding state obtained with SinkWriter.snapshotState(long) and serialized with getWriterStateSerializer(). If no state exists, the first existing, compatible state specified in getCompatibleStateNames() will be loaded and passed.

参数:

context - the runtime context.

states - the writer's previous state.

返回:

A sink writer.

抛出:

IOException - for any failure during creation.

另请参阅:

SinkWriter.snapshotState(long), getWriterStateSerializer(), getCompatibleStateNames()

getWriterStateSerializer

Optional<SimpleVersionedSerializer<WriterStateT>> getWriterStateSerializer()

已过时。

Any stateful sink needs to provide this state serializer and implement SinkWriter.snapshotState(long) properly. The respective state is used in createWriter(InitContext, List) on recovery.

返回:

the serializer of the writer's state type.

createCommitter

Optional<Committer<CommT>> createCommitter()
                                    throws IOException

已过时。

Creates a Committer which is part of a 2-phase-commit protocol. The SinkWriter creates committables through SinkWriter.prepareCommit(boolean) in the first phase. The committables are then passed to this committer and persisted with Committer.commit(List). If a committer is returned, the sink must also return a getCommittableSerializer().

返回:

A committer for the 2-phase-commit protocol.

抛出:

IOException - for any failure during creation.

createGlobalCommitter

Optional<GlobalCommitter<CommT,GlobalCommT>> createGlobalCommitter()
                                                            throws IOException

已过时。

Creates a GlobalCommitter which is part of a 2-phase-commit protocol. The SinkWriter creates committables through SinkWriter.prepareCommit(boolean) in the first phase. The committables are then passed to the Committer and persisted with Committer.commit(List). The committables are also passed to this GlobalCommitter of which only a single instance exists. If a global committer is returned, the sink must also return a getCommittableSerializer() and getGlobalCommittableSerializer().

返回:

A global committer for the 2-phase-commit protocol.

抛出:

IOException - for any failure during creation.

getCommittableSerializer

Optional<SimpleVersionedSerializer<CommT>> getCommittableSerializer()

已过时。

Returns the serializer of the committable type. The serializer is required iff the sink has a Committer or GlobalCommitter.

getGlobalCommittableSerializer

Optional<SimpleVersionedSerializer<GlobalCommT>> getGlobalCommittableSerializer()

已过时。

Returns the serializer of the aggregated committable type. The serializer is required iff the sink has a GlobalCommitter.

getCompatibleStateNames

default Collection<String> getCompatibleStateNames()

已过时。

A list of state names of sinks from which the state can be restored. For example, the new FileSink can resume from the state of an old StreamingFileSink as a drop-in replacement when resuming from a checkpoint/savepoint.