org.apache.flink.api.connector.sink2

Interface Sink<InputT>

Type Parameters:

InputT - The type of the sink's input

All Superinterfaces:

Serializable

All Known Subinterfaces:

StatefulSink<InputT,WriterStateT>, TwoPhaseCommittingSink<InputT,CommT>, WithPostCommitTopology<InputT,CommT>, WithPreCommitTopology<InputT,CommT>, WithPreWriteTopology<InputT>

All Known Implementing Classes:

AsyncSinkBase, DiscardingSink, FileSink, PrintSink, SinkV1Adapter, UpsertTestSink

@Public
public interface Sink<InputT>
extends Serializable

Base interface for developing a sink. A basic Sink is a stateless sink that can flush data on checkpoint to achieve at-least-once consistency. Sinks with additional requirements should implement SupportsWriterState or SupportsCommitter.

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Sink.InitContext Deprecated.
static class	Sink.InitContextWrapper Deprecated. Internal, do not use it.

Method Summary

Modifier and Type	Method and Description
SinkWriter<InputT>	createWriter(Sink.InitContext context) Deprecated. Please implement createWriter(WriterInitContext). For backward compatibility reasons - to keep Sink a functional interface - Flink did not provide a default implementation. New Sink implementations should implement this method, but it will not be used, and it will be removed in 1.20.0 release. Do not use Override annotation when implementing this method, to prevent compilation errors when migrating to 1.20.x release.
default SinkWriter<InputT>	createWriter(WriterInitContext context) Creates a SinkWriter.

Method Detail

createWriter

@Deprecated
SinkWriter<InputT> createWriter(Sink.InitContext context)
                                     throws IOException

Deprecated. Please implement createWriter(WriterInitContext). For backward compatibility reasons - to keep Sink a functional interface - Flink did not provide a default implementation. New Sink implementations should implement this method, but it will not be used, and it will be removed in 1.20.0 release. Do not use Override annotation when implementing this method, to prevent compilation errors when migrating to 1.20.x release.

Creates a SinkWriter.

Parameters:

context - the runtime context.

Returns:

A sink writer.

Throws:

IOException - for any failure during creation.

createWriter

default SinkWriter<InputT> createWriter(WriterInitContext context)
                                 throws IOException

Creates a SinkWriter.

Parameters:

context - the runtime context.

Returns:

A sink writer.

Throws:

IOException - for any failure during creation.