org.xbib.elasticsearch.river.jdbc

Interface RiverSource<RC extends RiverContext>

All Known Implementing Classes:

ColumnRiverSource, SimpleRiverSource

public interface RiverSource<RC extends RiverContext>

The river source models the data producing side

Method Summary

Methods

Modifier and Type	Method and Description
void	afterFetch() Executed after fetch() has been executed or threw an exception.
void	afterRows(ResultSet results, KeyValueStreamListener listener) Executed after all rows have been fetched from result set
void	afterRows(SQLCommand command, ResultSet results, KeyValueStreamListener listener) After the result set is processed, this method is called.
void	beforeFetch() Executed before fetch() is executed
void	beforeRows(ResultSet results, KeyValueStreamListener listener) Executed before rows are fetched from result set
void	beforeRows(SQLCommand command, ResultSet results, KeyValueStreamListener listener) This routine is executed before the result set is evaluated
RiverSource	bind(PreparedStatement statement, List<Object> values) Bind query variables
RiverSource	close(ResultSet result) Close result set
RiverSource	close(Statement statement) Close statement
RiverSource	closeReading() Close reading from this river source
RiverSource	closeWriting() Close writing to this river source
ResultSet	executeQuery(PreparedStatement statement) Execute query
ResultSet	executeQuery(Statement statement, String sql) Execute query without binding parameters
RiverSource	executeUpdate(PreparedStatement statement) Execute insert/update
RiverSource	executeUpdate(Statement statement, String sql) Execute insert update
void	fetch() Fetch a data portion from the database and pass it to the river task for firther processing.
Connection	getConnectionForReading() Get a connection for reading data
Connection	getConnectionForWriting() Get a connection for writing data
Locale	getLocale() Get the current locale
TimeZone	getTimeZone() Get the current timezone of this river source for the JDBC setTimestamp() call
RiverSource<RC>	newInstance() Create new river source instance
boolean	nextRow(ResultSet results, KeyValueStreamListener listener) Executed when next row is fetched from result set
boolean	nextRow(SQLCommand command, ResultSet results, KeyValueStreamListener listener) Action for the next row of the result set to be processed
Object	parseType(ResultSet results, Integer num, int type, Locale locale) Parse a value in a row column
PreparedStatement	prepareQuery(String sql) Prepare query statement
PreparedStatement	prepareUpdate(String sql) Prepare insert/update statement
RiverSource	register(CallableStatement statement, Map<String,Object> values) Register output variables for callable statement
void	resume() Resume river source
RiverSource	setLocale(Locale locale) Set the locale for JDBC
RiverSource	setPassword(String password) Set the password authentication
RiverSource	setRiverContext(RC context) Set the river context
RiverSource	setTimeZone(TimeZone timeZone) Set the timezone for JDBC setTimestamp() calls with calendar object.
RiverSource	setUrl(String url) Set JDBC connection URL
RiverSource	setUser(String user) Set the user authentication
void	shutdown() Shutdown source
String	strategy() The strategy this river source supports.
void	suspend() Suspend river source

Method Detail

strategy

String strategy()

The strategy this river source supports.

Returns:

the strategy as a string

newInstance

RiverSource<RC> newInstance()

Create new river source instance

Returns:

a new river source instance

setRiverContext

RiverSource setRiverContext(RC context)

Set the river context

Parameters:

context - the context

Returns:

this river source

beforeFetch

void beforeFetch()
                 throws Exception

Executed before fetch() is executed

Throws:

Exception

fetch

void fetch()
           throws Exception

Fetch a data portion from the database and pass it to the river task for firther processing.

Throws:

Exception - when execution gives an error

afterFetch

void afterFetch()
                throws Exception

Executed after fetch() has been executed or threw an exception.

Throws:

Exception

setUrl

RiverSource setUrl(String url)

Set JDBC connection URL

Parameters:

url - the JDBC connection URL

Returns:

this river source

setUser

RiverSource setUser(String user)

Set the user authentication

Parameters:

user - the user

Returns:

this river source

setPassword

RiverSource setPassword(String password)

Set the password authentication

Parameters:

password - the password

Returns:

this river source

getConnectionForReading

Connection getConnectionForReading()
                                   throws SQLException

Get a connection for reading data

Returns:

connection

Throws:

SQLException - when SQL execution gives an error

getConnectionForWriting

Connection getConnectionForWriting()
                                   throws SQLException

Get a connection for writing data

Returns:

connection

Throws:

SQLException - when SQL execution gives an error

prepareQuery

PreparedStatement prepareQuery(String sql)
                               throws SQLException

Prepare query statement

Parameters:

sql - SQL statement

Returns:

a prepared statement

Throws:

SQLException - when SQL execution gives an error

prepareUpdate

PreparedStatement prepareUpdate(String sql)
                                throws SQLException

Prepare insert/update statement

Parameters:

sql - SQL statement

Returns:

a prepared statement

Throws:

SQLException - when SQL execution gives an error

bind

RiverSource bind(PreparedStatement statement,
               List<Object> values)
                 throws SQLException

Bind query variables

Parameters:

statement - prepared statement

values - values

Returns:

this river source

Throws:

SQLException - when SQL execution gives an error

register

RiverSource register(CallableStatement statement,
                   Map<String,Object> values)
                     throws SQLException

Register output variables for callable statement

Parameters:

statement - callable statement

values - values

Returns:

this river source

Throws:

SQLException - when SQL execution gives an error

executeQuery

ResultSet executeQuery(PreparedStatement statement)
                       throws SQLException

Execute query

Parameters:

statement - prepared statement

Returns:

the result set

Throws:

SQLException - when SQL execution gives an error

executeQuery

ResultSet executeQuery(Statement statement,
                     String sql)
                       throws SQLException

Execute query without binding parameters

Parameters:

statement - the SQL statement

sql - the SQL query

Returns:

the result set

Throws:

SQLException - when SQL execution gives an error

executeUpdate

RiverSource executeUpdate(PreparedStatement statement)
                          throws SQLException

Execute insert/update

Parameters:

statement - statement

Returns:

this river source

Throws:

SQLException - when SQL execution gives an error

executeUpdate

RiverSource executeUpdate(Statement statement,
                        String sql)
                          throws SQLException

Execute insert update

Parameters:

statement - statement

sql - SQL query

Returns:

this river source

Throws:

SQLException

beforeRows

void beforeRows(ResultSet results,
              KeyValueStreamListener listener)
                throws SQLException,
                       IOException

Executed before rows are fetched from result set

Parameters:

results - the result set

listener - a result set listener or null

Throws:

SQLException

IOException

nextRow

boolean nextRow(ResultSet results,
              KeyValueStreamListener listener)
                throws SQLException,
                       IOException

Executed when next row is fetched from result set

Parameters:

results - the result set

listener - a result set listener or null

Returns:

true if next row could be processed, otherwise false

Throws:

SQLException

IOException

afterRows

void afterRows(ResultSet results,
             KeyValueStreamListener listener)
               throws SQLException,
                      IOException

Executed after all rows have been fetched from result set

Parameters:

results - the result set

listener - a result set listener or null

Throws:

SQLException

IOException

beforeRows

void beforeRows(SQLCommand command,
              ResultSet results,
              KeyValueStreamListener listener)
                throws SQLException,
                       IOException

This routine is executed before the result set is evaluated

Parameters:

command - the SQL command that created this result set

results - the result set

listener - listener for the key/value stream generated from the result set

Throws:

SQLException

IOException

nextRow

boolean nextRow(SQLCommand command,
              ResultSet results,
              KeyValueStreamListener listener)
                throws SQLException,
                       IOException

Action for the next row of the result set to be processed

Parameters:

results - result

listener - listener

Returns:

true if next row exists

Throws:

SQLException - when SQL execution gives an error

IOException - when input/output error occurs

afterRows

void afterRows(SQLCommand command,
             ResultSet results,
             KeyValueStreamListener listener)
               throws SQLException,
                      IOException

After the result set is processed, this method is called.

Parameters:

command - the SQL command that created this result set

results - the result set

listener - listener for the key/value stream generated from the result set

Throws:

SQLException

IOException

parseType

Object parseType(ResultSet results,
               Integer num,
               int type,
               Locale locale)
                 throws SQLException,
                        IOException,
                        ParseException

Parse a value in a row column

Parameters:

results - result set

num - position

type - type

locale - locale

Returns:

object

Throws:

SQLException - when SQL execution gives an error

IOException - when input/output error occurs

ParseException - if number format could not be parsed

close

RiverSource close(ResultSet result)
                  throws SQLException

Close result set

Parameters:

result - result set

Returns:

this river source

Throws:

SQLException - when SQL execution gives an error

close

RiverSource close(Statement statement)
                  throws SQLException

Close statement

Parameters:

statement - statement

Returns:

this river source

Throws:

SQLException - when SQL execution gives an error

closeReading

RiverSource closeReading()

Close reading from this river source

Returns:

this river source

closeWriting

RiverSource closeWriting()

Close writing to this river source

Returns:

this river source

setLocale

RiverSource setLocale(Locale locale)

Set the locale for JDBC

Parameters:

locale - locale

Returns:

this river source

getLocale

Locale getLocale()

Get the current locale

Returns:

the time zone

setTimeZone

RiverSource setTimeZone(TimeZone timeZone)

Set the timezone for JDBC setTimestamp() calls with calendar object.

Parameters:

timeZone - the time zone

Returns:

this river source

getTimeZone

TimeZone getTimeZone()

Get the current timezone of this river source for the JDBC setTimestamp() call

Returns:

the time zone

suspend

void suspend()
             throws Exception

Suspend river source

Throws:

Exception

resume

void resume()
            throws Exception

Resume river source

Throws:

Exception

shutdown

void shutdown()
              throws IOException

Shutdown source

Throws:

IOException