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, java.lang.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 and Description
static java.util.List<java.lang.Integer>	CONSTRAINT_NAME_ALREADY_EXISTS Foreign Key already exists.
static int	DUPLICATE_KEY_NAME Duplicate key name
protected static java.lang.String	MYSQL_DRIVER The MySQL JDBC driver.
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, dev, dialect, eh, entities, injector, logger, notificationLogger, properties, stmts, translator

Constructor Summary

Constructors

Constructor and Description
MySqlEngine(PdbProperties properties) Creates a new MySQL 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) Adds the FKs.
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(java.sql.Connection conn) Checks if the connection is alive.
java.lang.String	commentCharacter()
protected MappedEntity	createPreparedStatementForInserts(DbEntity entity) Creates and gets the prepared statement that will be used for insertions.
protected ResultIterator	createResultIterator(java.sql.PreparedStatement ps) Creates a specific ResultIterator for the engine in place given given prepared statement.
protected ResultIterator	createResultIterator(java.sql.Statement statement, java.lang.String sql) Creates a specific ResultIterator given the engine implementation.
protected void	createTable(DbEntity entity) Creates the table.
protected void	dropColumn(DbEntity entity, java.lang.String... columns) Drops the column.
protected void	dropFks(java.lang.String table) Drops this table foreign keys.
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, java.sql.PreparedStatement ps, EntityEntry entry, boolean useAutoInc) Translates the given entry entity to the prepared statement.
java.lang.String	escapeCharacter()
java.util.Map<java.lang.String,DbEntityType>	getEntities(java.lang.String schemaPattern) Gets the database entities for the specified schema.
java.util.Map<java.lang.String,DbColumnType>	getMetadata(java.lang.String schemaPattern, java.lang.String tableNamePattern) Gets the table metadata (table must be in the current schema).
protected java.lang.String	getSchema() Gets the schema being used in the current connection.
java.lang.Class<? extends AbstractTranslator>	getTranslatorClass() Gets the class that translates SQL bound to this engine.
ResultIterator	iterator(java.lang.String query) Creates an iterator for the given SQL sentence.
java.lang.Long	persist(java.lang.String name, EntityEntry entry) Persists a given entry.
java.lang.Long	persist(java.lang.String name, EntityEntry entry, boolean useAutoInc) Persists a given entry.
protected void	setSchema(java.lang.String schema) Sets the schema for the current connection.
protected java.lang.String	translateType(DbColumn c) Translates the type present in the given column.

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

addBatch, addEntity, beginTransaction, checkConnection, checkConnection, clearParameters, close, commit, connect, containsEntity, createBatch, createBatch, createBatch, createPreparedStatement, createPreparedStatement, createPreparedStatement, createPreparedStatement, dropEntity, dropEntity, duplicate, executePS, executePSUpdate, executeUpdate, executeUpdate, executeUpdateSilently, flush, getConnection, getDialect, getEntities, getFinalJdbcConnection, getMetadata, getPrivateKey, getProperties, getPSIterator, getPSIterator, getPSResultSet, getQueryMetadata, getQueryMetadata, handleOperation, hasIdentityColumn, inject, isTransactionActive, iterator, iterator, iterator, loadEntity, objectToArray, preparedStatementExists, processResultIterator, query, query, removeEntity, removePreparedStatement, rollback, setExceptionHandler, setParameter, setParameter, setParameters, setParameterValues, setTransactionIsolation, toPdbType, translate, 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 java.lang.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 java.util.List<java.lang.Integer> CONSTRAINT_NAME_ALREADY_EXISTS

Foreign Key already exists.

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,
                                        java.sql.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 prepared statement filled in.

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,
                          java.lang.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.

translateType

protected java.lang.String translateType(DbColumn c)
                                  throws DatabaseEngineException

Description copied from class: AbstractDatabaseEngine

Translates the type present in the given column.

Specified by:

translateType in class AbstractDatabaseEngine

Parameters:

c - The column.

Returns:

The translation.

Throws:

DatabaseEngineException - If the type cannot be found.

getTranslatorClass

public java.lang.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.

persist

public java.lang.Long persist(java.lang.String name,
                              EntityEntry entry)
                       throws DatabaseEngineException

Description copied from class: AbstractDatabaseEngine

Persists a given entry. Persisting a query implies executing the statement.

If you are inside of an explicit transaction, changes will only be visible upon explicit commit, otherwise a commit will immediately take place.

Specified by:

persist in interface DatabaseEngine

Specified by:

persist in class AbstractDatabaseEngine

Parameters:

name - The entity name.

entry - The entry to persist.

Returns:

The ID of the auto generated value, null if there's no auto generated value.

Throws:

DatabaseEngineException - If something goes wrong while persisting data.

persist

public java.lang.Long persist(java.lang.String name,
                              EntityEntry entry,
                              boolean useAutoInc)
                       throws DatabaseEngineException

Description copied from class: AbstractDatabaseEngine

Persists a given entry. Persisting a query implies executing the statement. If define useAutoInc as false, PDB will disable the auto increments for the current insert and advance the sequences if needed.

If you are inside of an explicit transaction, changes will only be visible upon explicit commit, otherwise a commit will immediately take place.

Specified by:

persist in interface DatabaseEngine

Specified by:

persist in class AbstractDatabaseEngine

Parameters:

name - The entity name.

entry - The entry to persist.

useAutoInc - Use or not the autoinc.

Returns:

The ID of the auto generated value, null if there's no auto generated value.

Throws:

DatabaseEngineException - If something goes wrong while persisting data.

addFks

protected void addFks(DbEntity entity)
               throws DatabaseEngineException

Description copied from class: AbstractDatabaseEngine

Adds the FKs.

Specified by:

addFks in class AbstractDatabaseEngine

Parameters:

entity - The entity.

Throws:

DatabaseEngineException - If something goes wrong creating the FKs.

dropFks

protected void dropFks(java.lang.String table)
                throws DatabaseEngineException

Description copied from class: AbstractDatabaseEngine

Drops this table foreign keys.

Overrides:

dropFks in class AbstractDatabaseEngine

Parameters:

table - The table name.

Throws:

DatabaseEngineException - If something goes wrong dropping the FKs.

dropReferringFks

protected void dropReferringFks(DbEntity entity)
                         throws DatabaseEngineException

Throws:

DatabaseEngineException

getEntities

public java.util.Map<java.lang.String,DbEntityType> getEntities(java.lang.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.

checkConnection

protected boolean checkConnection(java.sql.Connection conn)

Description copied from class: AbstractDatabaseEngine

Checks if the connection is alive.

Specified by:

checkConnection in class AbstractDatabaseEngine

Parameters:

conn - The connection to test.

Returns:

True if the connection is valid, false otherwise.

getSchema

protected java.lang.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(java.lang.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 java.util.Map<java.lang.String,DbColumnType> getMetadata(java.lang.String schemaPattern,
                                                                java.lang.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.

iterator

public ResultIterator iterator(java.lang.String query)
                        throws DatabaseEngineException

Description copied from interface: DatabaseEngine

Creates an iterator for the given SQL sentence.

Specified by:

iterator in interface DatabaseEngine

Overrides:

iterator in class AbstractDatabaseEngine

Parameters:

query - The query.

Returns:

An iterator for the results of the given SQL query.

Throws:

DatabaseEngineException - If a database access error occurs.

commentCharacter

public java.lang.String commentCharacter()

Specified by:

commentCharacter in interface DatabaseEngine

Overrides:

commentCharacter in class AbstractDatabaseEngine

Returns:

The comment character of this engine implementation.

escapeCharacter

public java.lang.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(java.sql.Statement statement,
                                              java.lang.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(java.sql.PreparedStatement ps)
                                       throws DatabaseEngineException

Description copied from class: AbstractDatabaseEngine

Creates a specific ResultIterator for the engine in place given given 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.