org.apache.flink.api.java.io.jdbc

Class JDBCOutputFormat

java.lang.Object

org.apache.flink.api.common.io.RichOutputFormat<Row>

org.apache.flink.api.java.io.jdbc.JDBCOutputFormat

All Implemented Interfaces:

Serializable, OutputFormat<Row>

public class JDBCOutputFormat
extends RichOutputFormat<Row>

OutputFormat to write Rows into a JDBC database. The OutputFormat has to be configured using the supplied OutputFormatBuilder.

See Also:

Row, DriverManager, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JDBCOutputFormat.JDBCOutputFormatBuilder Builder for a JDBCOutputFormat.

Constructor Summary

Constructors

Constructor and Description
JDBCOutputFormat()

Method Summary

Modifier and Type	Method and Description
static JDBCOutputFormat.JDBCOutputFormatBuilder	buildJDBCOutputFormat()
void	close() Executes prepared statement and closes all resources of this instance.
void	configure(Configuration parameters) Configures this output format.
void	open(int taskNumber, int numTasks) Connects to the target database and initializes the prepared statement.
void	writeRecord(Row row) Adds a record to the prepared statement.

Methods inherited from class org.apache.flink.api.common.io.RichOutputFormat

getRuntimeContext, setRuntimeContext

Methods inherited from class java.lang.Object

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

Constructor Detail

JDBCOutputFormat

public JDBCOutputFormat()

Method Detail

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.

Parameters:

parameters - The configuration with all parameters.

open

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

Connects to the target database and initializes the prepared statement.

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(Row row)
                 throws IOException

Adds a record to the prepared statement.

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

WARNING: this may fail when no column types specified (because a best effort approach is attempted in order to insert a null value but it's not guaranteed that the JDBC driver handles PreparedStatement.setObject(pos, null))

Parameters:

row - The records to add to the output.

Throws:

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

See Also:

PreparedStatement

close

public void close()
           throws IOException

Executes prepared statement and closes all resources of this instance.

Throws:

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

buildJDBCOutputFormat

public static JDBCOutputFormat.JDBCOutputFormatBuilder buildJDBCOutputFormat()