org.apache.flink.streaming.api.functions.sink.filesystem

Class StreamingFileSink<IN>

java.lang.Object

org.apache.flink.api.common.functions.AbstractRichFunction

org.apache.flink.streaming.api.functions.sink.RichSinkFunction<IN>

org.apache.flink.streaming.api.functions.sink.filesystem.StreamingFileSink<IN>

Type Parameters:

IN - Type of the elements emitted by this sink

All Implemented Interfaces:

Serializable, org.apache.flink.api.common.functions.Function, org.apache.flink.api.common.functions.RichFunction, org.apache.flink.runtime.state.CheckpointListener, CheckpointedFunction, SinkFunction<IN>, ProcessingTimeCallback

@PublicEvolving
public class StreamingFileSink<IN>
extends RichSinkFunction<IN>
implements CheckpointedFunction, org.apache.flink.runtime.state.CheckpointListener, ProcessingTimeCallback

Sink that emits its input elements to FileSystem files within buckets. This is integrated with the checkpointing mechanism to provide exactly once semantics.

When creating the sink a basePath must be specified. The base directory contains one directory for every bucket. The bucket directories themselves contain several part files, with at least one for each parallel subtask of the sink which is writing data to that bucket. These part files contain the actual output data.

The sink uses a BucketAssigner to determine in which bucket directory each element should be written to inside the base directory. The BucketAssigner can, for example, use time or a property of the element to determine the bucket directory. The default BucketAssigner is a DateTimeBucketAssigner which will create one new bucket every hour. You can specify a custom BucketAssigner using the setBucketAssigner(bucketAssigner) method, after calling forRowFormat(Path, Encoder) or forBulkFormat(Path, BulkWriter.Factory).

The filenames of the part files could be defined using OutputFileConfig, this configuration contain a part prefix and part suffix, that will be used with the parallel subtask index of the sink and a rolling counter. For example for a prefix "prefix" and a suffix ".ext" the file create will have a name "prefix-1-17.ext" containing the data from subtask 1 of the sink and is the 17th bucket created by that subtask. Part files roll based on the user-specified RollingPolicy. By default, a DefaultRollingPolicy is used for row-encoded sink output; a OnCheckpointRollingPolicy is used for bulk-encoded sink output.

In some scenarios, the open buckets are required to change based on time. In these cases, the user can specify a bucketCheckInterval (by default 1m) and the sink will check periodically and roll the part file if the specified rolling policy says so.

Part files can be in one of three states: in-progress, pending or finished. The reason for this is how the sink works together with the checkpointing mechanism to provide exactly-once semantics and fault-tolerance. The part file that is currently being written to is in-progress. Once a part file is closed for writing it becomes pending. When a checkpoint is successful the currently pending files will be moved to finished.

If case of a failure, and in order to guarantee exactly-once semantics, the sink should roll back to the state it had when that last successful checkpoint occurred. To this end, when restoring, the restored files in pending state are transferred into the finished state while any in-progress files are rolled back, so that they do not contain data that arrived after the checkpoint from which we restore.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StreamingFileSink.BulkFormatBuilder<IN,BucketID,T extends StreamingFileSink.BulkFormatBuilder<IN,BucketID,T>> A builder for configuring the sink for bulk-encoding formats, e.g.
static class	StreamingFileSink.RowFormatBuilder<IN,BucketID,T extends StreamingFileSink.RowFormatBuilder<IN,BucketID,T>> A builder for configuring the sink for row-wise encoding formats.

Nested classes/interfaces inherited from interface org.apache.flink.streaming.api.functions.sink.SinkFunction

SinkFunction.Context<T>

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	StreamingFileSink(StreamingFileSink.BulkFormatBuilder<IN,?,? extends org.apache.flink.streaming.api.functions.sink.filesystem.StreamingFileSink.BucketsBuilder<IN,?,?>> bucketsBuilder, long bucketCheckInterval) Creates a new StreamingFileSink that writes files in bulk-encoded format to the given base directory.
protected	StreamingFileSink(StreamingFileSink.RowFormatBuilder<IN,?,? extends org.apache.flink.streaming.api.functions.sink.filesystem.StreamingFileSink.BucketsBuilder<IN,?,?>> bucketsBuilder, long bucketCheckInterval) Creates a new StreamingFileSink that writes files in row-based format to the given base directory.

Method Summary

Modifier and Type	Method and Description
void	close()
static <IN> StreamingFileSink.BulkFormatBuilder<IN,String,? extends StreamingFileSink.BulkFormatBuilder<IN,String,?>>	forBulkFormat(org.apache.flink.core.fs.Path basePath, org.apache.flink.api.common.serialization.BulkWriter.Factory<IN> writerFactory) Creates the builder for a StreamingFileSink with row-encoding format.
static <IN> StreamingFileSink.RowFormatBuilder<IN,String,? extends StreamingFileSink.RowFormatBuilder<IN,String,?>>	forRowFormat(org.apache.flink.core.fs.Path basePath, org.apache.flink.api.common.serialization.Encoder<IN> encoder) Creates the builder for a StreamingFileSink with row-encoding format.
void	initializeState(org.apache.flink.runtime.state.FunctionInitializationContext context) This method is called when the parallel function instance is created during distributed execution.
void	invoke(IN value, SinkFunction.Context context) Writes the given value to the sink.
void	notifyCheckpointComplete(long checkpointId)
void	onProcessingTime(long timestamp) This method is invoked with the timestamp for which the trigger was scheduled.
void	open(org.apache.flink.configuration.Configuration parameters)
void	snapshotState(org.apache.flink.runtime.state.FunctionSnapshotContext context) This method is called when a snapshot for a checkpoint is requested.

Methods inherited from class org.apache.flink.api.common.functions.AbstractRichFunction

getIterationRuntimeContext, getRuntimeContext, setRuntimeContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.flink.streaming.api.functions.sink.SinkFunction

invoke

Constructor Detail

StreamingFileSink

protected StreamingFileSink(StreamingFileSink.RowFormatBuilder<IN,?,? extends org.apache.flink.streaming.api.functions.sink.filesystem.StreamingFileSink.BucketsBuilder<IN,?,?>> bucketsBuilder,
                            long bucketCheckInterval)

Creates a new StreamingFileSink that writes files in row-based format to the given base directory.

StreamingFileSink

protected StreamingFileSink(StreamingFileSink.BulkFormatBuilder<IN,?,? extends org.apache.flink.streaming.api.functions.sink.filesystem.StreamingFileSink.BucketsBuilder<IN,?,?>> bucketsBuilder,
                            long bucketCheckInterval)

Creates a new StreamingFileSink that writes files in bulk-encoded format to the given base directory.

Method Detail

forRowFormat

public static <IN> StreamingFileSink.RowFormatBuilder<IN,String,? extends StreamingFileSink.RowFormatBuilder<IN,String,?>> forRowFormat(org.apache.flink.core.fs.Path basePath,
                                                                                                                                        org.apache.flink.api.common.serialization.Encoder<IN> encoder)

Creates the builder for a StreamingFileSink with row-encoding format.

Type Parameters:

IN - the type of incoming elements

Parameters:

basePath - the base path where all the buckets are going to be created as sub-directories.

encoder - the Encoder to be used when writing elements in the buckets.

Returns:

The builder where the remaining of the configuration parameters for the sink can be configured. In order to instantiate the sink, call StreamingFileSink.RowFormatBuilder.build() after specifying the desired parameters.

forBulkFormat

public static <IN> StreamingFileSink.BulkFormatBuilder<IN,String,? extends StreamingFileSink.BulkFormatBuilder<IN,String,?>> forBulkFormat(org.apache.flink.core.fs.Path basePath,
                                                                                                                                           org.apache.flink.api.common.serialization.BulkWriter.Factory<IN> writerFactory)

Creates the builder for a StreamingFileSink with row-encoding format.

Type Parameters:

IN - the type of incoming elements

Parameters:

basePath - the base path where all the buckets are going to be created as sub-directories.

writerFactory - the BulkWriter.Factory to be used when writing elements in the buckets.

Returns:

The builder where the remaining of the configuration parameters for the sink can be configured. In order to instantiate the sink, call StreamingFileSink.RowFormatBuilder.build() after specifying the desired parameters.

initializeState

public void initializeState(org.apache.flink.runtime.state.FunctionInitializationContext context)
                     throws Exception

Description copied from interface: CheckpointedFunction

This method is called when the parallel function instance is created during distributed execution. Functions typically set up their state storing data structures in this method.

Specified by:

initializeState in interface CheckpointedFunction

Parameters:

context - the context for initializing the operator

Throws:

Exception

notifyCheckpointComplete

public void notifyCheckpointComplete(long checkpointId)
                              throws Exception

Specified by:

notifyCheckpointComplete in interface org.apache.flink.runtime.state.CheckpointListener

Throws:

Exception

snapshotState

public void snapshotState(org.apache.flink.runtime.state.FunctionSnapshotContext context)
                   throws Exception

Description copied from interface: CheckpointedFunction

This method is called when a snapshot for a checkpoint is requested. This acts as a hook to the function to ensure that all state is exposed by means previously offered through FunctionInitializationContext when the Function was initialized, or offered now by FunctionSnapshotContext itself.

Specified by:

snapshotState in interface CheckpointedFunction

Parameters:

context - the context for drawing a snapshot of the operator

Throws:

Exception

open

public void open(org.apache.flink.configuration.Configuration parameters)
          throws Exception

Specified by:

open in interface org.apache.flink.api.common.functions.RichFunction

Overrides:

open in class org.apache.flink.api.common.functions.AbstractRichFunction

Throws:

Exception

onProcessingTime

public void onProcessingTime(long timestamp)
                      throws Exception

Description copied from interface: ProcessingTimeCallback

This method is invoked with the timestamp for which the trigger was scheduled.

If the triggering is delayed for whatever reason (trigger timer was blocked, JVM stalled due to a garbage collection), the timestamp supplied to this function will still be the original timestamp for which the trigger was scheduled.

Specified by:

onProcessingTime in interface ProcessingTimeCallback

Parameters:

timestamp - The timestamp for which the trigger event was scheduled.

Throws:

Exception

invoke

public void invoke(IN value,
                   SinkFunction.Context context)
            throws Exception

Description copied from interface: SinkFunction

Writes the given value to the sink. This function is called for every record.

You have to override this method when implementing a SinkFunction, this is a default method for backward compatibility with the old-style method only.

Specified by:

invoke in interface SinkFunction<IN>

Parameters:

value - The input record.

context - Additional context about the input record.

Throws:

Exception - This method may throw exceptions. Throwing an exception will cause the operation to fail and may trigger recovery.

close

public void close()
           throws Exception

Specified by:

close in interface org.apache.flink.api.common.functions.RichFunction

Overrides:

close in class org.apache.flink.api.common.functions.AbstractRichFunction

Throws:

Exception