org.apache.flink.table.filesystem

Class FileSystemOutputFormat<T>

java.lang.Object

org.apache.flink.table.filesystem.FileSystemOutputFormat<T>

Type Parameters:

T - The type of the consumed records.

All Implemented Interfaces:

Serializable, FinalizeOnMaster, OutputFormat<T>

@Internal
public class FileSystemOutputFormat<T>
extends Object
implements OutputFormat<T>, FinalizeOnMaster, Serializable

File system OutputFormat for batch job. It commit in finalizeGlobal(int).

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FileSystemOutputFormat.Builder<T> Builder to build FileSystemOutputFormat.

Method Summary

Modifier and Type	Method and Description
void	close() Method that marks the end of the life-cycle of parallel output instance.
void	configure(Configuration parameters) Configures this output format.
void	finalizeGlobal(int parallelism) The method is invoked on the master (JobManager) after all (parallel) instances of an OutputFormat finished.
void	open(int taskNumber, int numTasks) Opens a parallel instance of the output format to store the result of its parallel instance.
void	writeRecord(T record) Adds a record to the output.

Methods inherited from class java.lang.Object

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

Method Detail

finalizeGlobal

public void finalizeGlobal(int parallelism)

Description copied from interface: FinalizeOnMaster

The method is invoked on the master (JobManager) after all (parallel) instances of an OutputFormat finished.

Specified by:

finalizeGlobal in interface FinalizeOnMaster

Parameters:

parallelism - The parallelism with which the format or functions was run.

configure

public void configure(Configuration parameters)

Description copied from interface: OutputFormat

Configures this output format. Since output formats are instantiated generically and hence parameterless, this method is the place where the output formats set their basic fields based on configuration values.

This method is always called first on a newly instantiated output format.

Specified by:

configure in interface OutputFormat<T>

Parameters:

parameters - The configuration with all parameters.

open

public void open(int taskNumber,
                 int numTasks)
          throws IOException

Description copied from interface: OutputFormat

Opens a parallel instance of the output format to store the result of its parallel instance.

When this method is called, the output format it guaranteed to be configured.

Specified by:

open in interface OutputFormat<T>

Parameters:

taskNumber - The number of the parallel instance.

numTasks - The number of parallel tasks.

Throws:

IOException - Thrown, if the output could not be opened due to an I/O problem.

writeRecord

public void writeRecord(T record)

Description copied from interface: OutputFormat

Adds a record to the output.

When this method is called, the output format it guaranteed to be opened.

Specified by:

writeRecord in interface OutputFormat<T>

Parameters:

record - The records to add to the output.

close

public void close()
           throws IOException

Description copied from interface: OutputFormat

Method that marks the end of the life-cycle of parallel output instance. Should be used to close channels and streams and release resources. After this method returns without an error, the output is assumed to be correct.

When this method is called, the output format it guaranteed to be opened.

Specified by:

close in interface OutputFormat<T>

Throws:

IOException - Thrown, if the input could not be closed properly.