Package liquibase.database.core

Class MySQLDatabase

java.lang.Object

liquibase.database.AbstractJdbcDatabase

liquibase.database.core.MySQLDatabase

All Implemented Interfaces:

AutoCloseable, Database, PrioritizedService

Direct Known Subclasses:

MariaDBDatabase

public class MySQLDatabase
extends AbstractJdbcDatabase

Encapsulates MySQL database support.

Field Summary

Fields

Modifier and Type	Field	Description
static final Pattern	PRECISION_PATTERN

Fields inherited from class liquibase.database.AbstractJdbcDatabase

caseSensitive, currentDateTimeFunction, dateFunctions, defaultAutoIncrementBy, defaultAutoIncrementStartWith, defaultCatalogName, defaultSchemaName, quotingStrategy, sequenceCurrentValueFunction, sequenceNextValueFunction, unmodifiableDataTypes, unquotedObjectsAreUppercased

Fields inherited from interface liquibase.database.Database

COMPLETE_SQL_SCOPE_KEY

Fields inherited from interface liquibase.servicelocator.PrioritizedService

COMPARATOR, PRIORITY_DATABASE, PRIORITY_DEFAULT

Constructor Summary

Constructors

Constructor	Description
MySQLDatabase()

Method Summary

Modifier and Type	Method	Description
void	addReservedWords(Collection<String> words)
String	correctObjectName(String name, Class<? extends DatabaseObject> objectType)	Fix the object name to the format the database expects, handling changes in case, etc.
boolean	createsIndexesForForeignKeys()
boolean	disableForeignKeyChecks()
void	enableForeignKeyChecks()
String	escapeIndexName(String catalogName, String schemaName, String indexName)
String	escapeStringForDatabase(String string)
protected boolean	generateAutoIncrementBy(BigInteger incrementBy)
protected boolean	generateAutoIncrementStartWith(BigInteger startWith)
String	generateDatabaseFunctionValue(DatabaseFunction databaseFunction)	Some function names are placeholders that need to be replaced with the specific database value.
protected String	getAutoIncrementClause()
protected String	getAutoIncrementClosing()
protected String	getAutoIncrementOpening()
protected String	getAutoIncrementStartWithClause()
String	getConcatSql(String... values)	Returns SQL to concat the passed values.
protected String	getCurrentDateTimeFunction(int precision)
int	getDatabasePatchVersion()
protected String	getDefaultDatabaseProductName()
String	getDefaultDriver(String url)	If this database understands the given url, return the default driver class name.
int	getDefaultFractionalDigitsForTimestamp()	Returns the default timestamp fractional digits if nothing is specified.
Integer	getDefaultPort()
Integer	getFSPFromTimeType(int columnSize, int jdbcType)
String	getLineComment()	Returns database-specific line comment string.
int	getMaxFractionalDigitsForTimestamp()	Most relational databases support 9 fractional digits, and subclasses must overwrite this method if they support less than that.
protected String	getMinimumVersionForFractionalDigitsForTimestamp()
int	getPriority()
protected String	getQuotingEndCharacter()
protected String	getQuotingStartCharacter()
CatalogAndSchema	getSchemaFromJdbcInfo(String rawCatalogName, String rawSchemaName)
String	getShortName()	Returns an all-lower-case short name of the product.
String	getTableOptionAutoIncrementStartWithClause(BigInteger startWith)
boolean	getUseAffectedRows()
boolean	isCorrectDatabaseImplementation(DatabaseConnection conn)	Is this AbstractDatabase subclass the correct one to use for the given connection.
boolean	isMinimumMySQLVersion(String minimumVersion)	Checks whether this instance of a MySQL database is equal to or greater than the specified version.
boolean	isReservedWord(String string)
protected boolean	mustQuoteObjectName(String objectName, Class<? extends DatabaseObject> objectType)
boolean	supports(Class<? extends DatabaseObject> object)	Whether this database supports the specified object type.
boolean	supportsCatalogs()	Whether this database supports catalogs
boolean	supportsCreateIfNotExists(Class<? extends DatabaseObject> type)	Does the database support the "if not exits" syntax?
boolean	supportsDatabaseChangeLogHistory()	Does the particular database implementation support the database changelog history feature and associated table?
boolean	supportsForeignKeyDisable()
boolean	supportsInitiallyDeferrableColumns()	Returns whether this database support initially deferrable columns.
boolean	supportsSchemas()	Whether this database supports schemas
boolean	supportsSequences()	Does the database type support sequence.
boolean	supportsTablespaces()
void	warnAboutAlterColumn(String changeName, Warnings warnings)

Methods inherited from class liquibase.database.AbstractJdbcDatabase

canCreateChangeLogTable, close, commit, correctSchema, correctSchema, dataTypeIsNotModifiable, doesTagExist, dropDatabaseObjects, equals, escapeColumnName, escapeColumnName, escapeColumnNameList, escapeConstraintName, escapeDataTypeName, escapeObjectName, escapeObjectName, escapeSequenceName, escapeTableName, escapeViewName, execute, executeRollbackStatements, executeRollbackStatements, executeStatements, filterRollbackVisitors, generatePrimaryKeyName, get, getAutoCommitMode, getAutoIncrementByClause, getAutoIncrementClause, getAutoIncrementClause, getConnection, getConnectionCatalogName, getConnectionSchemaName, getConnectionSchemaNameCallStatement, getContainingObjects, getCurrentDateTimeFunction, getDatabaseChangeLogLockTableName, getDatabaseChangeLogTableName, getDatabaseMajorVersion, getDatabaseMinorVersion, getDatabaseProductName, getDatabaseProductVersion, getDataTypeMaxParameters, getDateFunctions, getDateLiteral, getDateLiteral, getDateLiteral, getDateTimeLiteral, getDefaultCatalogName, getDefaultScaleForNativeDataType, getDefaultSchema, getDefaultSchemaName, getFetchSize, getJdbcCatalogName, getJdbcCatalogName, getJdbcSchemaName, getJdbcSchemaName, getLiquibaseCatalogName, getLiquibaseSchemaName, getLiquibaseTablespaceName, getName, getObjectQuotingStrategy, getOutputDefaultCatalog, getOutputDefaultSchema, getQuotingEndReplacement, getRanChangeSet, getRanChangeSetList, getRanDate, getRawDatabaseChangeLogLockTableName, getRawDatabaseChangeLogTableName, getRunStatus, getSchemaAndCatalogCase, getSystemSchema, getSystemTables, getSystemViews, getTimeLiteral, getViewDefinition, hashCode, isAutoCommit, isCaseSensitive, isCatalogOrSchemaType, isCurrentTimeFunction, isDateOnly, isDateTime, isDefaultCatalog, isDefaultSchema, isFunction, isLiquibaseObject, isSafeToRunUpdate, isSystemObject, isSystemView, isTimeOnly, isTimestamp, jdbcCallsCatalogsSchemas, markChangeSetExecStatus, parseDate, quoteObject, removeRanStatus, requiresExplicitNullForColumns, requiresPassword, requiresUsername, resetInternalState, rollback, saveRollbackStatement, saveStatements, set, setAutoCommit, setCanCacheLiquibaseTableInfo, setCaseSensitive, setConnection, setCurrentDateTimeFunction, setDatabaseChangeLogLockTableName, setDatabaseChangeLogTableName, setDefaultCatalogName, setDefaultSchemaName, setLiquibaseCatalogName, setLiquibaseSchemaName, setLiquibaseTablespaceName, setObjectQuotingStrategy, setOutputDefaultCatalog, setOutputDefaultSchema, setPreviousAutoCommit, startsWithNumeric, supportsAutoIncrement, supportsBatchUpdates, supportsCatalogInObjectName, supportsDDLInTransaction, supportsDropTableCascadeConstraints, supportsNotNullConstraintNames, supportsPrimaryKeyNames, supportsRestrictForeignKeys, tag, toString, unescapeDataTypeName, unescapeDataTypeString, validate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface liquibase.database.Database

addCompleteSqlToScope, afterUpdate, checkDatabaseConnection, dropDatabaseObjects, failOnDefferable, generateConnectCommandSuccessMessage, getDisplayName, temporarilySetObjectQuotingStrategy

Field Details

PRECISION_PATTERN

public static final Pattern PRECISION_PATTERN

Constructor Details

MySQLDatabase

public MySQLDatabase()

Method Details

getShortName

public String getShortName()

Description copied from interface: Database

Returns an all-lower-case short name of the product. Used for end-user selecting of database type such as the DBMS precondition.

correctObjectName

public String correctObjectName(String name,
 Class<? extends DatabaseObject> objectType)

Description copied from interface: Database

Fix the object name to the format the database expects, handling changes in case, etc.

Specified by:

correctObjectName in interface Database

Overrides:

correctObjectName in class AbstractJdbcDatabase

getDefaultDatabaseProductName

protected String getDefaultDatabaseProductName()

Specified by:

getDefaultDatabaseProductName in class AbstractJdbcDatabase

getDefaultPort

public Integer getDefaultPort()

getPriority

public int getPriority()

isCorrectDatabaseImplementation

public boolean isCorrectDatabaseImplementation(DatabaseConnection conn)
                                        throws DatabaseException

Description copied from interface: Database

Is this AbstractDatabase subclass the correct one to use for the given connection.

Throws:

DatabaseException

getDefaultDriver

public String getDefaultDriver(String url)

Description copied from interface: Database

If this database understands the given url, return the default driver class name. Otherwise return null.

supportsSequences

public boolean supportsSequences()

Description copied from class: AbstractJdbcDatabase

Does the database type support sequence.

Specified by:

supportsSequences in interface Database

Overrides:

supportsSequences in class AbstractJdbcDatabase

supportsInitiallyDeferrableColumns

public boolean supportsInitiallyDeferrableColumns()

Description copied from interface: Database

Returns whether this database support initially deferrable columns.

mustQuoteObjectName

protected boolean mustQuoteObjectName(String objectName,
 Class<? extends DatabaseObject> objectType)

Overrides:

mustQuoteObjectName in class AbstractJdbcDatabase

getLineComment

public String getLineComment()

Description copied from class: AbstractJdbcDatabase

Returns database-specific line comment string.

Specified by:

getLineComment in interface Database

Overrides:

getLineComment in class AbstractJdbcDatabase

getAutoIncrementClause

protected String getAutoIncrementClause()

Overrides:

getAutoIncrementClause in class AbstractJdbcDatabase

generateAutoIncrementStartWith

protected boolean generateAutoIncrementStartWith(BigInteger startWith)

Overrides:

generateAutoIncrementStartWith in class AbstractJdbcDatabase

getTableOptionAutoIncrementStartWithClause

public String getTableOptionAutoIncrementStartWithClause(BigInteger startWith)

generateAutoIncrementBy

protected boolean generateAutoIncrementBy(BigInteger incrementBy)

Overrides:

generateAutoIncrementBy in class AbstractJdbcDatabase

getAutoIncrementOpening

protected String getAutoIncrementOpening()

Overrides:

getAutoIncrementOpening in class AbstractJdbcDatabase

getAutoIncrementClosing

protected String getAutoIncrementClosing()

Overrides:

getAutoIncrementClosing in class AbstractJdbcDatabase

getAutoIncrementStartWithClause

protected String getAutoIncrementStartWithClause()

Overrides:

getAutoIncrementStartWithClause in class AbstractJdbcDatabase

getConcatSql

public String getConcatSql(String... values)

Description copied from interface: Database

Returns SQL to concat the passed values.

Specified by:

getConcatSql in interface Database

Overrides:

getConcatSql in class AbstractJdbcDatabase

supportsTablespaces

public boolean supportsTablespaces()

supports

public boolean supports(Class<? extends DatabaseObject> object)

Description copied from interface: Database

Whether this database supports the specified object type. It is invoking the deprecated methods to ensure that extensions are not broken, but once those are removed it will return only true

Parameters:

object - the object type to check

Returns:

true if the database supports the object type, false otherwise

supportsSchemas

public boolean supportsSchemas()

Description copied from interface: Database

Whether this database supports schemas

Specified by:

supportsSchemas in interface Database

Overrides:

supportsSchemas in class AbstractJdbcDatabase

supportsCatalogs

public boolean supportsCatalogs()

Description copied from interface: Database

Whether this database supports catalogs

Specified by:

supportsCatalogs in interface Database

Overrides:

supportsCatalogs in class AbstractJdbcDatabase

escapeIndexName

public String escapeIndexName(String catalogName,
 String schemaName,
 String indexName)

Specified by:

escapeIndexName in interface Database

Overrides:

escapeIndexName in class AbstractJdbcDatabase

supportsForeignKeyDisable

public boolean supportsForeignKeyDisable()

Specified by:

supportsForeignKeyDisable in interface Database

Overrides:

supportsForeignKeyDisable in class AbstractJdbcDatabase

disableForeignKeyChecks

public boolean disableForeignKeyChecks()
                                throws DatabaseException

Specified by:

disableForeignKeyChecks in interface Database

Overrides:

disableForeignKeyChecks in class AbstractJdbcDatabase

Throws:

DatabaseException

enableForeignKeyChecks

public void enableForeignKeyChecks()
                            throws DatabaseException

Specified by:

enableForeignKeyChecks in interface Database

Overrides:

enableForeignKeyChecks in class AbstractJdbcDatabase

Throws:

DatabaseException

getSchemaFromJdbcInfo

public CatalogAndSchema getSchemaFromJdbcInfo(String rawCatalogName,
 String rawSchemaName)

Overrides:

getSchemaFromJdbcInfo in class AbstractJdbcDatabase

escapeStringForDatabase

public String escapeStringForDatabase(String string)

Specified by:

escapeStringForDatabase in interface Database

Overrides:

escapeStringForDatabase in class AbstractJdbcDatabase

createsIndexesForForeignKeys

public boolean createsIndexesForForeignKeys()

Specified by:

createsIndexesForForeignKeys in interface Database

Overrides:

createsIndexesForForeignKeys in class AbstractJdbcDatabase

isReservedWord

public boolean isReservedWord(String string)

Specified by:

isReservedWord in interface Database

Overrides:

isReservedWord in class AbstractJdbcDatabase

getDatabasePatchVersion

public int getDatabasePatchVersion()
                            throws DatabaseException

Throws:

DatabaseException

getFSPFromTimeType

public Integer getFSPFromTimeType(int columnSize,
 int jdbcType)

getMaxFractionalDigitsForTimestamp

public int getMaxFractionalDigitsForTimestamp()

Description copied from class: AbstractJdbcDatabase

Most relational databases support 9 fractional digits, and subclasses must overwrite this method if they support less than that.

Specified by:

getMaxFractionalDigitsForTimestamp in interface Database

Overrides:

getMaxFractionalDigitsForTimestamp in class AbstractJdbcDatabase

Returns:

the maximum number of supported fractional digits in TIMESTAMP columns

isMinimumMySQLVersion

public boolean isMinimumMySQLVersion(String minimumVersion)

Checks whether this instance of a MySQL database is equal to or greater than the specified version.

Parameters:

minimumVersion - the minimum version to check

Returns:

true if this instance of a MySQL database is equal to or greater than the specified version, false otherwise

getMinimumVersionForFractionalDigitsForTimestamp

protected String getMinimumVersionForFractionalDigitsForTimestamp()

getQuotingStartCharacter

protected String getQuotingStartCharacter()

Overrides:

getQuotingStartCharacter in class AbstractJdbcDatabase

getQuotingEndCharacter

protected String getQuotingEndCharacter()

Overrides:

getQuotingEndCharacter in class AbstractJdbcDatabase

getDefaultFractionalDigitsForTimestamp

public int getDefaultFractionalDigitsForTimestamp()

Returns the default timestamp fractional digits if nothing is specified.

fractional seconds: "The fsp value, if given, must be in the range 0 to 6. A value of 0 signifies that there is no fractional part. If omitted, the default precision is 0. (This differs from the STANDARD SQL default of 6, for compatibility with previous MySQL versions.)"

Specified by:

getDefaultFractionalDigitsForTimestamp in interface Database

Overrides:

getDefaultFractionalDigitsForTimestamp in class AbstractJdbcDatabase

Returns:

always 0

getCurrentDateTimeFunction

protected String getCurrentDateTimeFunction(int precision)

generateDatabaseFunctionValue

public String generateDatabaseFunctionValue(DatabaseFunction databaseFunction)

Description copied from interface: Database

Some function names are placeholders that need to be replaced with the specific database value. e.g. nextSequenceValue(sequenceName) should be replaced with NEXT_VAL('sequenceName') for Postgresql

Specified by:

generateDatabaseFunctionValue in interface Database

Overrides:

generateDatabaseFunctionValue in class AbstractJdbcDatabase

Parameters:

databaseFunction - database function to check.

Returns:

the string value to use for an update or generate

warnAboutAlterColumn

public void warnAboutAlterColumn(String changeName,
 Warnings warnings)

supportsCreateIfNotExists

public boolean supportsCreateIfNotExists(Class<? extends DatabaseObject> type)

Description copied from interface: Database

Does the database support the "if not exits" syntax?

Parameters:

type - the DatabaseObject type to be checked.

Returns:

true if the "if not exists" syntax is supported, false otherwise.

supportsDatabaseChangeLogHistory

public boolean supportsDatabaseChangeLogHistory()

Description copied from interface: Database

Does the particular database implementation support the database changelog history feature and associated table?

Returns:

true if supported, false otherwise

getUseAffectedRows

public boolean getUseAffectedRows()
                           throws DatabaseException

Throws:

DatabaseException

addReservedWords

public void addReservedWords(Collection<String> words)

Specified by:

addReservedWords in interface Database

Overrides:

addReservedWords in class AbstractJdbcDatabase