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

Class JDBCOutputFormat

java.lang.Object

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

All Implemented Interfaces:

Serializable, org.apache.flink.api.common.io.OutputFormat<org.apache.flink.types.Record>

public class JDBCOutputFormat
extends Object
implements org.apache.flink.api.common.io.OutputFormat<org.apache.flink.types.Record>

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	JDBCOutputFormat.AbstractConfigBuilder<T> Abstract builder used to set parameters to the output format's configuration in a fluent way.
static class	JDBCOutputFormat.ConfigBuilder A builder used to set parameters to the output format's configuration in a fluent way.

Field Summary

Fields

Modifier and Type	Field and Description
static String	BATCH_INTERVAL
static String	DRIVER_KEY
static String	FIELD_COUNT_KEY
static String	FIELD_TYPE_KEY
static String	PASSWORD_KEY
static String	QUERY_KEY
static String	URL_KEY
static String	USERNAME_KEY

Constructor Summary

Constructors

Constructor and Description
JDBCOutputFormat()

Method Summary

Modifier and Type	Method and Description
void	close() Executes prepared statement and closes all resources of this instance.
void	configure(org.apache.flink.configuration.Configuration parameters) Configures this JDBCOutputFormat.
static JDBCOutputFormat.ConfigBuilder	configureOutputFormat(org.apache.flink.api.java.record.operators.GenericDataSink target) Creates a configuration builder that can be used to set the output format's parameters to the config in a fluent fashion.
void	open(int taskNumber, int numTasks) Connects to the target database and initializes the prepared statement.
void	writeRecord(org.apache.flink.types.Record record) Adds a record to the prepared statement.

Methods inherited from class java.lang.Object

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

Field Detail

DRIVER_KEY

public static final String DRIVER_KEY

See Also:

Constant Field Values

USERNAME_KEY

public static final String USERNAME_KEY

See Also:

Constant Field Values

PASSWORD_KEY

public static final String PASSWORD_KEY

See Also:

Constant Field Values

URL_KEY

public static final String URL_KEY

See Also:

Constant Field Values

QUERY_KEY

public static final String QUERY_KEY

See Also:

Constant Field Values

FIELD_COUNT_KEY

public static final String FIELD_COUNT_KEY

See Also:

Constant Field Values

FIELD_TYPE_KEY

public static final String FIELD_TYPE_KEY

See Also:

Constant Field Values

BATCH_INTERVAL

public static final String BATCH_INTERVAL

See Also:

Constant Field Values

Constructor Detail

JDBCOutputFormat

public JDBCOutputFormat()

Method Detail

configure

public void configure(org.apache.flink.configuration.Configuration parameters)

Configures this JDBCOutputFormat.

Specified by:

configure in interface org.apache.flink.api.common.io.OutputFormat<org.apache.flink.types.Record>

Parameters:

parameters - Configuration containing all parameters.

open

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

Connects to the target database and initializes the prepared statement.

Specified by:

open in interface org.apache.flink.api.common.io.OutputFormat<org.apache.flink.types.Record>

Parameters:

taskNumber - The number of the parallel instance.

Throws:

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

writeRecord

public void writeRecord(org.apache.flink.types.Record record)
                 throws IOException

Adds a record to the prepared statement.

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

Specified by:

writeRecord in interface org.apache.flink.api.common.io.OutputFormat<org.apache.flink.types.Record>

Parameters:

record - The records to add to the output.

Throws:

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

close

public void close()
           throws IOException

Executes prepared statement and closes all resources of this instance.

Specified by:

close in interface org.apache.flink.api.common.io.OutputFormat<org.apache.flink.types.Record>

Throws:

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

configureOutputFormat

public static JDBCOutputFormat.ConfigBuilder configureOutputFormat(org.apache.flink.api.java.record.operators.GenericDataSink target)

Creates a configuration builder that can be used to set the output format's parameters to the config in a fluent fashion.

Returns:

A config builder for setting parameters.