Package com.norconex.committer.sql

Class SqlCommitter

java.lang.Object

com.norconex.committer.core.AbstractCommitter<SqlCommitterConfig>

com.norconex.committer.core.batch.AbstractBatchCommitter<SqlCommitterConfig>

com.norconex.committer.sql.SqlCommitter

All Implemented Interfaces:

BatchConsumer, Committer, Configurable<SqlCommitterConfig>, AutoCloseable

public class SqlCommitter
extends AbstractBatchCommitter<SqlCommitterConfig>

Commit documents to an SQL table. Document metadata fields are mapped to table columns.

Handling of missing table/fields

By default, this Committer will throw an exception when trying to insert values into non-existing database table or fields. It is recommended you make sure your database table exists and the document fields being sent to the committer match your database fields.

Alternatively, you can provide the necessary SQLs to create a new table as well as new fields as needed using SqlCommitterConfig.setCreateTableSQL(String) and SqlCommitterConfig.setCreateFieldSQL(String) respectively. Make sure to use the following placeholder variables as needed in the provided SQL(s) table and field creation, respectively:

Table creation

{tableName}

Your table name, to be replaced with the value supplied with SqlCommitterConfig.setTableName(String).

{primaryKey}

Your table primary key field name, to be replaced with the value supplied with SqlCommitterConfig.setPrimaryKey(String).

Field creation

{fieldName}

A field name to be created if you provided an SQL for creating new fields.

Author:

Pascal Essiembre

Field Summary

Fields inherited from interface com.norconex.commons.lang.config.Configurable

PROPERTY

Constructor Summary

Constructors

Constructor	Description
SqlCommitter()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
protected void	closeBatchCommitter()	Subclasses can perform additional closing logic by overriding this method.
protected void	commitBatch(Iterator<CommitterRequest> it)	Commits the supplied batch.
boolean	equals(Object o)
SqlCommitterConfig	getConfiguration()
int	hashCode()
protected void	initBatchCommitter()	Subclasses can perform additional initialization by overriding this method.
String	toString()

Methods inherited from class com.norconex.committer.core.batch.AbstractBatchCommitter

consume, doClean, doClose, doDelete, doInit, doUpsert, getInitializedQueue

Methods inherited from class com.norconex.committer.core.AbstractCommitter

accept, applyFieldMappings, clean, close, delete, fireDebug, fireDebug, fireError, fireError, fireInfo, fireInfo, getCommitterContext, init, upsert

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

SqlCommitter

public SqlCommitter()

Method Details

initBatchCommitter

protected void initBatchCommitter()
                           throws CommitterException

Description copied from class: AbstractBatchCommitter

Subclasses can perform additional initialization by overriding this method. Default implementation does nothing. The committer context and committer queue will be already initialized when invoking AbstractCommitter.getCommitterContext() and AbstractBatchCommitter.getInitializedQueue(), respectively.

Overrides:

initBatchCommitter in class AbstractBatchCommitter<SqlCommitterConfig>

Throws:

CommitterException - error initializing

commitBatch

protected void commitBatch(Iterator<CommitterRequest> it)
                    throws CommitterException

Description copied from class: AbstractBatchCommitter

Commits the supplied batch.

Specified by:

commitBatch in class AbstractBatchCommitter<SqlCommitterConfig>

Parameters:

it - the batch to commit

Throws:

CommitterException - could not commit the batch

closeBatchCommitter

protected void closeBatchCommitter()
                            throws CommitterException

Description copied from class: AbstractBatchCommitter

Subclasses can perform additional closing logic by overriding this method. Default implementation does nothing.

Overrides:

closeBatchCommitter in class AbstractBatchCommitter<SqlCommitterConfig>

Throws:

CommitterException - error closing committer

equals

public boolean equals(Object o)

Overrides:

equals in class AbstractBatchCommitter<SqlCommitterConfig>

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class AbstractBatchCommitter<SqlCommitterConfig>

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractBatchCommitter<SqlCommitterConfig>

toString

public String toString()

Overrides:

toString in class AbstractBatchCommitter<SqlCommitterConfig>

getConfiguration

public SqlCommitterConfig getConfiguration()