Package org.apache.tika.pipes.pipesiterator.jdbc

Class JDBCPipesIterator

java.lang.Object

org.apache.tika.config.ConfigBase

org.apache.tika.pipes.pipesiterator.PipesIterator

org.apache.tika.pipes.pipesiterator.jdbc.JDBCPipesIterator

All Implemented Interfaces:

Iterable<FetchEmitTuple>, Callable<Integer>, Initializable

public class JDBCPipesIterator
extends PipesIterator
implements Initializable

Iterates through a the results from a sql call via jdbc. This adds all columns (except for the 'fetchKeyColumn' and 'emitKeyColumn', if specified) to the metadata object.

• If a 'fetchKeyColumn' is specified, this will use that column's value as the fetchKey.
• If no 'fetchKeyColumn' is specified, this will send the metadata from the other columns.
• The 'fetchKeyColumn' value is not added to the metadata.

• An 'emitKeyColumn' must be specified
• The 'emitKeyColumn' value is not added to the metadata.

Field Summary

Fields inherited from class org.apache.tika.pipes.pipesiterator.PipesIterator

COMPLETED_SEMAPHORE, DEFAULT_MAX_WAIT_MS, DEFAULT_QUEUE_SIZE

Constructor Summary

Constructors

Constructor	Description
JDBCPipesIterator()

Method Summary

Modifier and Type	Method	Description
void	checkInitialization(InitializableProblemHandler problemHandler)
protected void	enqueue()
String	getSelect()
void	initialize(Map<String,Param> params)
void	setConnection(String connection)
void	setEmitKeyColumn(String fetchKeyColumn)
void	setFetchKeyColumn(String fetchKeyColumn)
void	setFetchKeyRangeEndColumn(String fetchKeyRangeEndColumn)
void	setFetchKeyRangeStartColumn(String fetchKeyRangeStartColumn)
void	setFetchSize(int fetchSize)
void	setIdColumn(String idColumn)
void	setQueryTimeoutSeconds(int seconds)
void	setSelect(String select)

Methods inherited from class org.apache.tika.pipes.pipesiterator.PipesIterator

build, call, getEmitterName, getFetcherName, getHandlerConfig, getOnParseException, iterator, setEmitterName, setFetcherName, setHandlerType, setMaxEmbeddedResources, setMaxWaitMs, setOnParseException, setOnParseException, setParseMode, setParseMode, setQueueSize, setThrowOnWriteLimitReached, setWriteLimit, tryToAdd

Methods inherited from class org.apache.tika.config.ConfigBase

buildComposite, buildComposite, buildSingle, buildSingle, configure, handleSettings

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

JDBCPipesIterator

public JDBCPipesIterator()

Method Detail

setIdColumn

@Field
public void setIdColumn(String idColumn)

setFetchKeyColumn

@Field
public void setFetchKeyColumn(String fetchKeyColumn)

setFetchKeyRangeStartColumn

@Field
public void setFetchKeyRangeStartColumn(String fetchKeyRangeStartColumn)

setFetchKeyRangeEndColumn

@Field
public void setFetchKeyRangeEndColumn(String fetchKeyRangeEndColumn)

setEmitKeyColumn

@Field
public void setEmitKeyColumn(String fetchKeyColumn)

setConnection

@Field
public void setConnection(String connection)

getSelect

public String getSelect()

setSelect

@Field
public void setSelect(String select)

setFetchSize

@Field
public void setFetchSize(int fetchSize)
                  throws TikaConfigException

Throws:

TikaConfigException

setQueryTimeoutSeconds

public void setQueryTimeoutSeconds(int seconds)

enqueue

protected void enqueue()
                throws InterruptedException,
                       IOException,
                       TimeoutException

Specified by:

enqueue in class PipesIterator

Throws:

InterruptedException

IOException

TimeoutException

initialize

public void initialize(Map<String,Param> params)
                throws TikaConfigException

Specified by:

initialize in interface Initializable

Overrides:

initialize in class PipesIterator

Parameters:

params - params to use for initialization

Throws:

TikaConfigException

checkInitialization

public void checkInitialization(InitializableProblemHandler problemHandler)
                         throws TikaConfigException

Specified by:

checkInitialization in interface Initializable

Overrides:

checkInitialization in class PipesIterator

Parameters:

problemHandler - if there is a problem and no custom initializableProblemHandler has been configured via Initializable parameters, this is called to respond.

Throws:

TikaConfigException