org.apache.flink.api.connector.sink2

Interface SupportsCommitter<CommittableT>

Type Parameters:

CommittableT - The type of the committables.

All Known Subinterfaces:

TwoPhaseCommittingSink<InputT,CommT>, WithPostCommitTopology<InputT,CommT>, WithPreCommitTopology<InputT,CommT>

All Known Implementing Classes:

FileSink

@Public
public interface SupportsCommitter<CommittableT>

A mixin interface for a Sink which supports exactly-once semantics using a two-phase commit protocol. The Sink consists of a CommittingSinkWriter that performs the precommits and a Committer that actually commits the data. To facilitate the separation the CommittingSinkWriter creates committables on checkpoint or end of input and the sends it to the Committer.

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

Method Summary

Modifier and Type	Method and Description
Committer<CommittableT>	createCommitter(CommitterInitContext context) Creates a Committer that permanently makes the previously written data visible through Committer.commit(Collection).
SimpleVersionedSerializer<CommittableT>	getCommittableSerializer() Returns the serializer of the committable type.

Method Detail

createCommitter

Committer<CommittableT> createCommitter(CommitterInitContext context)
                                 throws IOException

Creates a Committer that permanently makes the previously written data visible through Committer.commit(Collection).

Parameters:

context - The context information for the committer initialization.

Returns:

A committer for the two-phase commit protocol.

Throws:

IOException - for any failure during creation.

getCommittableSerializer

SimpleVersionedSerializer<CommittableT> getCommittableSerializer()

Returns the serializer of the committable type.