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

Class JDBCInputFormat<OUT extends Tuple>

java.lang.Object

org.apache.flink.api.java.io.jdbc.JDBCInputFormat<OUT>

Type Parameters:

OUT -

All Implemented Interfaces:

Serializable, InputFormat<OUT,InputSplit>, NonParallelInput, InputSplitSource<InputSplit>

public class JDBCInputFormat<OUT extends Tuple>
extends Object
implements InputFormat<OUT,InputSplit>, NonParallelInput

InputFormat to read data from a database and generate tuples. The InputFormat has to be configured using the supplied InputFormatBuilder.

See Also:

Tuple, DriverManager, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JDBCInputFormat.JDBCInputFormatBuilder

Constructor Summary

Constructors

Constructor and Description
JDBCInputFormat()

Method Summary

Modifier and Type	Method and Description
static JDBCInputFormat.JDBCInputFormatBuilder	buildJDBCInputFormat() A builder used to set parameters to the output format's configuration in a fluent way.
void	close() Closes all resources used.
void	configure(Configuration parameters)
InputSplit[]	createInputSplits(int minNumSplits)
InputSplitAssigner	getInputSplitAssigner(InputSplit[] inputSplits)
BaseStatistics	getStatistics(BaseStatistics cachedStatistics)
OUT	nextRecord(OUT tuple) Stores the next resultSet row in a tuple
void	open(InputSplit ignored) Connects to the source database and executes the query.
boolean	reachedEnd() Checks whether all data has been read.

Methods inherited from class java.lang.Object

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

Constructor Detail

JDBCInputFormat

public JDBCInputFormat()

Method Detail

configure

public void configure(Configuration parameters)

Specified by:

configure in interface InputFormat<OUT extends Tuple,InputSplit>

open

public void open(InputSplit ignored)
          throws IOException

Connects to the source database and executes the query.

Specified by:

open in interface InputFormat<OUT extends Tuple,InputSplit>

Parameters:

ignored -

Throws:

IOException

close

public void close()
           throws IOException

Closes all resources used.

Specified by:

close in interface InputFormat<OUT extends Tuple,InputSplit>

Throws:

IOException - Indicates that a resource could not be closed.

reachedEnd

public boolean reachedEnd()
                   throws IOException

Checks whether all data has been read.

Specified by:

reachedEnd in interface InputFormat<OUT extends Tuple,InputSplit>

Returns:

boolean value indication whether all data has been read.

Throws:

IOException

nextRecord

public OUT nextRecord(OUT tuple)
               throws IOException

Stores the next resultSet row in a tuple

Specified by:

nextRecord in interface InputFormat<OUT extends Tuple,InputSplit>

Parameters:

tuple -

Returns:

tuple containing next row

Throws:

IOException

getStatistics

public BaseStatistics getStatistics(BaseStatistics cachedStatistics)
                             throws IOException

Specified by:

getStatistics in interface InputFormat<OUT extends Tuple,InputSplit>

Throws:

IOException

createInputSplits

public InputSplit[] createInputSplits(int minNumSplits)
                               throws IOException

Specified by:

createInputSplits in interface InputFormat<OUT extends Tuple,InputSplit>

Specified by:

createInputSplits in interface InputSplitSource<InputSplit>

Throws:

IOException

getInputSplitAssigner

public InputSplitAssigner getInputSplitAssigner(InputSplit[] inputSplits)

Specified by:

getInputSplitAssigner in interface InputFormat<OUT extends Tuple,InputSplit>

Specified by:

getInputSplitAssigner in interface InputSplitSource<InputSplit>

buildJDBCInputFormat

public static JDBCInputFormat.JDBCInputFormatBuilder buildJDBCInputFormat()

A builder used to set parameters to the output format's configuration in a fluent way.

Returns:

builder