Package 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, org.apache.flink.api.common.io.OutputFormat<In>, org.apache.flink.api.java.typeutils.InputTypeConfigurable

Direct Known Subclasses:

JdbcRowOutputFormat

@Internal
public class JdbcOutputFormat<In,JdbcIn,JdbcExec extends JdbcBatchStatementExecutor<JdbcIn>>
extends org.apache.flink.api.common.io.RichOutputFormat<In>
implements Flushable, org.apache.flink.api.java.typeutils.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	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.

Nested classes/interfaces inherited from interface org.apache.flink.api.common.io.OutputFormat

org.apache.flink.api.common.io.OutputFormat.InitializationContext

Field Summary

Fields

Modifier and Type	Field	Description
protected JdbcConnectionProvider	connectionProvider

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	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(org.apache.flink.configuration.Configuration parameters)
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(org.apache.flink.api.common.typeinfo.TypeInformation<?> type, org.apache.flink.api.common.ExecutionConfig executionConfig)
void	updateExecutor(boolean reconnect)
void	writeRecord(In record)

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

Methods inherited from interface org.apache.flink.api.common.io.OutputFormat

open

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(org.apache.flink.api.common.typeinfo.TypeInformation<?> type,
                         org.apache.flink.api.common.ExecutionConfig executionConfig)

Specified by:

setInputType in interface org.apache.flink.api.java.typeutils.InputTypeConfigurable

configure

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

Specified by:

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

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

Parameters:

taskNumber - The number of the parallel instance.

Throws:

IOException

writeRecord

public final void writeRecord(In record)
                       throws IOException

Specified by:

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

Throws:

IOException

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 org.apache.flink.api.common.io.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()