org.apache.ddlutils.platform.mssql

Class MSSqlBuilder

java.lang.Object

org.apache.ddlutils.platform.SqlBuilder

org.apache.ddlutils.platform.mssql.MSSqlBuilder

public class MSSqlBuilder
extends SqlBuilder

The SQL Builder for the Microsoft SQL Server.

Field Summary

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

_log, LINE_SEPARATOR, SIZE_PLACEHOLDER

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
void	addColumn(Database model, Table table, Column newColumn) Prints the SQL for adding a column to a table.
protected void	copyData(Table sourceTable, Table targetTable) Writes a statement that copies the data from the source to the target table.
void	createTable(Database database, Table table, Map parameters) Outputs the DDL to create the table along with any non-external constraints as well as with external primary keys and indices (but not foreign keys).
void	dropColumn(Table table, Column column) Generates the SQL to drop a column from a table.
void	dropForeignKey(Table table, ForeignKey foreignKey) Generates the statement to drop a foreignkey constraint from the database using an alter table statement.
void	dropForeignKeys(Table table) Creates external foreignkey drop statements.
void	dropIndex(Table table, Index index) Generates the statement to drop a non-embedded index from the database.
void	dropPrimaryKey(Table table) Writes the SQL for dropping the primary key of the given table.
void	dropTable(Table table) Outputs the DDL to drop the table.
String	getDeleteSql(Table table, Map pkValues, boolean genPlaceholders) Creates the SQL for deleting an object from the specified table.
protected String	getDisableIdentityOverrideSql(Table table) Returns the SQL to disable identity override mode.
protected String	getEnableIdentityOverrideSql(Table table) Returns the SQL to enable identity override mode.
String	getInsertSql(Table table, Map columnValues, boolean genPlaceholders) Creates the SQL for inserting an object into the specified table.
protected String	getNativeDefaultValue(Column column) Returns the native default value for the column.
String	getSelectLastIdentityValues(Table table) Generates the SQL for querying the id that was created in the last insertion operation.
String	getUpdateSql(Table table, Map columnValues, boolean genPlaceholders) Creates the SQL for updating an object in the specified table.
protected String	getValueAsString(Column column, Object value) Generates the string representation of the given value.
protected DateFormat	getValueDateFormat() Returns the format object for formatting dates in the specified locale.
protected DateFormat	getValueTimeFormat() Returns the format object for formatting times in the specified locale.
void	recreateColumn(Table table, Column curColumn, Column newColumn) Writes the SQL to recreate a column, e.g.
protected void	turnOnQuotation() If quotation mode is on, then this writes the statement that turns on the ability to write delimited identifiers.
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	writeDropConstraintStatement(Table table, Column column, String typeIdentifier) Writes the SQL to drop a constraint, e.g.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

MSSqlBuilder

public MSSqlBuilder(Platform platform)

Creates a new builder instance.

Parameters:

platform - The plaftform this builder belongs to

Method Detail

createTable

public void createTable(Database database,
               Table table,
               Map parameters)
                 throws IOException

Outputs the DDL to create the table along with any non-external constraints as well as with external primary keys and indices (but not foreign keys).

Overrides:

createTable in class SqlBuilder

Parameters:

database - The database model

table - The table

parameters - Additional platform-specific parameters for the table creation

Throws:

IOException

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

dropForeignKeys

public void dropForeignKeys(Table table)
                     throws IOException

Creates external foreignkey drop statements.

Overrides:

dropForeignKeys in class SqlBuilder

Parameters:

table - The table

Throws:

IOException

getValueDateFormat

protected DateFormat getValueDateFormat()

Returns the format object for formatting dates in the specified locale.

Overrides:

getValueDateFormat in class SqlBuilder

Returns:

The date format object or null if no locale is set

getValueTimeFormat

protected DateFormat getValueTimeFormat()

Returns the format object for formatting times in the specified locale.

Overrides:

getValueTimeFormat in class SqlBuilder

Returns:

The time format object or null if no locale is set

getValueAsString

protected String getValueAsString(Column column,
                      Object value)

Generates the string representation of the given value.

Overrides:

getValueAsString in class SqlBuilder

Parameters:

column - The column

value - The value

Returns:

The string representation

getNativeDefaultValue

protected String getNativeDefaultValue(Column column)

Returns the native default value for the column.

Overrides:

getNativeDefaultValue in class SqlBuilder

Parameters:

column - The column

Returns:

The native default value

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

dropIndex

public void dropIndex(Table table,
             Index index)
               throws IOException

Generates the statement to drop a non-embedded index from the database.

Overrides:

dropIndex in class SqlBuilder

Parameters:

table - The table the index is on

index - The index to drop

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

turnOnQuotation

protected void turnOnQuotation()
                        throws IOException

If quotation mode is on, then this writes the statement that turns on the ability to write delimited identifiers.

Throws:

IOException

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.

Overrides:

getSelectLastIdentityValues in class SqlBuilder

Parameters:

table - The table

Returns:

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

getEnableIdentityOverrideSql

protected String getEnableIdentityOverrideSql(Table table)

Returns the SQL to enable identity override mode.

Parameters:

table - The table to enable the mode for

Returns:

The SQL

getDisableIdentityOverrideSql

protected String getDisableIdentityOverrideSql(Table table)

Returns the SQL to disable identity override mode.

Parameters:

table - The table to disable the mode for

Returns:

The SQL

getDeleteSql

public String getDeleteSql(Table table,
                  Map pkValues,
                  boolean genPlaceholders)

Creates the SQL for deleting an object from the specified table. Depending on the value of genPlaceholders, the generated SQL will contain prepared statement place holders or concrete values. Only those primary key columns wil be used that are present in the given map. If the map is null or completely empty, then the SQL will not have a WHERE clause. The SQL will contain the columns in the order defined in the table.

Overrides:

getDeleteSql in class SqlBuilder

Parameters:

table - The table

pkValues - The primary key columns to use, and optionally their values

genPlaceholders - Whether to generate value placeholders for a prepared statement

Returns:

The delete sql

getInsertSql

public String getInsertSql(Table table,
                  Map columnValues,
                  boolean genPlaceholders)

Creates the SQL for inserting an object into the specified table. If values are given then a concrete insert statement is created, otherwise an insert statement usable in a prepared statement is build.

Overrides:

getInsertSql in class SqlBuilder

Parameters:

table - The table

columnValues - The columns values indexed by the column names

genPlaceholders - Whether to generate value placeholders for a prepared statement

Returns:

The insertion sql

getUpdateSql

public String getUpdateSql(Table table,
                  Map columnValues,
                  boolean genPlaceholders)

Creates the SQL for updating an object in the specified table. If values are given then a concrete update statement is created, otherwise an update statement usable in a prepared statement is build.

Overrides:

getUpdateSql in class SqlBuilder

Parameters:

table - The table

columnValues - Contains the values for the columns to update, and should also contain the primary key values to identify the object to update in case genPlaceholders is false

genPlaceholders - Whether to generate value placeholders for a prepared statement (both for the pk values and the object values)

Returns:

The update sql

copyData

protected void copyData(Table sourceTable,
            Table targetTable)
                 throws IOException

Writes a statement that copies the data from the source to the target table. Note that this copies only those columns that are in both tables. Database-specific implementations might redefine this method though it usually suffices to redefine the SqlBuilder.writeCastExpression(Column, Column) method.

Overrides:

copyData in class SqlBuilder

Parameters:

sourceTable - The source table

targetTable - The target table

Throws:

IOException

addColumn

public void addColumn(Database model,
             Table table,
             Column newColumn)
               throws IOException

Prints the SQL for adding a column to a table.

Overrides:

addColumn in class SqlBuilder

Parameters:

model - The database model

table - The table

newColumn - The new column

Throws:

IOException

dropColumn

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

Generates the SQL to drop a column from a table.

Parameters:

table - The table where to drop the column from

column - The column to drop

Throws:

IOException

dropPrimaryKey

public void dropPrimaryKey(Table table)
                    throws IOException

Writes the SQL for dropping the primary key of the given table.

Parameters:

table - The table

Throws:

IOException

recreateColumn

public void recreateColumn(Table table,
                  Column curColumn,
                  Column newColumn)
                    throws IOException

Writes the SQL to recreate a column, e.g. using a different type or similar.

Parameters:

table - The table

curColumn - The current column definition

newColumn - The new column definition

Throws:

IOException

writeDropConstraintStatement

protected void writeDropConstraintStatement(Table table,
                                Column column,
                                String typeIdentifier)
                                     throws IOException

Writes the SQL to drop a constraint, e.g. a primary key or default value constraint.

Parameters:

table - The table that the constraint is on

column - The column that the constraint is on; null for table-level constraints

typeIdentifier - The constraint type identifier as is specified for the sysobjects system table

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