Package io.ebeaninternal.dbmigration.ddlgeneration.platform

Class SqlServerDdl

java.lang.Object

io.ebeaninternal.dbmigration.ddlgeneration.platform.PlatformDdl

io.ebeaninternal.dbmigration.ddlgeneration.platform.SqlServerDdl

public class SqlServerDdl
extends PlatformDdl

MS SQL Server platform specific DDL.

Constructor Summary

Constructors

Constructor	Description
SqlServerDdl(DatabasePlatform platform)

Method Summary

Modifier and Type	Method	Description
void	addColumnComment(DdlBuffer apply, String table, String column, String comment)	Add column comment as a separate statement.
void	addTableComment(DdlBuffer apply, String tableName, String tableComment)	Add table comment as a separate statement (from the create table statement).
String	alterColumnBaseAttributes(AlterColumn alter)	Alter column setting both the type and not null constraint.
String	alterColumnDefaultValue(String tableName, String columnName, String defaultValue)	Alter column setting the default value.
String	alterColumnNotnull(String tableName, String columnName, boolean notnull)	Alter a column adding or removing the not null constraint.
String	alterColumnType(String tableName, String columnName, String type)	Alter a column type.
String	alterTableAddUniqueConstraint(String tableName, String uqName, String[] columns, String[] nullableColumns)	MsSqlServer specific null handling on unique constraints.
void	alterTableDropColumn(DdlBuffer buffer, String tableName, String columnName)	It is rather complex to delete a column on SqlServer as there must not exist any references (constraints, default values, indices and foreign keys).
String	alterTableDropConstraint(String tableName, String constraintName)	Drop a unique constraint from the table.
String	alterTableDropForeignKey(String tableName, String fkName)	Return the drop foreign key clause.
String	alterTableDropUniqueConstraint(String tableName, String uniqueConstraintName)	Drop a unique constraint from the table (Sometimes this is an index).
String	createSequence(String sequenceName, DdlIdentity identity)	Generate and return the create sequence DDL.
String	dropIndex(String indexName, String tableName, boolean concurrent)	Return the drop index statement.
String	dropSequence(String sequenceName)	Return the drop sequence statement (potentially with if exists clause).
String	dropTable(String tableName)	Return the drop table statement (potentially with if exists clause).
void	generateProlog(DdlWrite write)	This writes the multi value datatypes needed for MultiValueBind

Methods inherited from class io.ebeaninternal.dbmigration.ddlgeneration.platform.PlatformDdl

addHistoryTable, addTablePartition, alterTableAddCheckConstraint, alterTableAddColumn, alterTableAddForeignKey, asIdentityColumn, configure, convert, convertDefaultValue, createCheckConstraint, createDdlHandler, createIndex, createWithHistory, dropHistoryTable, dropIndex, generateEpilog, getCreateTableCommandPrefix, getPlatform, getUpdateNullWithDefault, inlineTableComment, isIncludeStorageEngine, isInlineComments, isInlineForeignKeys, isInlineUniqueWhenNullable, lockTables, regenerateHistoryTriggers, setLockTimeout, suppressPrimaryKeyOnPartition, tableInlineForeignKey, tableStorageEngine, unlockTables, useIdentityType, writeTableColumns

Methods inherited from class java.lang.Object

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

Constructor Detail

SqlServerDdl

public SqlServerDdl(DatabasePlatform platform)

Method Detail

dropTable

public String dropTable(String tableName)

Description copied from class: PlatformDdl

Return the drop table statement (potentially with if exists clause).

Overrides:

dropTable in class PlatformDdl

alterTableDropForeignKey

public String alterTableDropForeignKey(String tableName,
                                       String fkName)

Description copied from class: PlatformDdl

Return the drop foreign key clause.

Overrides:

alterTableDropForeignKey in class PlatformDdl

dropSequence

public String dropSequence(String sequenceName)

Description copied from class: PlatformDdl

Return the drop sequence statement (potentially with if exists clause).

Overrides:

dropSequence in class PlatformDdl

dropIndex

public String dropIndex(String indexName,
                        String tableName,
                        boolean concurrent)

Description copied from class: PlatformDdl

Return the drop index statement.

Overrides:

dropIndex in class PlatformDdl

alterTableAddUniqueConstraint

public String alterTableAddUniqueConstraint(String tableName,
                                            String uqName,
                                            String[] columns,
                                            String[] nullableColumns)

MsSqlServer specific null handling on unique constraints.

Overrides:

alterTableAddUniqueConstraint in class PlatformDdl

alterTableDropConstraint

public String alterTableDropConstraint(String tableName,
                                       String constraintName)

Description copied from class: PlatformDdl

Drop a unique constraint from the table.

Overrides:

alterTableDropConstraint in class PlatformDdl

alterTableDropUniqueConstraint

public String alterTableDropUniqueConstraint(String tableName,
                                             String uniqueConstraintName)

Drop a unique constraint from the table (Sometimes this is an index).

Overrides:

alterTableDropUniqueConstraint in class PlatformDdl

createSequence

public String createSequence(String sequenceName,
                             DdlIdentity identity)

Generate and return the create sequence DDL.

Overrides:

createSequence in class PlatformDdl

alterColumnDefaultValue

public String alterColumnDefaultValue(String tableName,
                                      String columnName,
                                      String defaultValue)

Description copied from class: PlatformDdl

Alter column setting the default value.

Overrides:

alterColumnDefaultValue in class PlatformDdl

alterColumnBaseAttributes

public String alterColumnBaseAttributes(AlterColumn alter)

Description copied from class: PlatformDdl

Alter column setting both the type and not null constraint.

Used by MySql, SQL Server, and HANA as these require both column attributes to be set together.

Overrides:

alterColumnBaseAttributes in class PlatformDdl

alterColumnType

public String alterColumnType(String tableName,
                              String columnName,
                              String type)

Description copied from class: PlatformDdl

Alter a column type.

Note that that MySql and SQL Server instead use alterColumnBaseAttributes()

Overrides:

alterColumnType in class PlatformDdl

alterColumnNotnull

public String alterColumnNotnull(String tableName,
                                 String columnName,
                                 boolean notnull)

Description copied from class: PlatformDdl

Alter a column adding or removing the not null constraint.

Note that that MySql, SQL Server, and HANA instead use alterColumnBaseAttributes()

Overrides:

alterColumnNotnull in class PlatformDdl

addTableComment

public void addTableComment(DdlBuffer apply,
                            String tableName,
                            String tableComment)
                     throws IOException

Add table comment as a separate statement (from the create table statement).

Overrides:

addTableComment in class PlatformDdl

Throws:

IOException

addColumnComment

public void addColumnComment(DdlBuffer apply,
                             String table,
                             String column,
                             String comment)
                      throws IOException

Add column comment as a separate statement.

Overrides:

addColumnComment in class PlatformDdl

Throws:

IOException

alterTableDropColumn

public void alterTableDropColumn(DdlBuffer buffer,
                                 String tableName,
                                 String columnName)
                          throws IOException

It is rather complex to delete a column on SqlServer as there must not exist any references (constraints, default values, indices and foreign keys). That's why we call a user stored procedure here

Overrides:

alterTableDropColumn in class PlatformDdl

Throws:

IOException

generateProlog

public void generateProlog(DdlWrite write)
                    throws IOException

This writes the multi value datatypes needed for MultiValueBind

Overrides:

generateProlog in class PlatformDdl

Throws:

IOException