org.apache.flink.connector.jdbc.internal

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

java.lang.Object

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

org.apache.flink.connector.jdbc.internal.AbstractJdbcOutputFormat<In>

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

All Implemented Interfaces:

Flushable, Serializable, org.apache.flink.api.common.io.OutputFormat<In>

Direct Known Subclasses:

JdbcOutputFormat

@Internal
public class JdbcBatchingOutputFormat<In,JdbcIn,JdbcExec extends JdbcBatchStatementExecutor<JdbcIn>>
extends AbstractJdbcOutputFormat<In>

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	JdbcBatchingOutputFormat.Builder Builder for a JdbcBatchingOutputFormat.
static interface	JdbcBatchingOutputFormat.RecordExtractor<F,T> An interface to extract a value from given argument.
static interface	JdbcBatchingOutputFormat.StatementExecutorFactory<T extends JdbcBatchStatementExecutor<?>> A factory for creating JdbcBatchStatementExecutor instance.

Field Summary

Fields inherited from class org.apache.flink.connector.jdbc.internal.AbstractJdbcOutputFormat

connectionProvider, DEFAULT_FLUSH_INTERVAL_MILLS, DEFAULT_FLUSH_MAX_SIZE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected void	addToBatch(In original, JdbcIn extracted)
protected void	attemptFlush()
static JdbcBatchingOutputFormat.Builder	builder()
void	close() Executes prepared statement and closes all resources of this instance.
void	flush()
void	open(int taskNumber, int numTasks) Connects to the target database and initializes the prepared statement.
void	updateExecutor(boolean reconnect)
void	writeRecord(In record)

Methods inherited from class org.apache.flink.connector.jdbc.internal.AbstractJdbcOutputFormat

configure, getConnection

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

JdbcBatchingOutputFormat

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

Method Detail

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>

Overrides:

open in class AbstractJdbcOutputFormat<In>

Parameters:

taskNumber - The number of the parallel instance.

Throws:

IOException

writeRecord

public final void writeRecord(In record)
                       throws IOException

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

Overrides:

flush in class AbstractJdbcOutputFormat<In>

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>

Overrides:

close in class AbstractJdbcOutputFormat<In>

builder

public static JdbcBatchingOutputFormat.Builder builder()

updateExecutor

public void updateExecutor(boolean reconnect)
                    throws SQLException,
                           ClassNotFoundException

Throws:

SQLException

ClassNotFoundException