Package com.feedzai.commons.sql.abstraction.engine.impl

Class DB2Engine

java.lang.Object

com.feedzai.commons.sql.abstraction.engine.AbstractDatabaseEngine

com.feedzai.commons.sql.abstraction.engine.impl.DB2Engine

All Implemented Interfaces:

DatabaseEngine, AutoCloseable

public class DB2Engine
extends AbstractDatabaseEngine

DB2 specific database implementation.

Since:

2.0.0

Author:

Marco Jorge (marco.jorge@feedzai.com)

Field Summary

Fields inherited from class com.feedzai.commons.sql.abstraction.engine.AbstractDatabaseEngine

conn, currentSchema, DEFAULT_QUERY_EXCEPTION_HANDLER, dev, dialect, eh, entities, injector, logger, notificationLogger, properties, socketTimeoutExecutor, stmts, translator

Constructor Summary

Constructors

Constructor	Description
DB2Engine(PdbProperties properties)	Creates a new DB2 connection.

Method Summary

Modifier and Type	Method	Description
protected void	addColumn(DbEntity entity, DbColumn... columns)	Adds the column to an existent table.
protected void	addFks(DbEntity entity, Set<DbFk> fks)	Adds foreign key constraints to the table in the database that the provided entity represents.
protected void	addIndexes(DbEntity entity)	Add the desired indexes.
protected void	addPrimaryKey(DbEntity entity)	Add a primary key to the entity.
protected void	addSequences(DbEntity entity)	Adds the necessary sequences.
protected boolean	checkConnection(Connection conn)	Checks if the connection is alive.
protected MappedEntity	createPreparedStatementForInserts(DbEntity entity)	Creates and gets the prepared statement that will be used for insertions.
protected ResultIterator	createResultIterator(PreparedStatement ps)	Creates a specific ResultIterator for the engine in place given a prepared statement.
protected ResultIterator	createResultIterator(Statement statement, String sql)	Creates a specific ResultIterator given the engine implementation.
protected void	createTable(DbEntity entity)	Creates the table.
protected long	doPersist(PreparedStatement ps, MappedEntity me, boolean useAutoInc, int lastBindPosition)	DB engine specific auxiliary method for AbstractDatabaseEngine.persist(String, EntityEntry, boolean) to effectively perform the persist action.
protected void	dropColumn(DbEntity entity, String... columns)	Drops the column.
protected void	dropSequences(DbEntity entity)	Drops the sequences of the entity.
protected void	dropTable(DbEntity entity)	Drops the table.
protected int	entityToPreparedStatement(DbEntity entity, PreparedStatement ps, EntityEntry entry, boolean useAutoInc)	Translates the given entry entity to the prepared statement.
int	executeUpdate(String query)	Executes a native query.
Map<String,DbColumnType>	getMetadata(String schemaPattern, String tableNamePattern)	Gets the table metadata (table must be in the current schema).
String	getSchema()	Gets the schema being used in the current connection.
Class<? extends AbstractTranslator>	getTranslatorClass()	Gets the class that translates SQL bound to this engine.
boolean	isStringAggDistinctCapable()	Checks if the engine supports using DISTINCT inside a string aggregation.
void	setParameter(String name, int index, Object param)	Sets the parameter on the specified index.
void	setParameters(String name, Object... params)	Sets the parameters on the specified prepared statement.
protected void	setSchema(String schema)	Sets the schema for the current connection.
void	updateEntity(DbEntity entity)	Updates an entity in the engine.

Methods inherited from class com.feedzai.commons.sql.abstraction.engine.AbstractDatabaseEngine

addBatch, addEntity, addFks, beginTransaction, checkConnection, checkConnection, clearParameters, close, commentCharacter, commit, connect, containsEntity, createBatch, createBatch, createBatch, createBatch, createPreparedStatement, createPreparedStatement, createPreparedStatement, createPreparedStatement, createSelectStatement, dropEntity, dropEntity, dropFkQuery, dropFks, dropFks, dropView, duplicate, entityToPreparedStatementForBatch, escapeCharacter, executePS, executePSUpdate, executeUpdate, executeUpdateSilently, flush, getConnection, getDBProperties, getDialect, getEntities, getEntities, getFinalJdbcConnection, getImportedKeys, getMetadata, getPreparedStatementForPersist, getPrivateKey, getProperties, getPSIterator, getPSIterator, getPSResultSet, getQueryExceptionHandler, getQueryMetadata, getQueryMetadata, handleOperation, hasIdentityColumn, inject, isTransactionActive, iterator, iterator, iterator, iterator, iterator, iterator, loadEntity, objectToArray, persist, persist, preparedStatementExists, processResultIterator, query, query, query, query, reconnectExceptionally, removeEntity, removePreparedStatement, rollback, setExceptionHandler, setParameter, setParameterValues, setTransactionIsolation, toPdbType, translate, translateType

Methods inherited from class java.lang.Object

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

Constructor Detail

DB2Engine

public DB2Engine(PdbProperties properties)
          throws DatabaseEngineException

Creates a new DB2 connection.

Parameters:

properties - The properties for the database connection.

Throws:

DatabaseEngineException - When the connection fails.

Method Detail

getTranslatorClass

public Class<? extends AbstractTranslator> getTranslatorClass()

Description copied from class: AbstractDatabaseEngine

Gets the class that translates SQL bound to this engine.

Specified by:

getTranslatorClass in class AbstractDatabaseEngine

Returns:

The class that translates SQL bound to this engine.

entityToPreparedStatement

protected int entityToPreparedStatement(DbEntity entity,
                                        PreparedStatement ps,
                                        EntityEntry entry,
                                        boolean useAutoInc)
                                 throws DatabaseEngineException

Description copied from class: AbstractDatabaseEngine

Translates the given entry entity to the prepared statement.

Specified by:

entityToPreparedStatement in class AbstractDatabaseEngine

Parameters:

entity - The entity.

ps - The prepared statement.

entry - The entry.

Returns:

The position (1-based) of the last bind parameter that was filled in a prepared statement.

Throws:

DatabaseEngineException - if something occurs during the translation.

createTable

protected void createTable(DbEntity entity)
                    throws DatabaseEngineException

Description copied from class: AbstractDatabaseEngine

Creates the table.

Specified by:

createTable in class AbstractDatabaseEngine

Parameters:

entity - The entity.

Throws:

DatabaseEngineException - If something goes wrong while creating the table.

addPrimaryKey

protected void addPrimaryKey(DbEntity entity)
                      throws DatabaseEngineException

Description copied from class: AbstractDatabaseEngine

Add a primary key to the entity.

Specified by:

addPrimaryKey in class AbstractDatabaseEngine

Parameters:

entity - The entity.

Throws:

DatabaseEngineException - If something goes wrong while creating the table.

addIndexes

protected void addIndexes(DbEntity entity)
                   throws DatabaseEngineException

Description copied from class: AbstractDatabaseEngine

Add the desired indexes.

Specified by:

addIndexes in class AbstractDatabaseEngine

Parameters:

entity - The entity.

Throws:

DatabaseEngineException - If something goes wrong while creating the table.

addSequences

protected void addSequences(DbEntity entity)
                     throws DatabaseEngineException

Description copied from class: AbstractDatabaseEngine

Adds the necessary sequences.

Specified by:

addSequences in class AbstractDatabaseEngine

Parameters:

entity - The entity.

Throws:

DatabaseEngineException - If something goes wrong while creating the table.

executeUpdate

public int executeUpdate(String query)
                  throws DatabaseEngineException

Description copied from class: AbstractDatabaseEngine

Executes a native query.

Specified by:

executeUpdate in interface DatabaseEngine

Overrides:

executeUpdate in class AbstractDatabaseEngine

Parameters:

query - The query to execute.

Returns:

The number of rows updated.

Throws:

DatabaseEngineException - If something goes wrong executing the native query.

createPreparedStatementForInserts

protected MappedEntity createPreparedStatementForInserts(DbEntity entity)
                                                  throws DatabaseEngineException

Description copied from class: AbstractDatabaseEngine

Creates and gets the prepared statement that will be used for insertions.

Specified by:

createPreparedStatementForInserts in class AbstractDatabaseEngine

Parameters:

entity - The entity.

Throws:

DatabaseEngineException - If something goes wrong while creating the table.

dropSequences

protected void dropSequences(DbEntity entity)
                      throws DatabaseEngineException

Description copied from class: AbstractDatabaseEngine

Drops the sequences of the entity.

Specified by:

dropSequences in class AbstractDatabaseEngine

Parameters:

entity - The entity.

Throws:

DatabaseEngineException - If something goes wrong dropping the sequences.

dropTable

protected void dropTable(DbEntity entity)
                  throws DatabaseEngineException

Description copied from class: AbstractDatabaseEngine

Drops the table.

Specified by:

dropTable in class AbstractDatabaseEngine

Parameters:

entity - The entity.

Throws:

DatabaseEngineException - If something goes wrong dropping the sequences.

dropColumn

protected void dropColumn(DbEntity entity,
                          String... columns)
                   throws DatabaseEngineException

Description copied from class: AbstractDatabaseEngine

Drops the column.

Specified by:

dropColumn in class AbstractDatabaseEngine

Parameters:

entity - The entity.

columns - The column name to drop.

Throws:

DatabaseEngineException - If something goes wrong dropping the sequences.

updateEntity

public void updateEntity(DbEntity entity)
                  throws DatabaseEngineException

Description copied from class: AbstractDatabaseEngine

Updates an entity in the engine.

If the entity does not exist in the instance, the method AbstractDatabaseEngine.addEntity(DbEntity) will be invoked.

The engine will compare the entity with the AbstractDatabaseEngine.getMetadata(String) information and update the schema of the table.

ATTENTION: This method will only add new columns or drop removed columns in the database table. It will also drop and create foreign keys. Primary Keys, Indexes and column types changes will not be updated.

Specified by:

updateEntity in interface DatabaseEngine

Overrides:

updateEntity in class AbstractDatabaseEngine

Parameters:

entity - The entity to update.

Throws:

DatabaseEngineException - If something goes wrong while updating the entity.

addColumn

protected void addColumn(DbEntity entity,
                         DbColumn... columns)
                  throws DatabaseEngineException

Description copied from class: AbstractDatabaseEngine

Adds the column to an existent table.

Specified by:

addColumn in class AbstractDatabaseEngine

Parameters:

entity - The entity that represents the table.

columns - The db column to add.

Throws:

DatabaseEngineException - If something goes wrong adding columns.

doPersist

protected long doPersist(PreparedStatement ps,
                         MappedEntity me,
                         boolean useAutoInc,
                         int lastBindPosition)
                  throws Exception

Description copied from class: AbstractDatabaseEngine

DB engine specific auxiliary method for AbstractDatabaseEngine.persist(String, EntityEntry, boolean) to effectively perform the persist action.

Specified by:

doPersist in class AbstractDatabaseEngine

Parameters:

ps - The PreparedStatement to use in the persist operation

me - The mapped entity on which to persist.

useAutoInc - Whether to use autoInc.

lastBindPosition - The position (1-based) of the last bind parameter that was filled in the prepared statement.

Returns:

The ID of the auto generated value (0 if there's no auto generated value). If the table has more than 1 column with auto generated values, then it will return the first column found.

Throws:

Exception - if any problem occurs while persisting.

addFks

protected void addFks(DbEntity entity,
                      Set<DbFk> fks)
               throws DatabaseEngineException

Description copied from class: AbstractDatabaseEngine

Adds foreign key constraints to the table in the database that the provided entity represents.

Overrides:

addFks in class AbstractDatabaseEngine

Parameters:

entity - The entity.

fks - The foreign keys to be added.

Throws:

DatabaseEngineException - If something goes wrong creating the FKs.

checkConnection

protected boolean checkConnection(Connection conn)

Description copied from class: AbstractDatabaseEngine

Checks if the connection is alive.

Overrides:

checkConnection in class AbstractDatabaseEngine

Parameters:

conn - The connection to test.

Returns:

True if the connection is valid, false otherwise.

createResultIterator

protected ResultIterator createResultIterator(Statement statement,
                                              String sql)
                                       throws DatabaseEngineException

Description copied from class: AbstractDatabaseEngine

Creates a specific ResultIterator given the engine implementation.

Specified by:

createResultIterator in class AbstractDatabaseEngine

Parameters:

statement - The statement.

sql - The SQL sentence.

Returns:

An iterator for the specific engine.

Throws:

DatabaseEngineException - If a database access error occurs.

getSchema

public String getSchema()
                 throws DatabaseEngineException

Description copied from class: AbstractDatabaseEngine

Gets the schema being used in the current connection.

Overrides:

getSchema in class AbstractDatabaseEngine

Returns:

The current schema name or null if there is none.

Throws:

DatabaseEngineException - If a database access error occurs or this method is called on a closed connection.

setSchema

protected void setSchema(String schema)
                  throws DatabaseEngineException

Description copied from class: AbstractDatabaseEngine

Sets the schema for the current connection.

Overrides:

setSchema in class AbstractDatabaseEngine

Throws:

DatabaseEngineException - If schema doesn't exist, a database access error occurs or this method is called on a closed connection.

getMetadata

public Map<String,DbColumnType> getMetadata(String schemaPattern,
                                                  String tableNamePattern)
                                           throws DatabaseEngineException

Description copied from interface: DatabaseEngine

Gets the table metadata (table must be in the current schema).

Specified by:

getMetadata in interface DatabaseEngine

Overrides:

getMetadata in class AbstractDatabaseEngine

Parameters:

schemaPattern - A schema name pattern; must match the schema name as it is stored in the database; "" retrieves those without a schema; null means that the schema name should not be used to narrow the search.

tableNamePattern - A table name pattern; must match the table name as it is stored in the database.

Returns:

A representation of the table columns and types.

Throws:

DatabaseEngineException - If something occurs getting the metadata.

setParameters

public void setParameters(String name,
                          Object... params)
                   throws DatabaseEngineException,
                          ConnectionResetException

Description copied from interface: DatabaseEngine

Sets the parameters on the specified prepared statement.

Specified by:

setParameters in interface DatabaseEngine

Overrides:

setParameters in class AbstractDatabaseEngine

Parameters:

name - The prepared statement name.

params - The parameters to set.

Throws:

DatabaseEngineException - If something occurs setting the parameters.

ConnectionResetException - If the connection was reset while trying to set parameters.

setParameter

public void setParameter(String name,
                         int index,
                         Object param)
                  throws DatabaseEngineException,
                         ConnectionResetException

Description copied from interface: DatabaseEngine

Sets the parameter on the specified index.

Specified by:

setParameter in interface DatabaseEngine

Overrides:

setParameter in class AbstractDatabaseEngine

Parameters:

name - The prepared statement name.

index - The index to set.

param - The parameter to set.

Throws:

DatabaseEngineException - If something occurs setting the parameters.

ConnectionResetException - If the connection was reset while trying to set the parameter.

isStringAggDistinctCapable

public boolean isStringAggDistinctCapable()

Description copied from interface: DatabaseEngine

Checks if the engine supports using DISTINCT inside a string aggregation.

Returns:

true if the engine supports using DISTINCT inside a string aggregation, false otherwise.

createResultIterator

protected ResultIterator createResultIterator(PreparedStatement ps)
                                       throws DatabaseEngineException

Description copied from class: AbstractDatabaseEngine

Creates a specific ResultIterator for the engine in place given a prepared statement.

Specified by:

createResultIterator in class AbstractDatabaseEngine

Parameters:

ps - The prepared statement.

Returns:

The result iterator.

Throws:

DatabaseEngineException - If a database access error occurs.