TwoPhaseCommittingSink (Flink : Core 1.18.1-cp1 API)

Type Parameters:

InputT - The type of the sink's input

CommT - The type of the committables.

All Superinterfaces:

Serializable, Sink<InputT>
```
@PublicEvolving
public interface TwoPhaseCommittingSink<InputT,CommT>
extends Sink<InputT>
```
A Sink for exactly-once semantics using a two-phase commit protocol. The Sink consists of a SinkWriter that performs the precommits and a Committer that actually commits the data. To facilitate the separation the SinkWriter creates committables on checkpoint or end of input and the sends it to the Committer.
The TwoPhaseCommittingSink 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.

Nested Class Summary

Nested Classes
Modifier and Type	Interface	Description
`static interface`	`TwoPhaseCommittingSink.PrecommittingSinkWriter<InputT,CommT>`	A `SinkWriter` that performs the first part of a two-phase commit protocol.

Nested classes/interfaces inherited from interface org.apache.flink.api.connector.sink2.Sink
Sink.InitContext

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`Committer<CommT>`	`createCommitter()`	Creates a `Committer` that permanently makes the previously written data visible through `Committer.commit(Collection)`.
`TwoPhaseCommittingSink.PrecommittingSinkWriter<InputT,CommT>`	`createWriter(Sink.InitContext context)`	Creates a `TwoPhaseCommittingSink.PrecommittingSinkWriter` that creates committables on checkpoint or end of input.
`SimpleVersionedSerializer<CommT>`	`getCommittableSerializer()`	Returns the serializer of the committable type.

- Method Detail
  - createWriter
```
TwoPhaseCommittingSink.PrecommittingSinkWriter<InputT,CommT> createWriter(Sink.InitContext context)
                                                                         throws IOException
```
    Creates a TwoPhaseCommittingSink.PrecommittingSinkWriter that creates committables on checkpoint or end of input.
    
    Specified by:
    
    createWriter in interface Sink<InputT>
    
    Parameters:
    
    context - the runtime context.
    
    Returns:
    
    A sink writer for the two-phase commit protocol.
    
    Throws:
    
    IOException - for any failure during creation.
  - createCommitter
```
Committer<CommT> createCommitter()
                          throws IOException
```
    Creates a Committer that permanently makes the previously written data visible through Committer.commit(Collection).
    
    Returns:
    
    A committer for the two-phase commit protocol.
    
    Throws:
    
    IOException - for any failure during creation.
  - getCommittableSerializer
```
SimpleVersionedSerializer<CommT> getCommittableSerializer()
```
    Returns the serializer of the committable type.