org.dbmaintain.database.impl
Class MySqlDatabase

java.lang.Object
  org.dbmaintain.database.Database
      org.dbmaintain.database.impl.MySqlDatabase

public class MySqlDatabase
extends Database

Implementation of Database for a MySql database.

Note: by default MySql uses '`' (back-quote) for quoting identifiers. '"' (double quotes) is only supported in MySql if ANSI_QUOTES sql mode is enabled. Quoting identifiers does not make them case-sensitive. Case-sensitivity is platform dependent. E.g. on UNIX systems identifiers will typically be case-sensitive, on Windows platforms they will be converted to lower-case.

Trigger names are an exception to this: they are always case-sensitive.

Author:

Frederick Beernaert, Filip Neven, Tim Ducheyne

Field Summary

Fields inherited from class org.dbmaintain.database.Database

databaseConnection, identifierProcessor, schemaNames

Constructor Summary

MySqlDatabase(DatabaseConnection databaseConnection, IdentifierProcessor identifierProcessor)

Method Summary

void	disableReferentialConstraints(String schemaName) Disables all referential constraints (e.g. foreign keys) on all table in the schema
protected void	disableReferentialConstraints(String schemaName, String tableName)
void	disableValueConstraints(String schemaName) Disables all value constraints (e.g. not null) on all tables in the schema
protected void	disableValueConstraints(String schemaName, String tableName)
Set<String>	getColumnNames(String schemaName, String tableName) Gets the names of all columns of the given table.
Set<String>	getIdentityColumnNames(String schemaName, String tableName) Gets the names of all identity columns of the given table.
String	getSupportedDatabaseDialect()
Set<String>	getTableNames(String schemaName) Returns the names of all tables in the database.
Set<String>	getTriggerNames(String schemaName) Retrieves the names of all the triggers in the database schema.
Set<String>	getViewNames(String schemaName) Retrieves the names of all the views in the database schema.
void	incrementIdentityColumnToValue(String schemaName, String tableName, String primaryKeyColumnName, long identityValue) Increments the identity value for the specified primary key on the specified table to the given value.
void	setDatabaseDefaultSchema() Sets the current schema of the database.
void	setSettingIdentityColumnValueEnabled(String schemaName, String tableName, boolean enabled) Enables or disables the setting of identity value in insert and update statements.
boolean	supportsCascade() Cascade are supported.
boolean	supportsIdentityColumns() Identity columns are supported.
boolean	supportsSetDatabaseDefaultSchema() Setting the default schema is supported.
boolean	supportsTriggers() Triggers are supported.
String	toCorrectCaseIdentifier(String identifier) Converts the given identifier to uppercase/lowercase MySql does not treat quoted identifiers as case sensitive.

Methods inherited from class org.dbmaintain.database.Database

disableReferentialConstraints, disableValueConstraints, dropMaterializedView, dropMaterializedView, dropRule, dropSequence, dropSequence, dropStoredProcedure, dropStoredProcedure, dropSynonym, dropSynonym, dropTable, dropTable, dropTrigger, dropTrigger, dropType, dropType, dropView, dropView, getColumnNames, getDatabaseInfo, getDatabaseName, getDataSource, getDefaultSchemaName, getIdentifierQuoteString, getIdentityColumnNames, getLongDataType, getMaterializedViewNames, getMaterializedViewNames, getRuleNames, getSchemaNames, getSequenceNames, getSequenceNames, getSequenceValue, getSequenceValue, getSQLHandler, getStoredIdentifierCase, getStoredProcedureNames, getStoredProcedureNames, getSynonymNames, getSynonymNames, getTableNames, getTextDataType, getTriggerNames, getTypeNames, getTypeNames, getViewNames, incrementIdentityColumnToValue, incrementSequenceToValue, incrementSequenceToValue, isQuoted, qualified, qualified, quoted, removeIdentifierQuotes, setSettingIdentityColumnValueEnabled, supportsMaterializedViews, supportsRules, supportsSequences, supportsStoredProcedures, supportsSynonyms, supportsTypes

Methods inherited from class java.lang.Object

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

Constructor Detail

MySqlDatabase

public MySqlDatabase(DatabaseConnection databaseConnection,
                     IdentifierProcessor identifierProcessor)

Method Detail

getSupportedDatabaseDialect

public String getSupportedDatabaseDialect()

Specified by:

getSupportedDatabaseDialect in class Database

Returns:

the database dialect supported by this db support class, not null

getTableNames

public Set<String> getTableNames(String schemaName)

Returns the names of all tables in the database.

Specified by:

getTableNames in class Database

Parameters:

schemaName - The schema, not null

Returns:

The names of all tables in the database

getColumnNames

public Set<String> getColumnNames(String schemaName,
                                  String tableName)

Gets the names of all columns of the given table.

Specified by:

getColumnNames in class Database

Parameters:

tableName - The table, not null

schemaName - The schema, not null

Returns:

The names of the columns of the table with the given name

getViewNames

public Set<String> getViewNames(String schemaName)

Retrieves the names of all the views in the database schema.

Specified by:

getViewNames in class Database

Parameters:

schemaName - The schema, not null

Returns:

The names of all views in the database

getTriggerNames

public Set<String> getTriggerNames(String schemaName)

Retrieves the names of all the triggers in the database schema.

Overrides:

getTriggerNames in class Database

Parameters:

schemaName - The schema, not null

Returns:

The names of all triggers in the database

disableReferentialConstraints

public void disableReferentialConstraints(String schemaName)

Disables all referential constraints (e.g. foreign keys) on all table in the schema

Specified by:

disableReferentialConstraints in class Database

Parameters:

schemaName - The schema name, not null

disableReferentialConstraints

protected void disableReferentialConstraints(String schemaName,
                                             String tableName)

disableValueConstraints

public void disableValueConstraints(String schemaName)

Disables all value constraints (e.g. not null) on all tables in the schema

Specified by:

disableValueConstraints in class Database

Parameters:

schemaName - The schema name, not null

disableValueConstraints

protected void disableValueConstraints(String schemaName,
                                       String tableName)

getIdentityColumnNames

public Set<String> getIdentityColumnNames(String schemaName,
                                          String tableName)

Gets the names of all identity columns of the given table.

Overrides:

getIdentityColumnNames in class Database

Parameters:

tableName - The table, not null

schemaName - The schema, not null

Returns:

The names of the identity columns of the table with the given name

incrementIdentityColumnToValue

public void incrementIdentityColumnToValue(String schemaName,
                                           String tableName,
                                           String primaryKeyColumnName,
                                           long identityValue)

Increments the identity value for the specified primary key on the specified table to the given value.

Overrides:

incrementIdentityColumnToValue in class Database

Parameters:

tableName - The table with the identity column, not null

identityValue - The new value

primaryKeyColumnName - The column, not null

schemaName - The schema, not null

toCorrectCaseIdentifier

public String toCorrectCaseIdentifier(String identifier)

Converts the given identifier to uppercase/lowercase

MySql does not treat quoted identifiers as case sensitive. These will also be converted to the correct case.

KNOWN ISSUE: MySql trigger names are case-sensitive (even if not quoted). This will incorrectly be converted to the stored identifier case

Overrides:

toCorrectCaseIdentifier in class Database

Parameters:

identifier - The identifier, not null

Returns:

The name converted to correct case if needed, not null

setDatabaseDefaultSchema

public void setDatabaseDefaultSchema()

Sets the current schema of the database. If a current schema is set, it does not need to be specified explicitly in the scripts.

Overrides:

setDatabaseDefaultSchema in class Database

setSettingIdentityColumnValueEnabled

public void setSettingIdentityColumnValueEnabled(String schemaName,
                                                 String tableName,
                                                 boolean enabled)

Enables or disables the setting of identity value in insert and update statements. By default some databases do not allow to set values of identity columns directly from insert/update statements. If supported, this method will enable/disable this behavior.

Overrides:

setSettingIdentityColumnValueEnabled in class Database

Parameters:

schemaName - The schema name, not null

tableName - The table with the identity column, not null

enabled - True to enable, false to disable

supportsTriggers

public boolean supportsTriggers()

Triggers are supported.

Overrides:

supportsTriggers in class Database

Returns:

True

supportsIdentityColumns

public boolean supportsIdentityColumns()

Identity columns are supported.

Overrides:

supportsIdentityColumns in class Database

Returns:

True

supportsCascade

public boolean supportsCascade()

Cascade are supported.

Overrides:

supportsCascade in class Database

Returns:

True

supportsSetDatabaseDefaultSchema

public boolean supportsSetDatabaseDefaultSchema()

Setting the default schema is supported.

Overrides:

supportsSetDatabaseDefaultSchema in class Database

Returns:

True