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

Class OracleEngine

java.lang.Object

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

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

All Implemented Interfaces:

DatabaseEngine, AutoCloseable

public class OracleEngine
extends AbstractDatabaseEngine

Oracle specific database implementation.

Since:

2.0.0

Author:

Rui Vilao (rui.vilao@feedzai.com)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	OracleEngine.Action0 Represents an action that can throw any exception.

Field Summary

Fields

Modifier and Type	Field and Description
static String	FOREIGN_ALREADY_EXISTS Foreign key already exists
static String	NAME_ALREADY_EXISTS Name is already used by an existing object.
protected static String	ORACLE_DRIVER The Oracle JDBC driver.
static QueryExceptionHandler	ORACLE_QUERY_EXCEPTION_HANDLER An instance of QueryExceptionHandler specific for Oracle engine, to be used in disambiguating SQL exceptions.
static String	SEQUENCE_DOES_NOT_EXIST Sequence does not exist.
static String	TABLE_CAN_ONLY_HAVE_ONE_PRIMARY_KEY Table can have only one primary key.
static String	TABLE_OR_VIEW_DOES_NOT_EXIST Table or view does not exist.

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 and Description
OracleEngine(PdbProperties properties) Creates a new Oracle connection.

Method Summary

Modifier and Type	Method and 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 void	connect() Connects to the database.
void	createPreparedStatement(String name, Expression query) Creates a prepared statement.
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.
void	flush() Flushes the batches for all the registered entities.
protected Properties	getDBProperties() Get the properties to be passed to the database connection that will be created.
protected ResultSet	getImportedKeys(String entityName) Gets a description of the columns that are referenced by the given table's foreign key columns.
Map<String,DbColumnType>	getMetadata(String schemaPattern, String tableNamePattern) Gets the table metadata (table must be in the current schema).
protected PreparedStatement	getPreparedStatementForPersist(boolean useAutoInc, MappedEntity mappedEntity) Gets the PreparedStatement to use in a persist operation, depending on whether autoInc is to be used or not.
protected QueryExceptionHandler	getQueryExceptionHandler() Gets the instance of QueryExceptionHandler to be used in disambiguating SQL exceptions.
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	setParameterValues(PreparedStatement ps, int index, Object param) Sets the value of a parameter in index to the value provided in param.
protected void	setPreparedStatementValue(PreparedStatement ps, int index, DbColumn dbColumn, Object value, boolean fromBatch) Sets a value in the prepared statement.
protected void	setTransactionIsolation() Overrides AbstractDatabaseEngine.setTransactionIsolation() This is because Oracle does not support READ_UNCOMMITTED e REPEATABLE_READ.

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

addBatch, addEntity, addFks, beginTransaction, checkConnection, checkConnection, checkConnection, clearParameters, close, commentCharacter, commit, containsEntity, createBatch, createBatch, createBatch, createBatch, createBatch, createBatch, createPreparedStatement, createPreparedStatement, createPreparedStatement, createSelectStatement, dropEntity, dropEntity, dropFkQuery, dropFks, dropFks, dropView, duplicate, entityToPreparedStatement, entityToPreparedStatementForBatch, entityToPreparedStatementInternal, escapeCharacter, executePS, executePSUpdate, executeUpdate, executeUpdate, executeUpdateSilently, getConnection, getDialect, getEntities, getEntities, getFinalJdbcConnection, getMetadata, getPrivateKey, getProperties, getPSIterator, getPSIterator, getPSResultSet, getQueryMetadata, getQueryMetadata, getSchema, handleOperation, hasIdentityColumn, inject, isTransactionActive, iterator, iterator, iterator, iterator, iterator, iterator, loadEntity, objectToArray, onConnectionCreated, persist, persist, preparedStatementExists, processResultIterator, query, query, query, query, reconnectExceptionally, removeEntity, removePreparedStatement, rollback, setExceptionHandler, setParameter, setSchema, toPdbType, translate, translateType, updateEntity

Methods inherited from class java.lang.Object

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

Field Detail

ORACLE_DRIVER

protected static final String ORACLE_DRIVER

The Oracle JDBC driver.

NAME_ALREADY_EXISTS

public static final String NAME_ALREADY_EXISTS

Name is already used by an existing object.

See Also:

Constant Field Values

TABLE_CAN_ONLY_HAVE_ONE_PRIMARY_KEY

public static final String TABLE_CAN_ONLY_HAVE_ONE_PRIMARY_KEY

Table can have only one primary key.

See Also:

Constant Field Values

SEQUENCE_DOES_NOT_EXIST

public static final String SEQUENCE_DOES_NOT_EXIST

Sequence does not exist.

See Also:

Constant Field Values

TABLE_OR_VIEW_DOES_NOT_EXIST

public static final String TABLE_OR_VIEW_DOES_NOT_EXIST

Table or view does not exist.

See Also:

Constant Field Values

FOREIGN_ALREADY_EXISTS

public static final String FOREIGN_ALREADY_EXISTS

Foreign key already exists

See Also:

Constant Field Values

ORACLE_QUERY_EXCEPTION_HANDLER

public static final QueryExceptionHandler ORACLE_QUERY_EXCEPTION_HANDLER

An instance of QueryExceptionHandler specific for Oracle engine, to be used in disambiguating SQL exceptions.

Since:

2.5.1

Constructor Detail

OracleEngine

public OracleEngine(PdbProperties properties)
             throws DatabaseEngineException

Creates a new Oracle connection.

Parameters:

properties - The properties for the database connection.

Throws:

DatabaseEngineException - When the connection fails.

Method Detail

getDBProperties

protected Properties getDBProperties()

Description copied from class: AbstractDatabaseEngine

Get the properties to be passed to the database connection that will be created. Since these properties are specific to the database engine, it is up to the AbstractDatabaseEngine implementation to specify them. This is used, for instance, to set the database connection timeout.

Overrides:

getDBProperties in class AbstractDatabaseEngine

Returns:

the properties of the connection to the database.

connect

protected void connect()
                throws Exception

Description copied from class: AbstractDatabaseEngine

Connects to the database.

Overrides:

connect in class AbstractDatabaseEngine

Throws:

Exception - If connection is not possible, or failed to decrypt username/password if encryption was provided.

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.

flush

public void flush()
           throws DatabaseEngineException

Description copied from class: AbstractDatabaseEngine

Flushes the batches for all the registered entities.

Specified by:

flush in interface DatabaseEngine

Overrides:

flush in class AbstractDatabaseEngine

Throws:

DatabaseEngineException - If something goes wrong while persisting data.

setPreparedStatementValue

protected void setPreparedStatementValue(PreparedStatement ps,
                                         int index,
                                         DbColumn dbColumn,
                                         Object value,
                                         boolean fromBatch)
                                  throws Exception

Description copied from class: AbstractDatabaseEngine

Sets a value in the prepared statement.

Overrides:

setPreparedStatementValue in class AbstractDatabaseEngine

Parameters:

ps - The prepared statement.

index - The index of the value to set in the prepared statement.

dbColumn - The DbColumn for which to set the value in the prepared statement.

value - The value to set.

fromBatch - Whether this translation is to be done in the context of a batch update.

Throws:

Exception - If something wrong occurs setting the value.

setParameterValues

protected void setParameterValues(PreparedStatement ps,
                                  int index,
                                  Object param)
                           throws SQLException

Description copied from class: AbstractDatabaseEngine

Sets the value of a parameter in index to the value provided in param.

Overrides:

setParameterValues in class AbstractDatabaseEngine

Parameters:

ps - The PreparedStatement to insert the association between index and the param.

index - The index to set the value to.

param - The value to be set at the provided index.

Throws:

SQLException - If something goes wrong accessing the database.

setTransactionIsolation

protected void setTransactionIsolation()
                                throws SQLException

Overrides AbstractDatabaseEngine.setTransactionIsolation() This is because Oracle does not support READ_UNCOMMITTED e REPEATABLE_READ.

Overrides:

setTransactionIsolation in class AbstractDatabaseEngine

Throws:

SQLException - If a database access error occurs.

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.

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.

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.

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.

createPreparedStatement

public void createPreparedStatement(String name,
                                    Expression query)
                             throws NameAlreadyExistsException,
                                    DatabaseEngineException

Description copied from interface: DatabaseEngine

Creates a prepared statement.

Specified by:

createPreparedStatement in interface DatabaseEngine

Overrides:

createPreparedStatement in class AbstractDatabaseEngine

Parameters:

name - The prepared statement name.

query - The query.

Throws:

NameAlreadyExistsException - If the name already exists.

DatabaseEngineException - If something goes wrong creating the statement.

getPreparedStatementForPersist

protected PreparedStatement getPreparedStatementForPersist(boolean useAutoInc,
                                                           MappedEntity mappedEntity)

Description copied from class: AbstractDatabaseEngine

Gets the PreparedStatement to use in a persist operation, depending on whether autoInc is to be used or not.

Overrides:

getPreparedStatementForPersist in class AbstractDatabaseEngine

Parameters:

useAutoInc - Whether to use autoInc.

mappedEntity - The mapped entity for which to get the prepared statement.

Returns:

the PreparedStatement.

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.

getImportedKeys

protected ResultSet getImportedKeys(String entityName)
                             throws SQLException

Description copied from class: AbstractDatabaseEngine

Gets a description of the columns that are referenced by the given table's foreign key columns.

Overrides:

getImportedKeys in class AbstractDatabaseEngine

Parameters:

entityName - The entity name.

Returns:

A ResultSet containing information about columns referenced by a foreign key.

Throws:

SQLException - If a database access error occurs when getting key information.

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.

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.

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.

getQueryExceptionHandler

protected QueryExceptionHandler getQueryExceptionHandler()

Description copied from class: AbstractDatabaseEngine

Gets the instance of QueryExceptionHandler to be used in disambiguating SQL exceptions.

Overrides:

getQueryExceptionHandler in class AbstractDatabaseEngine

Returns:

the QueryExceptionHandler.