org.apache.ddlutils.platform.mysql

Class MySqlBuilder

java.lang.Object

org.apache.ddlutils.platform.SqlBuilder

org.apache.ddlutils.platform.mysql.MySqlBuilder

Direct Known Subclasses:

MySql50Builder

public class MySqlBuilder
extends SqlBuilder

The SQL Builder for MySQL.

Field Summary

Fields inherited from class org.apache.ddlutils.platform.SqlBuilder

_log, LINE_SEPARATOR, SIZE_PLACEHOLDER

Constructor Summary

Constructors

Constructor and Description
MySqlBuilder(Platform platform) Creates a new builder instance.

Method Summary

Methods

Modifier and Type	Method and Description
void	dropColumn(Table table, Column column) Writes the SQL to drop a column.
void	dropForeignKey(Table table, ForeignKey foreignKey) Generates the statement to drop a foreignkey constraint from the database using an alter table statement.
void	dropPrimaryKey(Table table) Writes the SQL to drop the primary key of the given table.
void	dropTable(Table table) Outputs the DDL to drop the table.
String	getSelectLastIdentityValues(Table table) Generates the SQL for querying the id that was created in the last insertion operation.
void	insertColumn(Table table, Column newColumn, Column prevColumn) Writes the SQL to add/insert a column.
void	recreateColumn(Table table, Column column) Writes the SQL to recreate a column, e.g.
protected boolean	shouldGeneratePrimaryKeys(Column[] primaryKeyColumns) Determines whether we should generate a primary key constraint for the given primary key columns.
protected void	writeCastExpression(Column sourceColumn, Column targetColumn) Writes a cast expression that converts the value of the source column to the data type of the target column.
protected void	writeColumnAutoIncrementStmt(Table table, Column column) Prints that the column is an auto increment column.
protected void	writeTableCreationStmtEnding(Table table, Map parameters) Writes the end of the table creation statement.

Methods inherited from class org.apache.ddlutils.platform.SqlBuilder

addColumn, addEscapedCharSequence, areEqual, columnsDiffer, copyData, createForeignKey, createForeignKeys, createForeignKeys, createIndex, createIndexes, createPrimaryKey, createTable, createTable, createTables, createTables, createTables, createTemporaryTable, createUniqueIdentifier, dropForeignKeys, dropIndex, dropTable, dropTables, dropTemporaryTable, escapeStringValue, getBareNativeType, getColumnName, getConstraintName, getDefaultValueHelper, getDeleteSql, getDelimitedIdentifier, getForeignKeyName, getIndent, getIndexName, getInsertSql, getMaxColumnNameLength, getMaxConstraintNameLength, getMaxForeignKeyNameLength, getMaxTableNameLength, getNativeDefaultValue, getNativeType, getPlatform, getPlatformInfo, getSizeSpec, getSqlType, getSqlType, getTableName, getUpdateSql, getUpdateSql, getValueAsString, getValueDateFormat, getValueLocale, getValueNumberFormat, getValueTimeFormat, getWriter, isValidDefaultValue, print, printComment, printDefaultValue, printEndOfStatement, printIdentifier, printIndent, println, println, printlnIdentifier, printStartOfEmbeddedStatement, setIndent, setValueDateFormat, setValueLocale, setValueNumberFormat, setValueTimeFormat, setWriter, shortenName, writeAddIdentityColumnUsingAlterTable, writeColumn, writeColumnDefaultValue, writeColumnDefaultValueStmt, writeColumnNotNullableStmt, writeColumnNullableStmt, writeColumns, writeEmbeddedForeignKeysStmt, writeEmbeddedIndexCreateStmt, writeEmbeddedIndicesStmt, writeEmbeddedPrimaryKeysStmt, writeForeignKeyOnDeleteAction, writeForeignKeyOnUpdateAction, writeForeignReferences, writeLocalReferences, writePrimaryKeyStmt, writeTableAlterStmt, writeTableComment, writeTableCreationStmt

Methods inherited from class java.lang.Object

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

Constructor Detail

MySqlBuilder

public MySqlBuilder(Platform platform)

Creates a new builder instance.

Parameters:

platform - The plaftform this builder belongs to

Method Detail

dropTable

public void dropTable(Table table)
               throws IOException

Outputs the DDL to drop the table. Note that this method does not drop foreign keys to this table. Use SqlBuilder.dropTable(Database, Table) if you want that.

Overrides:

dropTable in class SqlBuilder

Parameters:

table - The table to drop

Throws:

IOException

writeColumnAutoIncrementStmt

protected void writeColumnAutoIncrementStmt(Table table,
                                Column column)
                                     throws IOException

Prints that the column is an auto increment column.

Overrides:

writeColumnAutoIncrementStmt in class SqlBuilder

Parameters:

table - The table

column - The column

Throws:

IOException

shouldGeneratePrimaryKeys

protected boolean shouldGeneratePrimaryKeys(Column[] primaryKeyColumns)

Determines whether we should generate a primary key constraint for the given primary key columns.

Overrides:

shouldGeneratePrimaryKeys in class SqlBuilder

Parameters:

primaryKeyColumns - The pk columns

Returns:

true if a pk statement should be generated for the columns

getSelectLastIdentityValues

public String getSelectLastIdentityValues(Table table)

Generates the SQL for querying the id that was created in the last insertion operation. This is obviously only useful for pk fields that are auto-incrementing. A database that does not support this, will return null. Normally mysql will return the LAST_INSERT_ID as the column name for the inserted id. Since ddlutils expects the real column name of the field that is autoincrementing, the column has an alias of that column name.

Overrides:

getSelectLastIdentityValues in class SqlBuilder

Parameters:

table - The table

Returns:

The sql, or null if the database does not support this

writeTableCreationStmtEnding

protected void writeTableCreationStmtEnding(Table table,
                                Map parameters)
                                     throws IOException

Writes the end of the table creation statement. Per default, only the end of the statement is written, but this can be changed in subclasses.

Overrides:

writeTableCreationStmtEnding in class SqlBuilder

Parameters:

table - The table

parameters - Additional platform-specific parameters for the table creation

Throws:

IOException

dropForeignKey

public void dropForeignKey(Table table,
                  ForeignKey foreignKey)
                    throws IOException

Generates the statement to drop a foreignkey constraint from the database using an alter table statement.

Overrides:

dropForeignKey in class SqlBuilder

Parameters:

table - The table

foreignKey - The foreign key

Throws:

IOException

insertColumn

public void insertColumn(Table table,
                Column newColumn,
                Column prevColumn)
                  throws IOException

Writes the SQL to add/insert a column.

Parameters:

table - The table

newColumn - The new column

prevColumn - The column after which the new column shall be added; null if the new column is to be inserted at the beginning

Throws:

IOException

dropColumn

public void dropColumn(Table table,
              Column column)
                throws IOException

Writes the SQL to drop a column.

Parameters:

table - The table

column - The column to drop

Throws:

IOException

dropPrimaryKey

public void dropPrimaryKey(Table table)
                    throws IOException

Writes the SQL to drop the primary key of the given table.

Parameters:

table - The table

Throws:

IOException

recreateColumn

public void recreateColumn(Table table,
                  Column column)
                    throws IOException

Writes the SQL to recreate a column, e.g. with a different type.

Parameters:

table - The table

column - The new column definition

Throws:

IOException

writeCastExpression

protected void writeCastExpression(Column sourceColumn,
                       Column targetColumn)
                            throws IOException

Writes a cast expression that converts the value of the source column to the data type of the target column. Per default, simply the name of the source column is written thereby assuming that any casts happen implicitly.

Overrides:

writeCastExpression in class SqlBuilder

Parameters:

sourceColumn - The source column

targetColumn - The target column

Throws:

IOException