Package org.apache.tika.pipes.emitter.jdbc

Class JDBCEmitter

java.lang.Object

org.apache.tika.pipes.emitter.AbstractEmitter

org.apache.tika.pipes.emitter.jdbc.JDBCEmitter

All Implemented Interfaces:

Closeable, AutoCloseable, Initializable, Emitter

public class JDBCEmitter
extends AbstractEmitter
implements Initializable, Closeable

This is only an initial, basic implementation of an emitter for JDBC.

It is currently NOT thread safe because of the shared prepared statement, and depending on the jdbc implementation because of the shared connection.

As of the 2.5.0 release, this is ALPHA version. There may be breaking changes in the future.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	JDBCEmitter.AttachmentStrategy
static enum	JDBCEmitter.MultivaluedFieldStrategy

Constructor Summary

Constructors

Constructor	Description
JDBCEmitter()

Method Summary

Modifier and Type	Method	Description
void	checkInitialization(InitializableProblemHandler problemHandler)
void	close()
void	emit(String emitKey, List<Metadata> metadataList)	This executes the emit with each call.
void	emit(List<? extends EmitData> emitData)	The default behavior is to call Emitter.emit(String, List) on each item.
void	initialize(Map<String,Param> params)
void	setAlterTable(String alterTable)	This is called immediately after the table is created.
void	setAttachmentStrategy(String attachmentStrategy)
void	setAttachmentStrategy(JDBCEmitter.AttachmentStrategy attachmentStrategy)
void	setConnection(String connection)
void	setCreateTable(String createTable)
void	setInsert(String insert)
void	setKeys(Map<String,String> keys)	The implementation of keys should be a LinkedHashMap because order matters!
void	setMaxRetries(int maxRetries)
void	setMaxStringLength(int maxStringLength)	Set the maximum string length in characters (not bytes).
void	setMultivaluedFieldDelimiter(String delimiter)	See setMultivaluedFieldDelimiter(String)
void	setMultivaluedFieldStrategy(String strategy)	This applies to fields of type 'string' or 'varchar'.
void	setMultivaluedFieldStrategy(JDBCEmitter.MultivaluedFieldStrategy multivaluedFieldStrategy)
void	setPostConnection(String postConnection)	This sql will be called immediately after the connection is made.

Methods inherited from class org.apache.tika.pipes.emitter.AbstractEmitter

getName, setName

Methods inherited from class java.lang.Object

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

Constructor Details

JDBCEmitter

public JDBCEmitter()

Method Details

setAlterTable

public void setAlterTable(String alterTable)

This is called immediately after the table is created. The purpose of this is to allow for adding a complex primary key or other constraint on the table after it is created.

Parameters:

alterTable -

setCreateTable

@Field
public void setCreateTable(String createTable)

setInsert

@Field
public void setInsert(String insert)

setConnection

@Field
public void setConnection(String connection)

setMaxStringLength

@Field
public void setMaxStringLength(int maxStringLength)

Set the maximum string length in characters (not bytes). This is applies only to fields with name "string" not to "varchar".

Parameters:

maxStringLength -

setMaxRetries

public void setMaxRetries(int maxRetries)

setPostConnection

@Field
public void setPostConnection(String postConnection)

This sql will be called immediately after the connection is made. This was initially added for setting pragmas on sqlite3, but may be used for other connection configuration in other dbs. Note: This is called before the table is created if it needs to be created.

Parameters:

postConnection -

setMultivaluedFieldStrategy

@Field
public void setMultivaluedFieldStrategy(String strategy)
                                 throws TikaConfigException

This applies to fields of type 'string' or 'varchar'. If there's a multivalued field in a metadata object, do you want the first value only or should we concatenate these with the setMultivaluedFieldDelimiter(String).

The default values as of 2.6.1 are JDBCEmitter.MultivaluedFieldStrategy.CONCATENATE and the default delimiter is ", "

Parameters:

strategy -

Throws:

TikaConfigException

setMultivaluedFieldStrategy

public void setMultivaluedFieldStrategy(JDBCEmitter.MultivaluedFieldStrategy multivaluedFieldStrategy)

setMultivaluedFieldDelimiter

@Field
public void setMultivaluedFieldDelimiter(String delimiter)

See setMultivaluedFieldDelimiter(String)

Parameters:

delimiter -

setKeys

@Field
public void setKeys(Map<String,String> keys)

The implementation of keys should be a LinkedHashMap because order matters!

Key is the name of the metadata field, value is the type of column: boolean, string, int, long

Parameters:

keys -

setAttachmentStrategy

public void setAttachmentStrategy(JDBCEmitter.AttachmentStrategy attachmentStrategy)

setAttachmentStrategy

@Field
public void setAttachmentStrategy(String attachmentStrategy)

emit

public void emit(String emitKey,
 List<Metadata> metadataList)
          throws IOException,
TikaEmitterException

This executes the emit with each call. For more efficient batch execution use emit(List).

Specified by:

emit in interface Emitter

Parameters:

emitKey - emit key

metadataList - list of metadata per file

Throws:

IOException

TikaEmitterException

emit

public void emit(List<? extends EmitData> emitData)
          throws IOException,
TikaEmitterException

Description copied from class: AbstractEmitter

The default behavior is to call Emitter.emit(String, List) on each item. Some implementations, e.g. Solr/ES/vespa, can benefit from subclassing this and emitting a bunch of docs at once.

Specified by:

emit in interface Emitter

Overrides:

emit in class AbstractEmitter

Throws:

IOException

TikaEmitterException

initialize

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

Specified by:

initialize in interface Initializable

Parameters:

params - params to use for initialization

Throws:

TikaConfigException

checkInitialization

public void checkInitialization(InitializableProblemHandler problemHandler)
                         throws TikaConfigException

Specified by:

checkInitialization in interface Initializable

Parameters:

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

Throws:

TikaConfigException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException