Top Description Methods
org.jooq

public Interface AlterTableStep

Known Direct Implementers
org.jooq.impl.AlterTableImpl
Static Imports
org.jooq.SQLDialect.CUBRID, .SQLDialect.DERBY, .SQLDialect.FIREBIRD, .SQLDialect.H2, .SQLDialect.HSQLDB, .SQLDialect.IGNITE, .SQLDialect.MARIADB, .SQLDialect.MYSQL, .SQLDialect.POSTGRES, .SQLDialect.SQLITE, .SQLDialect.YUGABYTEDB
The step in the ALTER TABLE statement where the action can be decided.

Referencing XYZ*Step types directly from client code

It is usually not recommended to reference any XYZ*Step types directly from client code, or assign them to local variables. When writing dynamic SQL, creating a statement's components dynamically, and passing them to the DSL API statically is usually a better choice. See the manual's section about dynamic SQL for details: https://www.jooq.org/doc/latest/manual/sql-building/dynamic-sql.

Drawbacks of referencing the XYZ*Step types directly:

Author
Lukas Eder

Method Summary

Modifier and TypeMethod and Description
public @NotNull AlterTableAddStep
add(Field<?> field)

Deprecated as a consequence of Field and AlterTableAddStep being deprecated.
Add an ADD COLUMN clause to the ALTER TABLE statement.
public @NotNull AlterTableAddStep
add(TableElement... fields)

Deprecated as a consequence of AlterTableAddStep being deprecated.
Add an ADD clause with multiple columns or constraints to the ALTER TABLE statement.
public @NotNull AlterTableAddStep
add(Collection<? extends TableElement> fields)

Deprecated as a consequence of AlterTableAddStep being deprecated.
Add an ADD clause with multiple columns or constraints to the ALTER TABLE statement.
public <T> @NotNull AlterTableAddStep
add(Field<T> field, DataType<T> type)

Deprecated as a consequence of Field and AlterTableAddStep being deprecated.
Add an ADD COLUMN clause to the ALTER TABLE statement.
public @NotNull AlterTableAddStep
add(Name field, DataType<?> type)

Deprecated as a consequence of AlterTableAddStep being deprecated.
Add an ADD COLUMN clause to the ALTER TABLE statement.
public @NotNull AlterTableAddStep
add(String field, DataType<?> type)

Deprecated as a consequence of AlterTableAddStep being deprecated.
Add an ADD COLUMN clause to the ALTER TABLE statement.
public @NotNull AlterTableUsingIndexStep
add(Constraint constraint)

Deprecated as a consequence of Constraint and AlterTableUsingIndexStep being deprecated.
Add an ADD CONSTRAINT clause to the ALTER TABLE statement.
public @NotNull AlterTableAddStep
addColumn(Field<?> field)

Deprecated as a consequence of Field and AlterTableAddStep being deprecated.
Add an ADD COLUMN clause to the ALTER TABLE statement.
public <T> @NotNull AlterTableAddStep
addColumn(Field<T> field, DataType<T> type)

Deprecated as a consequence of Field and AlterTableAddStep being deprecated.
Add an ADD COLUMN clause to the ALTER TABLE statement.
public @NotNull AlterTableAddStep
addColumn(Name field, DataType<?> type)

Deprecated as a consequence of AlterTableAddStep being deprecated.
Add an ADD COLUMN clause to the ALTER TABLE statement.
public @NotNull AlterTableAddStep
addColumn(String field, DataType<?> type)

Deprecated as a consequence of AlterTableAddStep being deprecated.
Add an ADD COLUMN clause to the ALTER TABLE statement.
public @NotNull AlterTableAddStep
addColumnIfNotExists(Field<?> field)

Deprecated as a consequence of Field and AlterTableAddStep being deprecated.
Add an ADD COLUMN IF NOT EXISTS clause to the ALTER TABLE statement.
public <T> @NotNull AlterTableAddStep
addColumnIfNotExists(Field<T> field, DataType<T> type)

Deprecated as a consequence of Field and AlterTableAddStep being deprecated.
Add an ADD COLUMN IF NOT EXISTS clause to the ALTER TABLE statement.
public @NotNull AlterTableAddStep
addColumnIfNotExists(Name field, DataType<?> type)

Deprecated as a consequence of AlterTableAddStep being deprecated.
Add an ADD COLUMN IF NOT EXISTS clause to the ALTER TABLE statement.
public @NotNull AlterTableAddStep
addColumnIfNotExists(String field, DataType<?> type)

Deprecated as a consequence of AlterTableAddStep being deprecated.
Add an ADD COLUMN IF NOT EXISTS clause to the ALTER TABLE statement.
public @NotNull AlterTableAddStep
addIfNotExists(Field<?> field)

Deprecated as a consequence of Field and AlterTableAddStep being deprecated.
Add an ADD COLUMN IF NOT EXISTS clause to the ALTER TABLE statement.
public <T> @NotNull AlterTableAddStep
addIfNotExists(Field<T> field, DataType<T> type)

Deprecated as a consequence of Field and AlterTableAddStep being deprecated.
Add an ADD COLUMN IF NOT EXISTS clause to the ALTER TABLE statement.
public @NotNull AlterTableAddStep
addIfNotExists(Name field, DataType<?> type)

Deprecated as a consequence of AlterTableAddStep being deprecated.
Add an ADD COLUMN IF NOT EXISTS clause to the ALTER TABLE statement.
public @NotNull AlterTableAddStep
addIfNotExists(String field, DataType<?> type)

Deprecated as a consequence of AlterTableAddStep being deprecated.
Add an ADD COLUMN IF NOT EXISTS clause to the ALTER TABLE statement.
public @NotNull AlterTableAlterConstraintStep
alter(Constraint constraint)

Deprecated as a consequence of Constraint being deprecated.
Add an ALTER CONSTRAINT clause to the ALTER TABLE statement.
public <T> @NotNull AlterTableAlterStep<T>
alter(Field<T> field)

Deprecated as a consequence of Field being deprecated.
Add an ALTER COLUMN clause to the ALTER TABLE statement.
public @NotNull AlterTableAlterStep<Object>
alter(Name field)

Add an ALTER COLUMN clause to the ALTER TABLE statement.

public @NotNull AlterTableAlterStep<Object>
alter(String field)

Add an ALTER COLUMN clause to the ALTER TABLE statement.

public <T> @NotNull AlterTableAlterStep<T>
alterColumn(Field<T> field)

Deprecated as a consequence of Field being deprecated.
Add an ALTER COLUMN clause to the ALTER TABLE statement.
public @NotNull AlterTableAlterStep<Object>
alterColumn(Name field)

Add an ALTER COLUMN clause to the ALTER TABLE statement.

public @NotNull AlterTableAlterStep<Object>
alterColumn(String field)

Add an ALTER COLUMN clause to the ALTER TABLE statement.

public @NotNull AlterTableAlterConstraintStep
alterConstraint(Constraint constraint)

Deprecated as a consequence of Constraint being deprecated.
Add an ALTER CONSTRAINT clause to the ALTER TABLE statement.
public @NotNull AlterTableAlterConstraintStep
alterConstraint(Name constraint)

Add an ALTER CONSTRAINT clause to the ALTER TABLE statement.

public @NotNull AlterTableAlterConstraintStep
alterConstraint(String constraint)

Add an ALTER CONSTRAINT clause to the ALTER TABLE statement.

public @NotNull AlterTableFinalStep
comment(String comment)

Deprecated as a consequence of AlterTableFinalStep being deprecated.
Specify a comment for a table using MySQL's syntax.
public @NotNull AlterTableFinalStep
comment(Comment comment)

Deprecated as a consequence of AlterTableFinalStep being deprecated.
Specify a comment for a table using MySQL's syntax.
public @NotNull AlterTableDropStep
drop(Field<?> field)

Deprecated as a consequence of Field and AlterTableDropStep being deprecated.
Add an DROP COLUMN clause to the ALTER TABLE statement.
public @NotNull AlterTableDropStep
drop(Name field)

Deprecated as a consequence of AlterTableDropStep being deprecated.
Add an DROP COLUMN clause to the ALTER TABLE statement.
public @NotNull AlterTableDropStep
drop(String field)

Deprecated as a consequence of AlterTableDropStep being deprecated.
Add an DROP COLUMN clause to the ALTER TABLE statement.
public @NotNull AlterTableDropStep
drop(Field<?>... fields)

Deprecated as a consequence of Field and AlterTableDropStep being deprecated.
Add an DROP COLUMN clause to the ALTER TABLE statement.
public @NotNull AlterTableDropStep
drop(Name... fields)

Deprecated as a consequence of AlterTableDropStep being deprecated.
Add an DROP COLUMN clause to the ALTER TABLE statement.
public @NotNull AlterTableDropStep
drop(String... fields)

Deprecated as a consequence of AlterTableDropStep being deprecated.
Add an DROP COLUMN clause to the ALTER TABLE statement.
public @NotNull AlterTableDropStep
drop(Collection<? extends Field<?>> fields)

Deprecated as a consequence of AlterTableDropStep being deprecated.
Add an DROP COLUMN clause to the ALTER TABLE statement.
public @NotNull AlterTableDropStep
drop(Constraint constraint)

Deprecated as a consequence of Constraint and AlterTableDropStep being deprecated.
Add a DROP CONSTRAINT clause to the ALTER TABLE statement.
public @NotNull AlterTableDropStep
dropColumn(Field<?> field)

Deprecated as a consequence of Field and AlterTableDropStep being deprecated.
Add an DROP COLUMN clause to the ALTER TABLE statement.
public @NotNull AlterTableDropStep
dropColumn(Name field)

Deprecated as a consequence of AlterTableDropStep being deprecated.
Add an DROP COLUMN clause to the ALTER TABLE statement.
public @NotNull AlterTableDropStep
dropColumn(String field)

Deprecated as a consequence of AlterTableDropStep being deprecated.
Add an DROP COLUMN clause to the ALTER TABLE statement.
public @NotNull AlterTableDropStep
dropColumnIfExists(Field<?> field)

Deprecated as a consequence of Field and AlterTableDropStep being deprecated.
Add an DROP COLUMN IF EXISTS clause to the ALTER TABLE statement.
public @NotNull AlterTableDropStep
dropColumnIfExists(Name field)

Deprecated as a consequence of AlterTableDropStep being deprecated.
Add an DROP COLUMN IF EXISTS clause to the ALTER TABLE statement.
public @NotNull AlterTableDropStep
dropColumnIfExists(String field)

Deprecated as a consequence of AlterTableDropStep being deprecated.
Add an DROP COLUMN IF EXISTS clause to the ALTER TABLE statement.
public @NotNull AlterTableDropStep
dropColumns(Field<?>... fields)

Deprecated as a consequence of Field and AlterTableDropStep being deprecated.
Add an DROP COLUMN clause to the ALTER TABLE statement.
public @NotNull AlterTableDropStep
dropColumns(Name... fields)

Deprecated as a consequence of AlterTableDropStep being deprecated.
Add an DROP COLUMN clause to the ALTER TABLE statement.
public @NotNull AlterTableDropStep
dropColumns(String... fields)

Deprecated as a consequence of AlterTableDropStep being deprecated.
Add an DROP COLUMN clause to the ALTER TABLE statement.
public @NotNull AlterTableDropStep
dropColumns(Collection<? extends Field<?>> fields)

Deprecated as a consequence of AlterTableDropStep being deprecated.
Add an DROP COLUMN clause to the ALTER TABLE statement.
public @NotNull AlterTableDropStep
dropConstraint(Constraint constraint)

Deprecated as a consequence of Constraint and AlterTableDropStep being deprecated.
Add a DROP CONSTRAINT clause to the ALTER TABLE statement.
public @NotNull AlterTableDropStep
dropConstraint(Name constraint)

Deprecated as a consequence of AlterTableDropStep being deprecated.
Add a DROP CONSTRAINT clause to the ALTER TABLE statement.
public @NotNull AlterTableDropStep
dropConstraint(String constraint)

Deprecated as a consequence of AlterTableDropStep being deprecated.
Add a DROP CONSTRAINT clause to the ALTER TABLE statement.
public @NotNull AlterTableDropStep
dropConstraintIfExists(Constraint constraint)

Deprecated as a consequence of Constraint and AlterTableDropStep being deprecated.
Add a DROP CONSTRAINT IF EXISTS clause to the ALTER TABLE statement.
public @NotNull AlterTableDropStep
dropConstraintIfExists(Name constraint)

Deprecated as a consequence of AlterTableDropStep being deprecated.
Add a DROP CONSTRAINT IF EXISTS clause to the ALTER TABLE statement.
public @NotNull AlterTableDropStep
dropConstraintIfExists(String constraint)

Deprecated as a consequence of AlterTableDropStep being deprecated.
Add a DROP CONSTRAINT IF EXISTS clause to the ALTER TABLE statement.
public @NotNull AlterTableDropStep
dropForeignKey(Constraint constraint)

Deprecated as a consequence of Constraint and AlterTableDropStep being deprecated.
Add a DROP FOREIGN KEY clause to the ALTER TABLE statement.
public @NotNull AlterTableDropStep
dropForeignKey(Name constraint)

Deprecated as a consequence of AlterTableDropStep being deprecated.
Add a DROP FOREIGN KEY clause to the ALTER TABLE statement.
public @NotNull AlterTableDropStep
dropForeignKey(String constraint)

Deprecated as a consequence of AlterTableDropStep being deprecated.
Add a DROP FOREIGN KEY clause to the ALTER TABLE statement.
public @NotNull AlterTableDropStep
dropIfExists(Field<?> field)

Deprecated as a consequence of Field and AlterTableDropStep being deprecated.
Add an DROP COLUMN IF EXISTS clause to the ALTER TABLE statement.
public @NotNull AlterTableDropStep
dropIfExists(Name field)

Deprecated as a consequence of AlterTableDropStep being deprecated.
Add an DROP COLUMN IF EXISTS clause to the ALTER TABLE statement.
public @NotNull AlterTableDropStep
dropIfExists(String field)

Deprecated as a consequence of AlterTableDropStep being deprecated.
Add an DROP COLUMN IF EXISTS clause to the ALTER TABLE statement.
public @NotNull AlterTableDropStep
dropIfExists(Constraint constraint)

Deprecated as a consequence of Constraint and AlterTableDropStep being deprecated.
Add a DROP CONSTRAINT IF EXISTS clause to the ALTER TABLE statement.
public @NotNull AlterTableDropStep
dropPrimaryKey()

Deprecated as a consequence of AlterTableDropStep being deprecated.
Add a DROP PRIMARY KEY clause to the ALTER TABLE statement.
public @NotNull AlterTableDropStep
dropPrimaryKey(Constraint constraint)

Deprecated as a consequence of Constraint and AlterTableDropStep being deprecated.
Add a DROP PRIMARY KEY clause to the ALTER TABLE statement.
public @NotNull AlterTableDropStep
dropPrimaryKey(Name constraint)

Deprecated as a consequence of AlterTableDropStep being deprecated.
Add a DROP PRIMARY KEY clause to the ALTER TABLE statement.
public @NotNull AlterTableDropStep
dropPrimaryKey(String constraint)

Deprecated as a consequence of AlterTableDropStep being deprecated.
Add a DROP PRIMARY KEY clause to the ALTER TABLE statement.
public @NotNull AlterTableDropStep
dropUnique(Constraint constraint)

Deprecated as a consequence of Constraint and AlterTableDropStep being deprecated.
Add a DROP UNIQUE clause to the ALTER TABLE statement.
public @NotNull AlterTableDropStep
dropUnique(Name constraint)

Deprecated as a consequence of AlterTableDropStep being deprecated.
Add a DROP UNIQUE clause to the ALTER TABLE statement.
public @NotNull AlterTableDropStep
dropUnique(String constraint)

Deprecated as a consequence of AlterTableDropStep being deprecated.
Add a DROP UNIQUE clause to the ALTER TABLE statement.
public @NotNull AlterTableRenameColumnToStep
renameColumn(Field<?> oldName)

Deprecated as a consequence of Field being deprecated.
Add a RENAME COLUMN clause to the ALTER TABLE statement.
public @NotNull AlterTableRenameColumnToStep
renameColumn(Name oldName)

Add a RENAME COLUMN clause to the ALTER TABLE statement.

public @NotNull AlterTableRenameColumnToStep
renameColumn(String oldName)

Add a RENAME COLUMN clause to the ALTER TABLE statement.

public @NotNull AlterTableRenameConstraintToStep
renameConstraint(Constraint oldName)

Deprecated as a consequence of Constraint being deprecated.
Add a RENAME CONSTRAINT clause to the ALTER TABLE statement.
public @NotNull AlterTableRenameConstraintToStep
renameConstraint(Name oldName)

Add a RENAME CONSTRAINT clause to the ALTER TABLE statement.

public @NotNull AlterTableRenameConstraintToStep
renameConstraint(String oldName)

Add a RENAME CONSTRAINT clause to the ALTER TABLE statement.

public @NotNull AlterTableRenameIndexToStep
renameIndex(Name oldName)

Add a RENAME INDEX clause to the ALTER TABLE statement.

public @NotNull AlterTableRenameIndexToStep
renameIndex(Index oldName)

Add a RENAME INDEX clause to the ALTER TABLE statement.

public @NotNull AlterTableRenameIndexToStep
renameIndex(String oldName)

Add a RENAME INDEX clause to the ALTER TABLE statement.

public @NotNull AlterTableFinalStep
renameTo(Table<?> newName)

Deprecated as a consequence of AlterTableFinalStep being deprecated.
Add a RENAME TO clause to the ALTER TABLE statement.
public @NotNull AlterTableFinalStep
renameTo(Name newName)

Deprecated as a consequence of AlterTableFinalStep being deprecated.
Add a RENAME TO clause to the ALTER TABLE statement.
public @NotNull AlterTableFinalStep
renameTo(String newName)

Deprecated as a consequence of AlterTableFinalStep being deprecated.
Add a RENAME TO clause to the ALTER TABLE statement.