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

Class JDBCInputFormat

java.lang.Object

org.apache.flink.api.common.io.GenericInputFormat<Record>

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

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

All Implemented Interfaces:

Serializable, InputFormat<Record,GenericInputSplit>, NonParallelInput, InputSplitSource<GenericInputSplit>

public class JDBCInputFormat
extends GenericInputFormat
implements NonParallelInput

InputFormat to read data from a database and generate PactReords. The InputFormat has to be configured with the query, and either all connection parameters or a complete database URL.Configuration The position of a value inside a Record is determined by the table returned.

See Also:

Configuration, Record, DriverManager, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JDBCInputFormat.NotTransformableSQLFieldException

Field Summary

Fields

Modifier and Type	Field and Description
String	DRIVER_KEY
String	PASSWORD_KEY
String	QUERY_KEY
String	URL_KEY
String	USERNAME_KEY

Fields inherited from class org.apache.flink.api.common.io.GenericInputFormat

partitionNumber

Constructor Summary

Constructors

Constructor and Description
JDBCInputFormat() Creates a non-configured JDBCInputFormat.
JDBCInputFormat(Configuration parameters, String query) Creates a JDBCInputFormat and configures it.
JDBCInputFormat(String driverName, String dbURL, String query) Creates a JDBCInputFormat and configures it.
JDBCInputFormat(String driverName, String dbURL, String username, String password, String query) Creates a JDBCInputFormat and configures it.

Method Summary

Modifier and Type	Method and Description
void	configure(Configuration parameters) Configures this JDBCInputFormat.
Record	nextRecord(Record record) Stores the next resultSet row in a Record
boolean	reachedEnd() Checks whether all data has been read.

Methods inherited from class org.apache.flink.api.common.io.GenericInputFormat

close, createInputSplits, getInputSplitAssigner, getStatistics, open

Methods inherited from class java.lang.Object

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

Field Detail

DRIVER_KEY

public final String DRIVER_KEY

See Also:

Constant Field Values

USERNAME_KEY

public final String USERNAME_KEY

See Also:

Constant Field Values

PASSWORD_KEY

public final String PASSWORD_KEY

See Also:

Constant Field Values

URL_KEY

public final String URL_KEY

See Also:

Constant Field Values

QUERY_KEY

public final String QUERY_KEY

See Also:

Constant Field Values

Constructor Detail

JDBCInputFormat

public JDBCInputFormat()

Creates a non-configured JDBCInputFormat. This format has to be configured using configure(configuration).

JDBCInputFormat

public JDBCInputFormat(String driverName,
                       String dbURL,
                       String username,
                       String password,
                       String query)

Creates a JDBCInputFormat and configures it.

Parameters:

driverName - JDBC-Drivename

dbURL - Formatted URL containing all connection parameters.

username -

password -

query - Query to execute.

JDBCInputFormat

public JDBCInputFormat(String driverName,
                       String dbURL,
                       String query)

Creates a JDBCInputFormat and configures it.

Parameters:

driverName - JDBC-Drivername

dbURL - Formatted URL containing all connection parameters.

query - Query to execute.

JDBCInputFormat

public JDBCInputFormat(Configuration parameters,
                       String query)

Creates a JDBCInputFormat and configures it.

Parameters:

parameters - Configuration with all connection parameters.

query - Query to execute.

Method Detail

configure

public void configure(Configuration parameters)

Configures this JDBCInputFormat. This includes setting the connection parameters (if necessary), establishing the connection and executing the query.

Specified by:

configure in interface InputFormat<Record,GenericInputSplit>

Overrides:

configure in class GenericInputFormat<Record>

Parameters:

parameters - Configuration containing all or no parameters.

reachedEnd

public boolean reachedEnd()

Checks whether all data has been read.

Specified by:

reachedEnd in interface InputFormat<Record,GenericInputSplit>

Returns:

boolean value indication whether all data has been read.

nextRecord

public Record nextRecord(Record record)

Stores the next resultSet row in a Record

Specified by:

nextRecord in interface InputFormat<Record,GenericInputSplit>

Parameters:

record - target Record

Returns:

boolean value indicating that the operation was successful