org.xbib.elasticsearch.river.jdbc

Interface RiverContext

All Known Implementing Classes:

ColumnRiverContext, SimpleRiverContext

public interface RiverContext

The River Context is a collection of objects that are relevant to parameterization of a river run. Beside holding references to river definition, source and mouth, the objects control the behavior of the river source.

Method Summary

Methods

Modifier and Type	Method and Description
Map<String,Object>	getDefinition() Get river instance definition
org.elasticsearch.common.metrics.MeterMetric	getMetric() Get metric
RiverMouth	getRiverMouth() Get river mouth
RiverSource	getRiverSource() Get river source
RiverState	getRiverState() Get river state
RiverContext	release() Release all resources
RiverContext	setAutoCommit(boolean autocommit) Set auto commit
RiverContext	setColumnNameMap(Map<String,Object> columnNameMap) Set column name map.
RiverContext	setConnectionProperties(Map<String,Object> connectionProperties) Optional JDBC connection properties
RiverContext	setDefinition(Map<String,Object> definition) Set river instance definition
RiverContext	setFetchSize(int fetchSize) Set fetch size
RiverContext	setMaxRetryWait(org.elasticsearch.common.unit.TimeValue maxretrywait) Set maximum count of retries
RiverContext	setMaxRows(int maxRows) Set max rows
RiverContext	setMetric(org.elasticsearch.common.metrics.MeterMetric metric) Set metric
RiverContext	setQueryTimeout(int queryTimeout) Set result set query timeout
RiverContext	setResultSetConcurrency(String resultSetConcurrency) Set result set concurrency
RiverContext	setResultSetType(String resultSetType) Set result set type
RiverContext	setRetries(int retries) Set retries
RiverContext	setRiverMouth(RiverMouth riverMouth) Set river mouth
RiverContext	setRiverSource(RiverSource riverSource) Set river source
RiverContext	setRiverState(RiverState riverState) Set river state
RiverContext	setRounding(String rounding) Set rounding of big decimal values.
RiverContext	setScale(int scale) Set scale of big decimal values.
RiverContext	setStatements(List<SQLCommand> sql) Set the list of SQL statements
RiverContext	shouldIgnoreNull(boolean shouldIgnoreNull) Should null values in columns be ignored for indexing
RiverContext	shouldPrepareDatabaseMetadata(boolean shouldPrepareDatabaseMetadata) Should database metadata be used in parameter variables
RiverContext	shouldPrepareResultSetMetadata(boolean shouldPrepareResultSetMetadata) Should result set metadata be used in parameter variables
RiverContext	shouldTreatBinaryAsString(boolean shouldTreatBinaryAsString) Should binary types (byte arrays) be treated as JSON strings

Method Detail

setDefinition

RiverContext setDefinition(Map<String,Object> definition)

Set river instance definition

Parameters:

definition - the river instance definition

Returns:

this context

getDefinition

Map<String,Object> getDefinition()

Get river instance definition

Returns:

river instance definition

setRiverState

RiverContext setRiverState(RiverState riverState)

Set river state

Parameters:

riverState - the river state

Returns:

this context

getRiverState

RiverState getRiverState()

Get river state

Returns:

the river state

setRiverSource

RiverContext setRiverSource(RiverSource riverSource)

Set river source

Parameters:

riverSource - the river source

Returns:

this context

getRiverSource

RiverSource getRiverSource()

Get river source

Returns:

the river source

setRiverMouth

RiverContext setRiverMouth(RiverMouth riverMouth)

Set river mouth

Parameters:

riverMouth - the river mouth

Returns:

this context

getRiverMouth

RiverMouth getRiverMouth()

Get river mouth

Returns:

the river mouth

setMetric

RiverContext setMetric(org.elasticsearch.common.metrics.MeterMetric metric)

Set metric

Parameters:

metric - the meter metric

Returns:

this context

getMetric

org.elasticsearch.common.metrics.MeterMetric getMetric()

Get metric

Returns:

metric

setScale

RiverContext setScale(int scale)

Set scale of big decimal values. See java.math.BigDecimal#setScale

Parameters:

scale - the scale of big decimal values

Returns:

this context

setRounding

RiverContext setRounding(String rounding)

Set rounding of big decimal values. See java.math.BigDecimal#setScale

Parameters:

rounding - the rounding of big decimal values

Returns:

this river context

setStatements

RiverContext setStatements(List<SQLCommand> sql)

Set the list of SQL statements

Parameters:

sql - the list of SQL statements

Returns:

this river context

setAutoCommit

RiverContext setAutoCommit(boolean autocommit)

Set auto commit

Parameters:

autocommit - true if automatic commit should be performed

Returns:

this river context

setMaxRows

RiverContext setMaxRows(int maxRows)

Set max rows

Parameters:

maxRows - max rows

Returns:

this river context

setFetchSize

RiverContext setFetchSize(int fetchSize)

Set fetch size

Parameters:

fetchSize - fetch size

Returns:

this river context

setRetries

RiverContext setRetries(int retries)

Set retries

Parameters:

retries - number of retries

Returns:

this river context

setMaxRetryWait

RiverContext setMaxRetryWait(org.elasticsearch.common.unit.TimeValue maxretrywait)

Set maximum count of retries

Parameters:

maxretrywait - maximum count of retries

Returns:

this river context

setResultSetType

RiverContext setResultSetType(String resultSetType)

Set result set type

Parameters:

resultSetType - result set type

Returns:

this river context

setResultSetConcurrency

RiverContext setResultSetConcurrency(String resultSetConcurrency)

Set result set concurrency

Parameters:

resultSetConcurrency - result set concurrency

Returns:

this river context

shouldIgnoreNull

RiverContext shouldIgnoreNull(boolean shouldIgnoreNull)

Should null values in columns be ignored for indexing

Parameters:

shouldIgnoreNull - true if null values in columns should be ignored for indexing

Returns:

this river context

shouldPrepareResultSetMetadata

RiverContext shouldPrepareResultSetMetadata(boolean shouldPrepareResultSetMetadata)

Should result set metadata be used in parameter variables

Parameters:

shouldPrepareResultSetMetadata - true if result set metadata should be used in parameter variables

Returns:

this river context

shouldPrepareDatabaseMetadata

RiverContext shouldPrepareDatabaseMetadata(boolean shouldPrepareDatabaseMetadata)

Should database metadata be used in parameter variables

Parameters:

shouldPrepareDatabaseMetadata - true if database metadata should be used in parameter variables

Returns:

this river context

setQueryTimeout

RiverContext setQueryTimeout(int queryTimeout)

Set result set query timeout

Parameters:

queryTimeout - the query timeout in seconds

Returns:

this river context

setConnectionProperties

RiverContext setConnectionProperties(Map<String,Object> connectionProperties)

Optional JDBC connection properties

Parameters:

connectionProperties - connection properties

Returns:

this river context

setColumnNameMap

RiverContext setColumnNameMap(Map<String,Object> columnNameMap)

Set column name map. Useful for expanding shortcolumn names to longer variants.

Parameters:

columnNameMap - the column name map

Returns:

this river context

shouldTreatBinaryAsString

RiverContext shouldTreatBinaryAsString(boolean shouldTreatBinaryAsString)

Should binary types (byte arrays) be treated as JSON strings

Parameters:

shouldTreatBinaryAsString - true if binary types (byte arrays) should be treated as JSON strings

Returns:

this river context

release

RiverContext release()

Release all resources

Returns:

this river context