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

Class MySqlEngine

java.lang.Object

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

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

All Implemented Interfaces:

DatabaseEngine, AutoCloseable

public class MySqlEngine
extends AbstractDatabaseEngine

MySQL specific database implementation.

Since:

2.0.0

Author:

Rui Vilao (rui.vilao@feedzai.com)

Field Summary

Fields

Modifier and Type	Field	Description
static List<Integer>	CONSTRAINT_NAME_ALREADY_EXISTS	Foreign Key already exists.
static int	DUPLICATE_KEY_NAME	Duplicate key name
protected static String	MYSQL_DRIVER	The MySQL JDBC driver.
static QueryExceptionHandler	MYSQL_QUERY_EXCEPTION_HANDLER	An instance of QueryExceptionHandler specific for MySQL engine, to be used in disambiguating SQL exceptions.
static int	TABLE_CAN_ONLY_HAVE_ONE_PRIMARY_KEY	Table can have only one primary key.
static int	TABLE_DOES_NOT_EXIST	Table or view does not exist.
static int	TABLE_NAME_ALREADY_EXISTS	Table name is already used by an existing object.

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
MySqlEngine(PdbProperties properties)	Creates a new MySQL 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.
String	commentCharacter()
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 String	dropFkQuery(String table, String fkName)	Gets the query to drop a foreign key.
protected void	dropReferringFks(DbEntity entity)
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.
String	escapeCharacter()
Map<String,DbEntityType>	getEntities(String schemaPattern)	Gets the database entities for the specified schema.
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.
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.
protected void	setSchema(String schema)	Sets the schema for the current connection.

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

addBatch, addEntity, addFks, beginTransaction, checkConnection, checkConnection, checkConnection, clearParameters, close, commit, connect, containsEntity, createBatch, createBatch, createBatch, createBatch, createPreparedStatement, createPreparedStatement, createPreparedStatement, createPreparedStatement, createSelectStatement, dropEntity, dropEntity, dropFks, dropFks, dropView, duplicate, entityToPreparedStatementForBatch, executePS, executePSUpdate, executeUpdate, executeUpdate, executeUpdateSilently, flush, getConnection, getDBProperties, getDialect, getEntities, getFinalJdbcConnection, getImportedKeys, getMetadata, getPrivateKey, getProperties, getPSIterator, getPSIterator, getPSResultSet, 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, setParameter, setParameters, setParameterValues, setTransactionIsolation, toPdbType, translate, translateType, updateEntity

Methods inherited from class java.lang.Object

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

Field Detail

MYSQL_DRIVER

protected static final String MYSQL_DRIVER

The MySQL JDBC driver.

TABLE_NAME_ALREADY_EXISTS

public static final int TABLE_NAME_ALREADY_EXISTS

Table name is already used by an existing object.

See Also:

Constant Field Values

DUPLICATE_KEY_NAME

public static final int DUPLICATE_KEY_NAME

Duplicate key name

See Also:

Constant Field Values

TABLE_CAN_ONLY_HAVE_ONE_PRIMARY_KEY

public static final int TABLE_CAN_ONLY_HAVE_ONE_PRIMARY_KEY

Table can have only one primary key.

See Also:

Constant Field Values

TABLE_DOES_NOT_EXIST

public static final int TABLE_DOES_NOT_EXIST

Table or view does not exist.

See Also:

Constant Field Values

CONSTRAINT_NAME_ALREADY_EXISTS

public static final List<Integer> CONSTRAINT_NAME_ALREADY_EXISTS

Foreign Key already exists.

MYSQL_QUERY_EXCEPTION_HANDLER

public static final QueryExceptionHandler MYSQL_QUERY_EXCEPTION_HANDLER

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

Since:

2.5.1

Constructor Detail

MySqlEngine

public MySqlEngine(PdbProperties properties)
            throws DatabaseEngineException

Creates a new MySQL connection.

Parameters:

properties - The properties for the database connection.

Throws:

DatabaseEngineException - When the connection fails.

Method Detail

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.

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.

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.

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.

dropFkQuery

protected String dropFkQuery(String table,
                             String fkName)

Description copied from class: AbstractDatabaseEngine

Gets the query to drop a foreign key.

Overrides:

dropFkQuery in class AbstractDatabaseEngine

Parameters:

table - The table name.

fkName - The foreign key name.

Returns:

The query to drop the foreign key.

dropReferringFks

protected void dropReferringFks(DbEntity entity)
                         throws DatabaseEngineException

Throws:

DatabaseEngineException

getEntities

public Map<String,DbEntityType> getEntities(String schemaPattern)
                                           throws DatabaseEngineException

Description copied from interface: DatabaseEngine

Gets the database entities for the specified schema.

Specified by:

getEntities in interface DatabaseEngine

Overrides:

getEntities 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.

Returns:

The list of database entities and types (tables, views, and so on).

Throws:

DatabaseEngineException - If something occurs getting the existing tables.

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.

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.

commentCharacter

public String commentCharacter()

Specified by:

commentCharacter in interface DatabaseEngine

Overrides:

commentCharacter in class AbstractDatabaseEngine

Returns:

The comment character of this engine implementation.

escapeCharacter

public String escapeCharacter()

Specified by:

escapeCharacter in interface DatabaseEngine

Overrides:

escapeCharacter in class AbstractDatabaseEngine

Returns:

The escape character of this engine implementation.

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.