org.apache.flink.connector.jdbc.internal

Class JdbcOutputFormat<In,JdbcIn,JdbcExec extends JdbcBatchStatementExecutor<JdbcIn>>

java.lang.Object

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

org.apache.flink.connector.jdbc.internal.JdbcOutputFormat<In,JdbcIn,JdbcExec>

All Implemented Interfaces:

Flushable, Serializable, OutputFormat<In>, InputTypeConfigurable

Direct Known Subclasses:

JdbcRowOutputFormat

@Internal
public class JdbcOutputFormat<In,JdbcIn,JdbcExec extends JdbcBatchStatementExecutor<JdbcIn>>
extends RichOutputFormat<In>
implements Flushable, InputTypeConfigurable

A JDBC outputFormat that supports batching records before writing records to database.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JdbcOutputFormat.Builder Builder for a JdbcOutputFormat.
static interface	JdbcOutputFormat.RecordExtractor<F,T> An interface to extract a value from given argument.
static interface	JdbcOutputFormat.StatementExecutorFactory<T extends JdbcBatchStatementExecutor<?>> A factory for creating JdbcBatchStatementExecutor instance.

Field Summary

Fields

Modifier and Type	Field and Description
protected JdbcConnectionProvider	connectionProvider

Constructor Summary

Constructors

Constructor and Description
JdbcOutputFormat(JdbcConnectionProvider connectionProvider, JdbcExecutionOptions executionOptions, JdbcOutputFormat.StatementExecutorFactory<JdbcExec> statementExecutorFactory, JdbcOutputFormat.RecordExtractor<In,JdbcIn> recordExtractor)

Method Summary

Modifier and Type	Method and Description
protected void	addToBatch(In original, JdbcIn extracted)
protected void	attemptFlush()
static JdbcOutputFormat.Builder	builder()
void	close() Executes prepared statement and closes all resources of this instance.
void	configure(Configuration parameters) Configures this output format.
void	flush()
Connection	getConnection()
JdbcExecutionOptions	getExecutionOptions() Returns configured JdbcExecutionOptions.
void	open(int taskNumber, int numTasks) Connects to the target database and initializes the prepared statement.
void	setInputType(TypeInformation<?> type, ExecutionConfig executionConfig) Method that is called on an OutputFormat when it is passed to the DataSet's output method.
void	updateExecutor(boolean reconnect)
void	writeRecord(In record) Adds a record to the output.

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

Field Detail

connectionProvider

protected final JdbcConnectionProvider connectionProvider

Constructor Detail

JdbcOutputFormat

public JdbcOutputFormat(@Nonnull
                        JdbcConnectionProvider connectionProvider,
                        @Nonnull
                        JdbcExecutionOptions executionOptions,
                        @Nonnull
                        JdbcOutputFormat.StatementExecutorFactory<JdbcExec> statementExecutorFactory,
                        @Nonnull
                        JdbcOutputFormat.RecordExtractor<In,JdbcIn> recordExtractor)

Method Detail

setInputType

public void setInputType(TypeInformation<?> type,
                         ExecutionConfig executionConfig)

Description copied from interface: InputTypeConfigurable

Method that is called on an OutputFormat when it is passed to the DataSet's output method. May be used to configures the output format based on the data type.

Specified by:

setInputType in interface InputTypeConfigurable

Parameters:

type - The data type of the input.

executionConfig - The execution config for this parallel execution.

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<In>

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.

Specified by:

open in interface OutputFormat<In>

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 final void writeRecord(In record)
                       throws IOException

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<In>

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.

addToBatch

protected void addToBatch(In original,
                          JdbcIn extracted)
                   throws SQLException

Throws:

SQLException

flush

public void flush()
           throws IOException

Specified by:

flush in interface Flushable

Throws:

IOException

attemptFlush

protected void attemptFlush()
                     throws SQLException

Throws:

SQLException

close

public void close()

Executes prepared statement and closes all resources of this instance.

Specified by:

close in interface OutputFormat<In>

builder

public static JdbcOutputFormat.Builder builder()

updateExecutor

public void updateExecutor(boolean reconnect)
                    throws SQLException,
                           ClassNotFoundException

Throws:

SQLException

ClassNotFoundException

getExecutionOptions

public JdbcExecutionOptions getExecutionOptions()

Returns configured JdbcExecutionOptions.

getConnection

@VisibleForTesting
public Connection getConnection()