Package com.valqueries.automapper.context.schema

Class AlterTableBuilder

java.lang.Object

com.valqueries.automapper.context.schema.AlterTableBuilder

All Implemented Interfaces:

IAlterTableBuilder, IBaseBuilder

Direct Known Subclasses:

DryRunAlterTableBuilder

public class AlterTableBuilder
extends Object
implements IAlterTableBuilder

Constructor Summary

Constructors

Constructor	Description
AlterTableBuilder(org.jooq.CloseableDSLContext jooq, Supplier<org.jooq.AlterTableStep> jooqStepSupplier, String formattedTableName, Database database, SchemaExaminer schemaExaminer, String schema, Token table)

Method Summary

Modifier and Type	Method	Description
IAlterTableBuilder	addColumn(Token columnName, SqlType<?> columnType)	Add a column with a specific sql type.
IAlterTableBuilder	addColumnIfNotExists(Token columnName, SqlType<?> columnType)	Add a column with a specific sql type.
IAlterTableBuilder	addForeignKey(String constraintName, Token[] columns, Token referencedTable, Token[] referencedColumns)	Add a foreign key
IAlterTableBuilder	addIndex(String indexName, Token firstColumn, Token... columns)	Add an index
IAlterTableBuilder	addPrimaryKey(Token firstColumn, Token... columns)	Add a primary key.
IAlterTableBuilder	addUnique(String constraintName, Token firstColumn, Token... columns)	Add a unique constraint
IAlterTableBuilder	changeColumnType(Token columnName, SqlType<?> newColumnType)	Change the type of column to a specific sql type.
IAlterTableBuilder	changeColumnTypeIfExists(Token columnName, SqlType<?> newColumnType)	Change the type of column to a specific sql type, if it exists.
IAlterTableBuilder	changePrimaryKey(Token firstColumn, Token... columns)	Change the primary key.
IAlterTableBuilder	dropColumn(Token columnName)	Drop a column.
IAlterTableBuilder	dropColumnIfExists(Token columnName)	Drop a column if it exists.
IAlterTableBuilder	dropForeignKey(String constraintName)	Drop a foreign key.
IAlterTableBuilder	dropIndex(String indexName)	Drop an index.
IAlterTableBuilder	dropPrimaryKey()	Drop a primary key without adding a new one.
IAlterTableBuilder	dropPrimaryKeyIfExists()	Drop a primary key if it exists, without adding a new one.
IAlterTableBuilder	dropUnique(String constraintName)	Drop a unique constraint.
void	execute()	Execute the create/alter table statement(s)
String	getSql()	Useful for debugging
IAlterTableBuilder	renameColumn(Token oldColumnName, Token newColumnName)	Rename a column.
IAlterTableBuilder	renameColumnIfPossible(Token oldColumnName, Token newColumnName)	Rename a column if it exists and no column exists with the new name.
IAlterTableBuilder	renameIndex(String oldIndexName, String newIndexName)	Rename an index
IBaseBuilder	renameTable(Token newTableName)	Rename a table.
IBaseBuilder	renameTableIfPossible(Token newTableName)	Rename a table if no table exists with the new name.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.valqueries.automapper.context.schema.IAlterTableBuilder

addColumn, addColumn, addColumn, addColumnIfNotExists, addColumnIfNotExists, addColumnIfNotExists, addForeignKey, addForeignKey, addForeignKey, addIndex, addPrimaryKey, addUnique, changeColumnType, changeColumnType, changeColumnType, changeColumnTypeIfExists, changeColumnTypeIfExists, changeColumnTypeIfExists, changePrimaryKey, dropColumn, dropColumnIfExists, renameColumn, renameColumnIfPossible, renameTable, renameTableIfPossible

Constructor Details

AlterTableBuilder

public AlterTableBuilder(org.jooq.CloseableDSLContext jooq,
 Supplier<org.jooq.AlterTableStep> jooqStepSupplier,
 String formattedTableName,
 Database database,
 SchemaExaminer schemaExaminer,
 String schema,
 Token table)

Method Details

renameTable

public IBaseBuilder renameTable(Token newTableName)

Description copied from interface: IAlterTableBuilder

Rename a table.

Note: This is a terminal statement.

Specified by:

renameTable in interface IAlterTableBuilder

Parameters:

newTableName - the new name of the table

Returns:

this builder, but no more chaining makes sense after this statement. Remember to call IBaseBuilder.execute()

renameTableIfPossible

public IBaseBuilder renameTableIfPossible(Token newTableName)

Description copied from interface: IAlterTableBuilder

Rename a table if no table exists with the new name.

Note: This is a terminal statement.

Specified by:

renameTableIfPossible in interface IAlterTableBuilder

Parameters:

newTableName - the new name of the table

Returns:

this builder, but no more chaining makes sense after this statement. Remember to call IBaseBuilder.execute()

addColumn

public IAlterTableBuilder addColumn(Token columnName,
 SqlType<?> columnType)

Description copied from interface: IAlterTableBuilder

Add a column with a specific sql type. Will fail if a column with the same name already exists. If you are adding auto-increment column it will be automatically made the new primary key.

Specified by:

addColumn in interface IAlterTableBuilder

Parameters:

columnName - the name of the column

columnType - the type of the column

Returns:

this builder, for chaining. Remember to call IBaseBuilder.execute()

addColumnIfNotExists

public IAlterTableBuilder addColumnIfNotExists(Token columnName,
 SqlType<?> columnType)

Description copied from interface: IAlterTableBuilder

Add a column with a specific sql type. Does nothing if a column with the same name already exists. If you are adding auto-increment column it will be automatically made the new primary key.

Specified by:

addColumnIfNotExists in interface IAlterTableBuilder

Parameters:

columnName - the name of the column

columnType - the type of the column

Returns:

this builder, for chaining. Remember to call IBaseBuilder.execute()

renameColumn

public IAlterTableBuilder renameColumn(Token oldColumnName,
 Token newColumnName)

Description copied from interface: IAlterTableBuilder

Rename a column.

Specified by:

renameColumn in interface IAlterTableBuilder

Parameters:

oldColumnName - the old name of the column

newColumnName - the new name of the column

Returns:

this builder, for chaining. Remember to call IBaseBuilder.execute()

renameColumnIfPossible

public IAlterTableBuilder renameColumnIfPossible(Token oldColumnName,
 Token newColumnName)

Description copied from interface: IAlterTableBuilder

Rename a column if it exists and no column exists with the new name.

Specified by:

renameColumnIfPossible in interface IAlterTableBuilder

Parameters:

oldColumnName - the old name of the column

newColumnName - the new name of the column

Returns:

this builder, for chaining. Remember to call IBaseBuilder.execute()

changeColumnType

public IAlterTableBuilder changeColumnType(Token columnName,
 SqlType<?> newColumnType)

Description copied from interface: IAlterTableBuilder

Change the type of column to a specific sql type. Auto-increment is not supported, you will have to drop the column and add a new one.

Specified by:

changeColumnType in interface IAlterTableBuilder

Parameters:

columnName - the name of the column

newColumnType - the new type of the column

Returns:

this builder, for chaining. Remember to call IBaseBuilder.execute()

changeColumnTypeIfExists

public IAlterTableBuilder changeColumnTypeIfExists(Token columnName,
 SqlType<?> newColumnType)

Description copied from interface: IAlterTableBuilder

Change the type of column to a specific sql type, if it exists. Auto-increment is not supported, you will have to drop the column and add a new one.

Specified by:

changeColumnTypeIfExists in interface IAlterTableBuilder

Parameters:

columnName - the name of the column

newColumnType - the new type of the column

Returns:

this builder, for chaining. Remember to call IBaseBuilder.execute()

dropColumn

public IAlterTableBuilder dropColumn(Token columnName)

Description copied from interface: IAlterTableBuilder

Drop a column. Will fail if the column does not exist.

Specified by:

dropColumn in interface IAlterTableBuilder

Parameters:

columnName - the name of the column

Returns:

this builder, for chaining. Remember to call IBaseBuilder.execute()

dropColumnIfExists

public IAlterTableBuilder dropColumnIfExists(Token columnName)

Description copied from interface: IAlterTableBuilder

Drop a column if it exists.

Specified by:

dropColumnIfExists in interface IAlterTableBuilder

Parameters:

columnName - the name of the column

Returns:

this builder, for chaining. Remember to call IBaseBuilder.execute()

addPrimaryKey

public IAlterTableBuilder addPrimaryKey(Token firstColumn,
 Token... columns)

Description copied from interface: IAlterTableBuilder

Add a primary key. If the table already has a primary key, use IAlterTableBuilder.changePrimaryKey(Token, Token...).

Specified by:

addPrimaryKey in interface IAlterTableBuilder

Parameters:

firstColumn - the first column of the primary key

columns - the rest of the columns of the primary key

Returns:

this builder, for chaining. Remember to call IBaseBuilder.execute()

addForeignKey

public IAlterTableBuilder addForeignKey(String constraintName,
 Token[] columns,
 Token referencedTable,
 Token[] referencedColumns)

Description copied from interface: IAlterTableBuilder

Add a foreign key

Specified by:

addForeignKey in interface IAlterTableBuilder

Parameters:

constraintName - the name of the foreign key

columns - the columns of the foreign key

referencedTable - the table referenced by the foreign key

referencedColumns - the referenced columns of the foreign key

Returns:

foreign key builder used to specify the referenced table and column(s)

addUnique

public IAlterTableBuilder addUnique(String constraintName,
 Token firstColumn,
 Token... columns)

Description copied from interface: IAlterTableBuilder

Add a unique constraint

Specified by:

addUnique in interface IAlterTableBuilder

Parameters:

constraintName - the name of the constraint

firstColumn - the first column of the constraint

columns - the rest of the columns of the constraint

Returns:

this builder, for chaining. Remember to call IBaseBuilder.execute()

addIndex

public IAlterTableBuilder addIndex(String indexName,
 Token firstColumn,
 Token... columns)

Description copied from interface: IAlterTableBuilder

Add an index

Specified by:

addIndex in interface IAlterTableBuilder

Parameters:

indexName - the name of the index

firstColumn - the first column of the index

columns - the rest of the columns of the index

Returns:

this builder, for chaining. Remember to call IBaseBuilder.execute()

changePrimaryKey

public IAlterTableBuilder changePrimaryKey(Token firstColumn,
 Token... columns)

Description copied from interface: IAlterTableBuilder

Change the primary key. Works regardless if the table already has a primary key or not.

Specified by:

changePrimaryKey in interface IAlterTableBuilder

Parameters:

firstColumn - the first column of the primary key

columns - the rest of the columns of the primary key

Returns:

this builder, for chaining. Remember to call IBaseBuilder.execute()

renameIndex

public IAlterTableBuilder renameIndex(String oldIndexName,
 String newIndexName)

Description copied from interface: IAlterTableBuilder

Rename an index

Specified by:

renameIndex in interface IAlterTableBuilder

Parameters:

oldIndexName - the old name of the index

newIndexName - the new name of the index

Returns:

this builder, for chaining. Remember to call IBaseBuilder.execute()

dropPrimaryKey

public IAlterTableBuilder dropPrimaryKey()

Description copied from interface: IAlterTableBuilder

Drop a primary key without adding a new one. Consider using IAlterTableBuilder.changePrimaryKey(String, String...) instead. If you are adding auto-increment column as a new primary key, do not use this method, but use IAlterTableBuilder.changePrimaryKey(String, String...) afterwards.

Specified by:

dropPrimaryKey in interface IAlterTableBuilder

Returns:

this builder, for chaining. Remember to call IBaseBuilder.execute()

dropPrimaryKeyIfExists

public IAlterTableBuilder dropPrimaryKeyIfExists()

Description copied from interface: IAlterTableBuilder

Drop a primary key if it exists, without adding a new one. Consider using IAlterTableBuilder.changePrimaryKey(String, String...) instead. If you are adding auto-increment column as a new primary key, do not use this method, but use IAlterTableBuilder.changePrimaryKey(String, String...) afterwards.

Specified by:

dropPrimaryKeyIfExists in interface IAlterTableBuilder

Returns:

this builder, for chaining. Remember to call IBaseBuilder.execute()

dropForeignKey

public IAlterTableBuilder dropForeignKey(String constraintName)

Description copied from interface: IAlterTableBuilder

Drop a foreign key. Will fail if the foreign key does not exist.

Specified by:

dropForeignKey in interface IAlterTableBuilder

Parameters:

constraintName - the name of the foreign key

Returns:

this builder, for chaining. Remember to call IBaseBuilder.execute()

dropUnique

public IAlterTableBuilder dropUnique(String constraintName)

Description copied from interface: IAlterTableBuilder

Drop a unique constraint. Will fail if the constraint does not exist.

Specified by:

dropUnique in interface IAlterTableBuilder

Parameters:

constraintName - the name of the constraint

Returns:

this builder, for chaining. Remember to call IBaseBuilder.execute()

dropIndex

public IAlterTableBuilder dropIndex(String indexName)

Description copied from interface: IAlterTableBuilder

Drop an index. Will fail if the index does not exist.

Specified by:

dropIndex in interface IAlterTableBuilder

Parameters:

indexName - the name of the index

Returns:

this builder, for chaining. Remember to call IBaseBuilder.execute()

execute

public void execute()

Description copied from interface: IBaseBuilder

Execute the create/alter table statement(s)

Specified by:

execute in interface IBaseBuilder

getSql

public String getSql()

Description copied from interface: IBaseBuilder

Useful for debugging

Specified by:

getSql in interface IBaseBuilder

Returns:

the sql that would be executed by IBaseBuilder.execute()