Module org.jooq

Package org.jooq

Interface AlterTableStep

public interface AlterTableStep

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:

• They're operating on mutable implementations (as of jOOQ 3.x)
• They're less composable and not easy to get right when dynamic SQL gets complex
• They're less readable
• They might have binary incompatible changes between minor releases

Author:

Lukas Eder

Method Summary

Modifier and Type	Method	Description
@NotNull AlterTableAddStep	add(String field, DataType<?> type)	Add an ADD COLUMN clause to the ALTER TABLE statement.
@NotNull AlterTableAddStep	add(Collection<? extends TableElement> fields)	Add an ADD clause with multiple columns or constraints to the ALTER TABLE statement.
@NotNull AlterTableUsingIndexStep	add(Constraint constraint)	Add an ADD CONSTRAINT clause to the ALTER TABLE statement.
@NotNull AlterTableAddStep	add(Field<?> field)	Add an ADD COLUMN clause to the ALTER TABLE statement.
<T> @NotNull AlterTableAddStep	add(Field<T> field, DataType<T> type)	Add an ADD COLUMN clause to the ALTER TABLE statement.
@NotNull AlterTableAddStep	add(Name field, DataType<?> type)	Add an ADD COLUMN clause to the ALTER TABLE statement.
@NotNull AlterTableAddStep	add(TableElement field)	Add an ADD clause with multiple columns or constraints to the ALTER TABLE statement.
@NotNull AlterTableAddStep	add(TableElement... fields)	Add an ADD clause with multiple columns or constraints to the ALTER TABLE statement.
@NotNull AlterTableAddStep	addColumn(String field, DataType<?> type)	Add an ADD COLUMN clause to the ALTER TABLE statement.
@NotNull AlterTableAddStep	addColumn(Field<?> field)	Add an ADD COLUMN clause to the ALTER TABLE statement.
<T> @NotNull AlterTableAddStep	addColumn(Field<T> field, DataType<T> type)	Add an ADD COLUMN clause to the ALTER TABLE statement.
@NotNull AlterTableAddStep	addColumn(Name field, DataType<?> type)	Add an ADD COLUMN clause to the ALTER TABLE statement.
@NotNull AlterTableAddStep	addColumnIfNotExists(String field, DataType<?> type)	Add an ADD COLUMN IF NOT EXISTS clause to the ALTER TABLE statement.
@NotNull AlterTableAddStep	addColumnIfNotExists(Field<?> field)	Add an ADD COLUMN IF NOT EXISTS clause to the ALTER TABLE statement.
<T> @NotNull AlterTableAddStep	addColumnIfNotExists(Field<T> field, DataType<T> type)	Add an ADD COLUMN IF NOT EXISTS clause to the ALTER TABLE statement.
@NotNull AlterTableAddStep	addColumnIfNotExists(Name field, DataType<?> type)	Add an ADD COLUMN IF NOT EXISTS clause to the ALTER TABLE statement.
@NotNull AlterTableAddStep	addIfNotExists(String field, DataType<?> type)	Add an ADD COLUMN IF NOT EXISTS clause to the ALTER TABLE statement.
@NotNull AlterTableAddStep	addIfNotExists(Field<?> field)	Add an ADD COLUMN IF NOT EXISTS clause to the ALTER TABLE statement.
<T> @NotNull AlterTableAddStep	addIfNotExists(Field<T> field, DataType<T> type)	Add an ADD COLUMN IF NOT EXISTS clause to the ALTER TABLE statement.
@NotNull AlterTableAddStep	addIfNotExists(Name field, DataType<?> type)	Add an ADD COLUMN IF NOT EXISTS clause to the ALTER TABLE statement.
@NotNull AlterTableAlterStep<Object>	alter(String field)	Add an ALTER COLUMN clause to the ALTER TABLE statement.
@NotNull AlterTableAlterConstraintStep	alter(Constraint constraint)	Add an ALTER CONSTRAINT clause to the ALTER TABLE statement.
<T> @NotNull AlterTableAlterStep<T>	alter(Field<T> field)	Add an ALTER COLUMN clause to the ALTER TABLE statement.
@NotNull AlterTableAlterStep<Object>	alter(Name field)	Add an ALTER COLUMN clause to the ALTER TABLE statement.
@NotNull AlterTableAlterStep<Object>	alterColumn(String field)	Add an ALTER COLUMN clause to the ALTER TABLE statement.
<T> @NotNull AlterTableAlterStep<T>	alterColumn(Field<T> field)	Add an ALTER COLUMN clause to the ALTER TABLE statement.
@NotNull AlterTableAlterStep<Object>	alterColumn(Name field)	Add an ALTER COLUMN clause to the ALTER TABLE statement.
@NotNull AlterTableAlterConstraintStep	alterConstraint(String constraint)	Add an ALTER CONSTRAINT clause to the ALTER TABLE statement.
@NotNull AlterTableAlterConstraintStep	alterConstraint(Constraint constraint)	Add an ALTER CONSTRAINT clause to the ALTER TABLE statement.
@NotNull AlterTableAlterConstraintStep	alterConstraint(Name constraint)	Add an ALTER CONSTRAINT clause to the ALTER TABLE statement.
@NotNull AlterTableFinalStep	comment(String comment)	Specify a comment for a table using MySQL's syntax.
@NotNull AlterTableFinalStep	comment(Comment comment)	Specify a comment for a table using MySQL's syntax.
@NotNull AlterTableDropStep	drop(String field)	Add an DROP COLUMN clause to the ALTER TABLE statement.
@NotNull AlterTableDropStep	drop(String... fields)	Add an DROP COLUMN clause to the ALTER TABLE statement.
@NotNull AlterTableDropStep	drop(Collection<? extends Field<?>> fields)	Add an DROP COLUMN clause to the ALTER TABLE statement.
@NotNull AlterTableDropStep	drop(Constraint constraint)	Add a DROP CONSTRAINT clause to the ALTER TABLE statement.
@NotNull AlterTableDropStep	drop(Field<?> field)	Add an DROP COLUMN clause to the ALTER TABLE statement.
@NotNull AlterTableDropStep	drop(Field<?>... fields)	Add an DROP COLUMN clause to the ALTER TABLE statement.
@NotNull AlterTableDropStep	drop(Name field)	Add an DROP COLUMN clause to the ALTER TABLE statement.
@NotNull AlterTableDropStep	drop(Name... fields)	Add an DROP COLUMN clause to the ALTER TABLE statement.
@NotNull AlterTableDropStep	dropColumn(String field)	Add an DROP COLUMN clause to the ALTER TABLE statement.
@NotNull AlterTableDropStep	dropColumn(Field<?> field)	Add an DROP COLUMN clause to the ALTER TABLE statement.
@NotNull AlterTableDropStep	dropColumn(Name field)	Add an DROP COLUMN clause to the ALTER TABLE statement.
@NotNull AlterTableDropStep	dropColumnIfExists(String field)	Add an DROP COLUMN IF EXISTS clause to the ALTER TABLE statement.
@NotNull AlterTableDropStep	dropColumnIfExists(Field<?> field)	Add an DROP COLUMN IF EXISTS clause to the ALTER TABLE statement.
@NotNull AlterTableDropStep	dropColumnIfExists(Name field)	Add an DROP COLUMN IF EXISTS clause to the ALTER TABLE statement.
@NotNull AlterTableDropStep	dropColumns(String... fields)	Add an DROP COLUMN clause to the ALTER TABLE statement.
@NotNull AlterTableDropStep	dropColumns(Collection<? extends Field<?>> fields)	Add an DROP COLUMN clause to the ALTER TABLE statement.
@NotNull AlterTableDropStep	dropColumns(Field<?>... fields)	Add an DROP COLUMN clause to the ALTER TABLE statement.
@NotNull AlterTableDropStep	dropColumns(Name... fields)	Add an DROP COLUMN clause to the ALTER TABLE statement.
@NotNull AlterTableDropStep	dropConstraint(String constraint)	Add a DROP CONSTRAINT clause to the ALTER TABLE statement.
@NotNull AlterTableDropStep	dropConstraint(Constraint constraint)	Add a DROP CONSTRAINT clause to the ALTER TABLE statement.
@NotNull AlterTableDropStep	dropConstraint(Name constraint)	Add a DROP CONSTRAINT clause to the ALTER TABLE statement.
@NotNull AlterTableDropStep	dropConstraintIfExists(String constraint)	Add a DROP CONSTRAINT IF EXISTS clause to the ALTER TABLE statement.
@NotNull AlterTableDropStep	dropConstraintIfExists(Constraint constraint)	Add a DROP CONSTRAINT IF EXISTS clause to the ALTER TABLE statement.
@NotNull AlterTableDropStep	dropConstraintIfExists(Name constraint)	Add a DROP CONSTRAINT IF EXISTS clause to the ALTER TABLE statement.
@NotNull AlterTableDropStep	dropForeignKey(String constraint)	Add a DROP FOREIGN KEY clause to the ALTER TABLE statement.
@NotNull AlterTableDropStep	dropForeignKey(Constraint constraint)	Add a DROP FOREIGN KEY clause to the ALTER TABLE statement.
@NotNull AlterTableDropStep	dropForeignKey(Name constraint)	Add a DROP FOREIGN KEY clause to the ALTER TABLE statement.
@NotNull AlterTableDropStep	dropIfExists(String field)	Add an DROP COLUMN IF EXISTS clause to the ALTER TABLE statement.
@NotNull AlterTableDropStep	dropIfExists(Constraint constraint)	Add a DROP CONSTRAINT IF EXISTS clause to the ALTER TABLE statement.
@NotNull AlterTableDropStep	dropIfExists(Field<?> field)	Add an DROP COLUMN IF EXISTS clause to the ALTER TABLE statement.
@NotNull AlterTableDropStep	dropIfExists(Name field)	Add an DROP COLUMN IF EXISTS clause to the ALTER TABLE statement.
@NotNull AlterTableDropStep	dropPrimaryKey()	Add a DROP PRIMARY KEY clause to the ALTER TABLE statement.
@NotNull AlterTableDropStep	dropPrimaryKey(String constraint)	Add a DROP PRIMARY KEY clause to the ALTER TABLE statement.
@NotNull AlterTableDropStep	dropPrimaryKey(Constraint constraint)	Add a DROP PRIMARY KEY clause to the ALTER TABLE statement.
@NotNull AlterTableDropStep	dropPrimaryKey(Name constraint)	Add a DROP PRIMARY KEY clause to the ALTER TABLE statement.
@NotNull AlterTableDropStep	dropUnique(String constraint)	Add a DROP UNIQUE clause to the ALTER TABLE statement.
@NotNull AlterTableDropStep	dropUnique(Constraint constraint)	Add a DROP UNIQUE clause to the ALTER TABLE statement.
@NotNull AlterTableDropStep	dropUnique(Name constraint)	Add a DROP UNIQUE clause to the ALTER TABLE statement.
@NotNull AlterTableRenameColumnToStep	renameColumn(String oldName)	Add a RENAME COLUMN clause to the ALTER TABLE statement.
@NotNull AlterTableRenameColumnToStep	renameColumn(Field<?> oldName)	Add a RENAME COLUMN clause to the ALTER TABLE statement.
@NotNull AlterTableRenameColumnToStep	renameColumn(Name oldName)	Add a RENAME COLUMN clause to the ALTER TABLE statement.
@NotNull AlterTableRenameConstraintToStep	renameConstraint(String oldName)	Add a RENAME CONSTRAINT clause to the ALTER TABLE statement.
@NotNull AlterTableRenameConstraintToStep	renameConstraint(Constraint oldName)	Add a RENAME CONSTRAINT clause to the ALTER TABLE statement.
@NotNull AlterTableRenameConstraintToStep	renameConstraint(Name oldName)	Add a RENAME CONSTRAINT clause to the ALTER TABLE statement.
@NotNull AlterTableRenameIndexToStep	renameIndex(String oldName)	Add a RENAME INDEX clause to the ALTER TABLE statement.
@NotNull AlterTableRenameIndexToStep	renameIndex(Index oldName)	Add a RENAME INDEX clause to the ALTER TABLE statement.
@NotNull AlterTableRenameIndexToStep	renameIndex(Name oldName)	Add a RENAME INDEX clause to the ALTER TABLE statement.
@NotNull AlterTableFinalStep	renameTo(String newName)	Add a RENAME TO clause to the ALTER TABLE statement.
@NotNull AlterTableFinalStep	renameTo(Name newName)	Add a RENAME TO clause to the ALTER TABLE statement.
@NotNull AlterTableFinalStep	renameTo(Table<?> newName)	Add a RENAME TO clause to the ALTER TABLE statement.

Method Details

comment

@NotNull
@CheckReturnValue
@Support({AURORA_MYSQL,AURORA_POSTGRES,BIGQUERY,CLICKHOUSE,COCKROACHDB,DATABRICKS,DB2,DUCKDB,EXASOL,FIREBIRD,H2,HANA,HSQLDB,MARIADB,MEMSQL,MYSQL,ORACLE,POSTGRES,SNOWFLAKE,SQLSERVER,SYBASE,TERADATA,TRINO,VERTICA,YUGABYTEDB})
@NotNull AlterTableFinalStep comment(String comment)

Specify a comment for a table using MySQL's syntax.

See Also:

• DSL.commentOnTable(Table)
• DSLContext.commentOnTable(Table)

comment

@NotNull
@CheckReturnValue
@Support({AURORA_MYSQL,AURORA_POSTGRES,BIGQUERY,CLICKHOUSE,COCKROACHDB,DATABRICKS,DB2,DUCKDB,EXASOL,FIREBIRD,H2,HANA,HSQLDB,MARIADB,MEMSQL,MYSQL,ORACLE,POSTGRES,SNOWFLAKE,SQLSERVER,SYBASE,TERADATA,TRINO,VERTICA,YUGABYTEDB})
@NotNull AlterTableFinalStep comment(Comment comment)

Specify a comment for a table using MySQL's syntax.

See Also:

• DSL.commentOnTable(Table)
• DSLContext.commentOnTable(Table)

renameTo

@NotNull
@CheckReturnValue
@Support({ACCESS,ASE,AURORA_MYSQL,AURORA_POSTGRES,BIGQUERY,CLICKHOUSE,COCKROACHDB,CUBRID,DATABRICKS,DB2,DERBY,DUCKDB,EXASOL,H2,HANA,HSQLDB,INFORMIX,INGRES,MARIADB,MEMSQL,MYSQL,ORACLE,POSTGRES,REDSHIFT,SNOWFLAKE,SQLDATAWAREHOUSE,SQLITE,SQLSERVER,SYBASE,TERADATA,TRINO,VERTICA,YUGABYTEDB})
@NotNull AlterTableFinalStep renameTo(Table<?> newName)

Add a RENAME TO clause to the ALTER TABLE statement.

renameTo

@NotNull
@CheckReturnValue
@Support({ACCESS,ASE,AURORA_MYSQL,AURORA_POSTGRES,BIGQUERY,CLICKHOUSE,COCKROACHDB,CUBRID,DATABRICKS,DB2,DERBY,DUCKDB,EXASOL,H2,HANA,HSQLDB,INFORMIX,INGRES,MARIADB,MEMSQL,MYSQL,ORACLE,POSTGRES,REDSHIFT,SNOWFLAKE,SQLDATAWAREHOUSE,SQLITE,SQLSERVER,SYBASE,TERADATA,TRINO,VERTICA,YUGABYTEDB})
@NotNull AlterTableFinalStep renameTo(Name newName)

Add a RENAME TO clause to the ALTER TABLE statement.

renameTo

@NotNull
@CheckReturnValue
@Support({ACCESS,ASE,AURORA_MYSQL,AURORA_POSTGRES,BIGQUERY,CLICKHOUSE,COCKROACHDB,CUBRID,DATABRICKS,DB2,DERBY,DUCKDB,EXASOL,H2,HANA,HSQLDB,INFORMIX,INGRES,MARIADB,MEMSQL,MYSQL,ORACLE,POSTGRES,REDSHIFT,SNOWFLAKE,SQLDATAWAREHOUSE,SQLITE,SQLSERVER,SYBASE,TERADATA,TRINO,VERTICA,YUGABYTEDB})
@NotNull AlterTableFinalStep renameTo(String newName)

Add a RENAME TO clause to the ALTER TABLE statement.

renameColumn

@NotNull
@CheckReturnValue
@Support({ACCESS,ASE,AURORA_MYSQL,AURORA_POSTGRES,BIGQUERY,CLICKHOUSE,COCKROACHDB,CUBRID,DATABRICKS,DB2,DERBY,DUCKDB,EXASOL,FIREBIRD,H2,HANA,HSQLDB,INFORMIX,INGRES,MARIADB,MEMSQL,MYSQL,ORACLE,POSTGRES,REDSHIFT,SNOWFLAKE,SQLDATAWAREHOUSE,SQLITE,SQLSERVER,SYBASE,TERADATA,TRINO,VERTICA,YUGABYTEDB})
@NotNull AlterTableRenameColumnToStep renameColumn(Field<?> oldName)

Add a RENAME COLUMN clause to the ALTER TABLE statement.

renameColumn

@NotNull
@CheckReturnValue
@Support({ACCESS,ASE,AURORA_MYSQL,AURORA_POSTGRES,BIGQUERY,CLICKHOUSE,COCKROACHDB,CUBRID,DATABRICKS,DB2,DERBY,DUCKDB,EXASOL,FIREBIRD,H2,HANA,HSQLDB,INFORMIX,INGRES,MARIADB,MEMSQL,MYSQL,ORACLE,POSTGRES,REDSHIFT,SNOWFLAKE,SQLDATAWAREHOUSE,SQLITE,SQLSERVER,SYBASE,TERADATA,TRINO,VERTICA,YUGABYTEDB})
@NotNull AlterTableRenameColumnToStep renameColumn(Name oldName)

Add a RENAME COLUMN clause to the ALTER TABLE statement.

renameColumn

@NotNull
@CheckReturnValue
@Support({ACCESS,ASE,AURORA_MYSQL,AURORA_POSTGRES,BIGQUERY,CLICKHOUSE,COCKROACHDB,CUBRID,DATABRICKS,DB2,DERBY,DUCKDB,EXASOL,FIREBIRD,H2,HANA,HSQLDB,INFORMIX,INGRES,MARIADB,MEMSQL,MYSQL,ORACLE,POSTGRES,REDSHIFT,SNOWFLAKE,SQLDATAWAREHOUSE,SQLITE,SQLSERVER,SYBASE,TERADATA,TRINO,VERTICA,YUGABYTEDB})
@NotNull AlterTableRenameColumnToStep renameColumn(String oldName)

Add a RENAME COLUMN clause to the ALTER TABLE statement.

renameIndex

@NotNull
@CheckReturnValue
@Support({ASE,AURORA_MYSQL,AURORA_POSTGRES,COCKROACHDB,DB2,DERBY,H2,HANA,HSQLDB,MARIADB,MEMSQL,MYSQL,ORACLE,POSTGRES,SQLDATAWAREHOUSE,SQLSERVER2016})
@NotNull AlterTableRenameIndexToStep renameIndex(Name oldName)

Add a RENAME INDEX clause to the ALTER TABLE statement.

renameIndex

@NotNull
@CheckReturnValue
@Support({ASE,AURORA_MYSQL,AURORA_POSTGRES,COCKROACHDB,DB2,DERBY,H2,HANA,HSQLDB,MARIADB,MEMSQL,MYSQL,ORACLE,POSTGRES,SQLDATAWAREHOUSE,SQLSERVER2016})
@NotNull AlterTableRenameIndexToStep renameIndex(Index oldName)

Add a RENAME INDEX clause to the ALTER TABLE statement.

renameIndex

@NotNull
@CheckReturnValue
@Support({ASE,AURORA_MYSQL,AURORA_POSTGRES,COCKROACHDB,DB2,DERBY,H2,HANA,HSQLDB,MARIADB,MEMSQL,MYSQL,ORACLE,POSTGRES,SQLDATAWAREHOUSE,SQLSERVER2016})
@NotNull AlterTableRenameIndexToStep renameIndex(String oldName)

Add a RENAME INDEX clause to the ALTER TABLE statement.

renameConstraint

@NotNull
@CheckReturnValue
@Support({ACCESS,ASE,AURORA_MYSQL,AURORA_POSTGRES,COCKROACHDB,CUBRID,DB2,H2,HSQLDB,INFORMIX,INGRES,ORACLE,POSTGRES,SNOWFLAKE,SQLDATAWAREHOUSE,SQLSERVER,SYBASE,TERADATA,VERTICA,YUGABYTEDB})
@NotNull AlterTableRenameConstraintToStep renameConstraint(Constraint oldName)

Add a RENAME CONSTRAINT clause to the ALTER TABLE statement.

renameConstraint

@NotNull
@CheckReturnValue
@Support({ACCESS,ASE,AURORA_MYSQL,AURORA_POSTGRES,COCKROACHDB,CUBRID,DB2,H2,HSQLDB,INFORMIX,INGRES,ORACLE,POSTGRES,SNOWFLAKE,SQLDATAWAREHOUSE,SQLSERVER,SYBASE,TERADATA,VERTICA,YUGABYTEDB})
@NotNull AlterTableRenameConstraintToStep renameConstraint(Name oldName)

Add a RENAME CONSTRAINT clause to the ALTER TABLE statement.

renameConstraint

@NotNull
@CheckReturnValue
@Support({ACCESS,ASE,AURORA_MYSQL,AURORA_POSTGRES,COCKROACHDB,CUBRID,DB2,H2,HSQLDB,INFORMIX,INGRES,ORACLE,POSTGRES,SNOWFLAKE,SQLDATAWAREHOUSE,SQLSERVER,SYBASE,TERADATA,VERTICA,YUGABYTEDB})
@NotNull AlterTableRenameConstraintToStep renameConstraint(String oldName)

Add a RENAME CONSTRAINT clause to the ALTER TABLE statement.

alter

@NotNull
@CheckReturnValue
@Support({DB2,MYSQL_8_0_19,ORACLE})
@NotNull AlterTableAlterConstraintStep alter(Constraint constraint)

Add an ALTER CONSTRAINT clause to the ALTER TABLE statement.

This is an alias for alterConstraint(Constraint).

alter

@NotNull
@CheckReturnValue
@Support({ACCESS,ASE,AURORA_MYSQL,AURORA_POSTGRES,BIGQUERY,CLICKHOUSE,COCKROACHDB,CUBRID,DATABRICKS,DB2,DERBY,DUCKDB,EXASOL,FIREBIRD,H2,HANA,HSQLDB,INFORMIX,INGRES,MARIADB,MEMSQL,MYSQL,ORACLE,POSTGRES,SNOWFLAKE,SQLDATAWAREHOUSE,SQLSERVER,SYBASE,TRINO,VERTICA,YUGABYTEDB})
<T> @NotNull AlterTableAlterStep<T> alter(Field<T> field)

Add an ALTER COLUMN clause to the ALTER TABLE statement.

This is an alias for alterColumn(Field).

alter

@NotNull
@CheckReturnValue
@Support({ACCESS,ASE,AURORA_MYSQL,AURORA_POSTGRES,BIGQUERY,CLICKHOUSE,COCKROACHDB,CUBRID,DATABRICKS,DB2,DERBY,DUCKDB,EXASOL,FIREBIRD,H2,HANA,HSQLDB,INFORMIX,INGRES,MARIADB,MEMSQL,MYSQL,ORACLE,POSTGRES,SNOWFLAKE,SQLDATAWAREHOUSE,SQLSERVER,SYBASE,TRINO,VERTICA,YUGABYTEDB})
@NotNull AlterTableAlterStep<Object> alter(Name field)

Add an ALTER COLUMN clause to the ALTER TABLE statement.

This is an alias for alterColumn(Name)

alter

@NotNull
@CheckReturnValue
@Support({ACCESS,ASE,AURORA_MYSQL,AURORA_POSTGRES,BIGQUERY,CLICKHOUSE,COCKROACHDB,CUBRID,DATABRICKS,DB2,DERBY,DUCKDB,EXASOL,FIREBIRD,H2,HANA,HSQLDB,INFORMIX,INGRES,MARIADB,MEMSQL,MYSQL,ORACLE,POSTGRES,SNOWFLAKE,SQLDATAWAREHOUSE,SQLSERVER,SYBASE,TRINO,VERTICA,YUGABYTEDB})
@NotNull AlterTableAlterStep<Object> alter(String field)

Add an ALTER COLUMN clause to the ALTER TABLE statement.

This is an alias for alterColumn(String)

alterColumn

@NotNull
@CheckReturnValue
@Support({ACCESS,ASE,AURORA_MYSQL,AURORA_POSTGRES,BIGQUERY,CLICKHOUSE,COCKROACHDB,CUBRID,DATABRICKS,DB2,DERBY,DUCKDB,EXASOL,FIREBIRD,H2,HANA,HSQLDB,INFORMIX,INGRES,MARIADB,MEMSQL,MYSQL,ORACLE,POSTGRES,SNOWFLAKE,SQLDATAWAREHOUSE,SQLSERVER,SYBASE,TRINO,VERTICA,YUGABYTEDB})
<T> @NotNull AlterTableAlterStep<T> alterColumn(Field<T> field)

Add an ALTER COLUMN clause to the ALTER TABLE statement.

alterColumn

@NotNull
@CheckReturnValue
@Support({ACCESS,ASE,AURORA_MYSQL,AURORA_POSTGRES,BIGQUERY,CLICKHOUSE,COCKROACHDB,CUBRID,DATABRICKS,DB2,DERBY,DUCKDB,EXASOL,FIREBIRD,H2,HANA,HSQLDB,INFORMIX,INGRES,MARIADB,MEMSQL,MYSQL,ORACLE,POSTGRES,SNOWFLAKE,SQLDATAWAREHOUSE,SQLSERVER,SYBASE,TRINO,VERTICA,YUGABYTEDB})
@NotNull AlterTableAlterStep<Object> alterColumn(Name field)

Add an ALTER COLUMN clause to the ALTER TABLE statement.

alterColumn

@NotNull
@CheckReturnValue
@Support({ACCESS,ASE,AURORA_MYSQL,AURORA_POSTGRES,BIGQUERY,CLICKHOUSE,COCKROACHDB,CUBRID,DATABRICKS,DB2,DERBY,DUCKDB,EXASOL,FIREBIRD,H2,HANA,HSQLDB,INFORMIX,INGRES,MARIADB,MEMSQL,MYSQL,ORACLE,POSTGRES,SNOWFLAKE,SQLDATAWAREHOUSE,SQLSERVER,SYBASE,TRINO,VERTICA,YUGABYTEDB})
@NotNull AlterTableAlterStep<Object> alterColumn(String field)

Add an ALTER COLUMN clause to the ALTER TABLE statement.

alterConstraint

@NotNull
@CheckReturnValue
@Support({DB2,MYSQL_8_0_19,ORACLE})
@NotNull AlterTableAlterConstraintStep alterConstraint(Constraint constraint)

Add an ALTER CONSTRAINT clause to the ALTER TABLE statement.

alterConstraint

@NotNull
@CheckReturnValue
@Support({DB2,MYSQL_8_0_19,ORACLE})
@NotNull AlterTableAlterConstraintStep alterConstraint(Name constraint)

Add an ALTER CONSTRAINT clause to the ALTER TABLE statement.

alterConstraint

@NotNull
@CheckReturnValue
@Support({DB2,MYSQL_8_0_19,ORACLE})
@NotNull AlterTableAlterConstraintStep alterConstraint(String constraint)

Add an ALTER CONSTRAINT clause to the ALTER TABLE statement.

add

@NotNull
@CheckReturnValue
@Support
@NotNull AlterTableAddStep add(Field<?> field)

Add an ADD COLUMN clause to the ALTER TABLE statement.

This is an alias for addColumn(Field).

add

@NotNull
@CheckReturnValue
@Support
@NotNull AlterTableAddStep add(TableElement field)

Add an ADD clause with multiple columns or constraints to the ALTER TABLE statement.

add

@NotNull
@CheckReturnValue
@Support({ASE,AURORA_MYSQL,AURORA_POSTGRES,BIGQUERY,CLICKHOUSE,COCKROACHDB,DATABRICKS,DB2,FIREBIRD,H2,HANA,IGNITE,INFORMIX,MARIADB,MEMSQL,MYSQL,ORACLE,POSTGRES,SNOWFLAKE,SQLDATAWAREHOUSE,SQLSERVER,TERADATA,YUGABYTEDB})
@NotNull AlterTableAddStep add(TableElement... fields)

Add an ADD clause with multiple columns or constraints to the ALTER TABLE statement.

add

@NotNull
@CheckReturnValue
@Support({ASE,AURORA_MYSQL,AURORA_POSTGRES,BIGQUERY,CLICKHOUSE,COCKROACHDB,DATABRICKS,DB2,FIREBIRD,H2,HANA,IGNITE,INFORMIX,MARIADB,MEMSQL,MYSQL,ORACLE,POSTGRES,SNOWFLAKE,SQLDATAWAREHOUSE,SQLSERVER,TERADATA,YUGABYTEDB})
@NotNull AlterTableAddStep add(Collection<? extends TableElement> fields)

Add an ADD clause with multiple columns or constraints to the ALTER TABLE statement.

add

@NotNull
@CheckReturnValue
@Support
<T> @NotNull AlterTableAddStep add(Field<T> field,
 DataType<T> type)

Add an ADD COLUMN clause to the ALTER TABLE statement.

This is an alias for addColumn(Field, DataType).

add

@NotNull
@CheckReturnValue
@Support
@NotNull AlterTableAddStep add(Name field,
 DataType<?> type)

Add an ADD COLUMN clause to the ALTER TABLE statement.

This is an alias for addColumn(Name, DataType).

add

@NotNull
@CheckReturnValue
@Support
@NotNull AlterTableAddStep add(String field,
 DataType<?> type)

Add an ADD COLUMN clause to the ALTER TABLE statement.

This is an alias for addColumn(String, DataType).

addIfNotExists

@NotNull
@CheckReturnValue
@Support({AURORA_POSTGRES,BIGQUERY,CLICKHOUSE,COCKROACHDB,DATABRICKS,DB2,DUCKDB,EXASOL,H2,HANA,IGNITE,MARIADB,ORACLE,POSTGRES_10,SQLDATAWAREHOUSE,SQLSERVER,TERADATA,TRINO,YUGABYTEDB})
@NotNull AlterTableAddStep addIfNotExists(Field<?> field)

Add an ADD COLUMN IF NOT EXISTS clause to the ALTER TABLE statement.

This is an alias for addColumnIfNotExists(Field).

addIfNotExists

@NotNull
@CheckReturnValue
@Support({AURORA_POSTGRES,BIGQUERY,CLICKHOUSE,COCKROACHDB,DATABRICKS,DB2,DUCKDB,EXASOL,H2,HANA,IGNITE,MARIADB,ORACLE,POSTGRES_10,SQLDATAWAREHOUSE,SQLSERVER,TERADATA,TRINO,YUGABYTEDB})
<T> @NotNull AlterTableAddStep addIfNotExists(Field<T> field,
 DataType<T> type)

Add an ADD COLUMN IF NOT EXISTS clause to the ALTER TABLE statement.

This is an alias for addColumnIfNotExists(Field, DataType).

addIfNotExists

@NotNull
@CheckReturnValue
@Support({AURORA_POSTGRES,BIGQUERY,CLICKHOUSE,COCKROACHDB,DATABRICKS,DB2,DUCKDB,EXASOL,H2,HANA,IGNITE,MARIADB,ORACLE,POSTGRES_10,SQLDATAWAREHOUSE,SQLSERVER,TERADATA,TRINO,YUGABYTEDB})
@NotNull AlterTableAddStep addIfNotExists(Name field,
 DataType<?> type)

Add an ADD COLUMN IF NOT EXISTS clause to the ALTER TABLE statement.

This is an alias for addColumnIfNotExists(Name, DataType).

addIfNotExists

@NotNull
@CheckReturnValue
@Support({AURORA_POSTGRES,BIGQUERY,CLICKHOUSE,COCKROACHDB,DATABRICKS,DB2,DUCKDB,EXASOL,H2,HANA,IGNITE,MARIADB,ORACLE,POSTGRES_10,SQLDATAWAREHOUSE,SQLSERVER,TERADATA,TRINO,YUGABYTEDB})
@NotNull AlterTableAddStep addIfNotExists(String field,
 DataType<?> type)

Add an ADD COLUMN IF NOT EXISTS clause to the ALTER TABLE statement.

This is an alias for addColumnIfNotExists(String, DataType).

addColumn

@NotNull
@CheckReturnValue
@Support
@NotNull AlterTableAddStep addColumn(Field<?> field)

Add an ADD COLUMN clause to the ALTER TABLE statement.

addColumn

@NotNull
@CheckReturnValue
@Support
<T> @NotNull AlterTableAddStep addColumn(Field<T> field,
 DataType<T> type)

Add an ADD COLUMN clause to the ALTER TABLE statement.

addColumn

@NotNull
@CheckReturnValue
@Support
@NotNull AlterTableAddStep addColumn(Name field,
 DataType<?> type)

Add an ADD COLUMN clause to the ALTER TABLE statement.

addColumn

@NotNull
@CheckReturnValue
@Support
@NotNull AlterTableAddStep addColumn(String field,
 DataType<?> type)

Add an ADD COLUMN clause to the ALTER TABLE statement.

addColumnIfNotExists

@NotNull
@CheckReturnValue
@Support({AURORA_POSTGRES,BIGQUERY,CLICKHOUSE,COCKROACHDB,DATABRICKS,DB2,DUCKDB,EXASOL,H2,HANA,IGNITE,MARIADB,ORACLE,POSTGRES_10,SQLDATAWAREHOUSE,SQLSERVER,TERADATA,TRINO,YUGABYTEDB})
@NotNull AlterTableAddStep addColumnIfNotExists(Field<?> field)

Add an ADD COLUMN IF NOT EXISTS clause to the ALTER TABLE statement.

addColumnIfNotExists

@NotNull
@CheckReturnValue
@Support({AURORA_POSTGRES,BIGQUERY,CLICKHOUSE,COCKROACHDB,DATABRICKS,DB2,DUCKDB,EXASOL,H2,HANA,IGNITE,MARIADB,ORACLE,POSTGRES_10,SQLDATAWAREHOUSE,SQLSERVER,TERADATA,TRINO,YUGABYTEDB})
<T> @NotNull AlterTableAddStep addColumnIfNotExists(Field<T> field,
 DataType<T> type)

Add an ADD COLUMN IF NOT EXISTS clause to the ALTER TABLE statement.

addColumnIfNotExists

@NotNull
@CheckReturnValue
@Support({AURORA_POSTGRES,BIGQUERY,CLICKHOUSE,COCKROACHDB,DATABRICKS,DB2,DUCKDB,EXASOL,H2,HANA,IGNITE,MARIADB,ORACLE,POSTGRES_10,SQLDATAWAREHOUSE,SQLSERVER,TERADATA,TRINO,YUGABYTEDB})
@NotNull AlterTableAddStep addColumnIfNotExists(Name field,
 DataType<?> type)

Add an ADD COLUMN IF NOT EXISTS clause to the ALTER TABLE statement.

addColumnIfNotExists

@NotNull
@CheckReturnValue
@Support({AURORA_POSTGRES,BIGQUERY,CLICKHOUSE,COCKROACHDB,DATABRICKS,DB2,DUCKDB,EXASOL,H2,HANA,IGNITE,MARIADB,ORACLE,POSTGRES_10,SQLDATAWAREHOUSE,SQLSERVER,TERADATA,TRINO,YUGABYTEDB})
@NotNull AlterTableAddStep addColumnIfNotExists(String field,
 DataType<?> type)

Add an ADD COLUMN IF NOT EXISTS clause to the ALTER TABLE statement.

add

@NotNull
@CheckReturnValue
@Support({ACCESS,ASE,AURORA_MYSQL,AURORA_POSTGRES,BIGQUERY,CLICKHOUSE,COCKROACHDB,CUBRID,DATABRICKS,DB2,DERBY,EXASOL,FIREBIRD,H2,HANA,HSQLDB,INFORMIX,INGRES,MARIADB,MEMSQL,MYSQL,ORACLE,POSTGRES,REDSHIFT,SNOWFLAKE,SQLDATAWAREHOUSE,SQLSERVER,SYBASE,TERADATA,VERTICA,YUGABYTEDB})
@NotNull AlterTableUsingIndexStep add(Constraint constraint)

Add an ADD CONSTRAINT clause to the ALTER TABLE statement.

drop

@NotNull
@CheckReturnValue
@Support({ACCESS,ASE,AURORA_MYSQL,AURORA_POSTGRES,BIGQUERY,CLICKHOUSE,COCKROACHDB,CUBRID,DATABRICKS,DB2,DERBY,DUCKDB,EXASOL,FIREBIRD,H2,HANA,HSQLDB,IGNITE,INFORMIX,INGRES,MARIADB,MEMSQL,MYSQL,ORACLE,POSTGRES,SNOWFLAKE,SQLDATAWAREHOUSE,SQLITE_3_38,SQLSERVER,SYBASE,TERADATA,TRINO,VERTICA,YUGABYTEDB})
@NotNull AlterTableDropStep drop(Field<?> field)

Add an DROP COLUMN clause to the ALTER TABLE statement.

This is an alias for dropColumn(Field).

drop

@NotNull
@CheckReturnValue
@Support({ACCESS,ASE,AURORA_MYSQL,AURORA_POSTGRES,BIGQUERY,CLICKHOUSE,COCKROACHDB,CUBRID,DATABRICKS,DB2,DERBY,DUCKDB,EXASOL,FIREBIRD,H2,HANA,HSQLDB,IGNITE,INFORMIX,INGRES,MARIADB,MEMSQL,MYSQL,ORACLE,POSTGRES,SNOWFLAKE,SQLDATAWAREHOUSE,SQLITE_3_38,SQLSERVER,SYBASE,TERADATA,TRINO,VERTICA,YUGABYTEDB})
@NotNull AlterTableDropStep drop(Name field)

Add an DROP COLUMN clause to the ALTER TABLE statement.

This is an alias for dropColumn(Name).

drop

@NotNull
@CheckReturnValue
@Support({ACCESS,ASE,AURORA_MYSQL,AURORA_POSTGRES,BIGQUERY,CLICKHOUSE,COCKROACHDB,CUBRID,DATABRICKS,DB2,DERBY,DUCKDB,EXASOL,FIREBIRD,H2,HANA,HSQLDB,IGNITE,INFORMIX,INGRES,MARIADB,MEMSQL,MYSQL,ORACLE,POSTGRES,SNOWFLAKE,SQLDATAWAREHOUSE,SQLITE_3_38,SQLSERVER,SYBASE,TERADATA,TRINO,VERTICA,YUGABYTEDB})
@NotNull AlterTableDropStep drop(String field)

Add an DROP COLUMN clause to the ALTER TABLE statement.

This is an alias for dropColumn(String).

dropIfExists

@NotNull
@CheckReturnValue
@Support({AURORA_POSTGRES,BIGQUERY,CLICKHOUSE,COCKROACHDB,DATABRICKS,DB2,DUCKDB,EXASOL,H2,HANA,IGNITE,MARIADB,ORACLE,POSTGRES,SQLDATAWAREHOUSE,SQLSERVER,TERADATA,TRINO,YUGABYTEDB})
@NotNull AlterTableDropStep dropIfExists(Field<?> field)

Add an DROP COLUMN IF EXISTS clause to the ALTER TABLE statement.

This is an alias for dropColumnIfExists(Field).

dropIfExists

@NotNull
@CheckReturnValue
@Support({AURORA_POSTGRES,BIGQUERY,CLICKHOUSE,COCKROACHDB,DATABRICKS,DB2,DUCKDB,EXASOL,H2,HANA,IGNITE,MARIADB,ORACLE,POSTGRES,SQLDATAWAREHOUSE,SQLSERVER,TERADATA,TRINO,YUGABYTEDB})
@NotNull AlterTableDropStep dropIfExists(Name field)

Add an DROP COLUMN IF EXISTS clause to the ALTER TABLE statement.

This is an alias for dropColumnIfExists(Name).

dropIfExists

@NotNull
@CheckReturnValue
@Support({AURORA_POSTGRES,BIGQUERY,CLICKHOUSE,COCKROACHDB,DATABRICKS,DB2,DUCKDB,EXASOL,H2,HANA,IGNITE,MARIADB,ORACLE,POSTGRES,SQLDATAWAREHOUSE,SQLSERVER,TERADATA,TRINO,YUGABYTEDB})
@NotNull AlterTableDropStep dropIfExists(String field)

Add an DROP COLUMN IF EXISTS clause to the ALTER TABLE statement.

This is an alias for dropColumnIfExists(String).

dropColumn

@NotNull
@CheckReturnValue
@Support({ACCESS,ASE,AURORA_MYSQL,AURORA_POSTGRES,BIGQUERY,CLICKHOUSE,COCKROACHDB,CUBRID,DATABRICKS,DB2,DERBY,DUCKDB,EXASOL,FIREBIRD,H2,HANA,HSQLDB,IGNITE,INFORMIX,INGRES,MARIADB,MEMSQL,MYSQL,ORACLE,POSTGRES,SNOWFLAKE,SQLDATAWAREHOUSE,SQLITE_3_38,SQLSERVER,SYBASE,TERADATA,TRINO,VERTICA,YUGABYTEDB})
@NotNull AlterTableDropStep dropColumn(Field<?> field)

Add an DROP COLUMN clause to the ALTER TABLE statement.

dropColumn

@NotNull
@CheckReturnValue
@Support({ACCESS,ASE,AURORA_MYSQL,AURORA_POSTGRES,BIGQUERY,CLICKHOUSE,COCKROACHDB,CUBRID,DATABRICKS,DB2,DERBY,DUCKDB,EXASOL,FIREBIRD,H2,HANA,HSQLDB,IGNITE,INFORMIX,INGRES,MARIADB,MEMSQL,MYSQL,ORACLE,POSTGRES,SNOWFLAKE,SQLDATAWAREHOUSE,SQLITE_3_38,SQLSERVER,SYBASE,TERADATA,TRINO,VERTICA,YUGABYTEDB})
@NotNull AlterTableDropStep dropColumn(Name field)

Add an DROP COLUMN clause to the ALTER TABLE statement.

dropColumn

@NotNull
@CheckReturnValue
@Support({ACCESS,ASE,AURORA_MYSQL,AURORA_POSTGRES,BIGQUERY,CLICKHOUSE,COCKROACHDB,CUBRID,DATABRICKS,DB2,DERBY,DUCKDB,EXASOL,FIREBIRD,H2,HANA,HSQLDB,IGNITE,INFORMIX,INGRES,MARIADB,MEMSQL,MYSQL,ORACLE,POSTGRES,SNOWFLAKE,SQLDATAWAREHOUSE,SQLITE_3_38,SQLSERVER,SYBASE,TERADATA,TRINO,VERTICA,YUGABYTEDB})
@NotNull AlterTableDropStep dropColumn(String field)

Add an DROP COLUMN clause to the ALTER TABLE statement.

dropColumnIfExists

@NotNull
@CheckReturnValue
@Support({AURORA_POSTGRES,BIGQUERY,CLICKHOUSE,COCKROACHDB,DATABRICKS,DB2,DUCKDB,EXASOL,H2,HANA,IGNITE,MARIADB,ORACLE,POSTGRES,SQLDATAWAREHOUSE,SQLSERVER,TERADATA,TRINO,YUGABYTEDB})
@NotNull AlterTableDropStep dropColumnIfExists(Field<?> field)

Add an DROP COLUMN IF EXISTS clause to the ALTER TABLE statement.

dropColumnIfExists

@NotNull
@CheckReturnValue
@Support({AURORA_POSTGRES,BIGQUERY,CLICKHOUSE,COCKROACHDB,DATABRICKS,DB2,DUCKDB,EXASOL,H2,HANA,IGNITE,MARIADB,ORACLE,POSTGRES,SQLDATAWAREHOUSE,SQLSERVER,TERADATA,TRINO,YUGABYTEDB})
@NotNull AlterTableDropStep dropColumnIfExists(Name field)

Add an DROP COLUMN IF EXISTS clause to the ALTER TABLE statement.

dropColumnIfExists

@NotNull
@CheckReturnValue
@Support({AURORA_POSTGRES,BIGQUERY,CLICKHOUSE,COCKROACHDB,DATABRICKS,DB2,DUCKDB,EXASOL,H2,HANA,IGNITE,MARIADB,ORACLE,POSTGRES,SQLDATAWAREHOUSE,SQLSERVER,TERADATA,TRINO,YUGABYTEDB})
@NotNull AlterTableDropStep dropColumnIfExists(String field)

Add an DROP COLUMN IF EXISTS clause to the ALTER TABLE statement.

drop

@NotNull
@CheckReturnValue
@Support({ASE,AURORA_MYSQL,AURORA_POSTGRES,BIGQUERY,CLICKHOUSE,COCKROACHDB,DATABRICKS,DB2,FIREBIRD,H2,HANA,IGNITE,INFORMIX,MARIADB,MEMSQL,MYSQL,ORACLE,POSTGRES,SNOWFLAKE,SQLDATAWAREHOUSE,SQLSERVER,TERADATA,YUGABYTEDB})
@NotNull AlterTableDropStep drop(Field<?>... fields)

Add an DROP COLUMN clause to the ALTER TABLE statement.

This is an alias for dropColumns(Collection).

drop

@NotNull
@CheckReturnValue
@Support({ASE,AURORA_MYSQL,AURORA_POSTGRES,BIGQUERY,CLICKHOUSE,COCKROACHDB,DATABRICKS,DB2,FIREBIRD,H2,HANA,IGNITE,INFORMIX,MARIADB,MEMSQL,MYSQL,ORACLE,POSTGRES,SNOWFLAKE,SQLDATAWAREHOUSE,SQLSERVER,TERADATA,YUGABYTEDB})
@NotNull AlterTableDropStep drop(Name... fields)

Add an DROP COLUMN clause to the ALTER TABLE statement.

This is an alias for dropColumns(Collection).

drop

@NotNull
@CheckReturnValue
@Support({ASE,AURORA_MYSQL,AURORA_POSTGRES,BIGQUERY,CLICKHOUSE,COCKROACHDB,DATABRICKS,DB2,FIREBIRD,H2,HANA,IGNITE,INFORMIX,MARIADB,MEMSQL,MYSQL,ORACLE,POSTGRES,SNOWFLAKE,SQLDATAWAREHOUSE,SQLSERVER,TERADATA,YUGABYTEDB})
@NotNull AlterTableDropStep drop(String... fields)

Add an DROP COLUMN clause to the ALTER TABLE statement.

This is an alias for dropColumns(Collection).

dropColumns

@NotNull
@CheckReturnValue
@Support({ASE,AURORA_MYSQL,AURORA_POSTGRES,BIGQUERY,CLICKHOUSE,COCKROACHDB,DATABRICKS,DB2,FIREBIRD,H2,HANA,IGNITE,INFORMIX,MARIADB,MEMSQL,MYSQL,ORACLE,POSTGRES,SNOWFLAKE,SQLDATAWAREHOUSE,SQLSERVER,TERADATA,YUGABYTEDB})
@NotNull AlterTableDropStep dropColumns(Field<?>... fields)

Add an DROP COLUMN clause to the ALTER TABLE statement.

dropColumns

@NotNull
@CheckReturnValue
@Support({ASE,AURORA_MYSQL,AURORA_POSTGRES,BIGQUERY,CLICKHOUSE,COCKROACHDB,DATABRICKS,DB2,FIREBIRD,H2,HANA,IGNITE,INFORMIX,MARIADB,MEMSQL,MYSQL,ORACLE,POSTGRES,SNOWFLAKE,SQLDATAWAREHOUSE,SQLSERVER,TERADATA,YUGABYTEDB})
@NotNull AlterTableDropStep dropColumns(Name... fields)

Add an DROP COLUMN clause to the ALTER TABLE statement.

dropColumns

@NotNull
@CheckReturnValue
@Support({ASE,AURORA_MYSQL,AURORA_POSTGRES,BIGQUERY,CLICKHOUSE,COCKROACHDB,DATABRICKS,DB2,FIREBIRD,H2,HANA,IGNITE,INFORMIX,MARIADB,MEMSQL,MYSQL,ORACLE,POSTGRES,SNOWFLAKE,SQLDATAWAREHOUSE,SQLSERVER,TERADATA,YUGABYTEDB})
@NotNull AlterTableDropStep dropColumns(String... fields)

Add an DROP COLUMN clause to the ALTER TABLE statement.

drop

@NotNull
@CheckReturnValue
@Support({ASE,AURORA_MYSQL,AURORA_POSTGRES,BIGQUERY,CLICKHOUSE,COCKROACHDB,DATABRICKS,DB2,FIREBIRD,H2,HANA,IGNITE,INFORMIX,MARIADB,MEMSQL,MYSQL,ORACLE,POSTGRES,SNOWFLAKE,SQLDATAWAREHOUSE,SQLSERVER,TERADATA,YUGABYTEDB})
@NotNull AlterTableDropStep drop(Collection<? extends Field<?>> fields)

Add an DROP COLUMN clause to the ALTER TABLE statement.

This is an alias for dropColumns(Collection).

dropColumns

@NotNull
@CheckReturnValue
@Support({ASE,AURORA_MYSQL,AURORA_POSTGRES,BIGQUERY,CLICKHOUSE,COCKROACHDB,DATABRICKS,DB2,FIREBIRD,H2,HANA,IGNITE,INFORMIX,MARIADB,MEMSQL,MYSQL,ORACLE,POSTGRES,SNOWFLAKE,SQLDATAWAREHOUSE,SQLSERVER,TERADATA,YUGABYTEDB})
@NotNull AlterTableDropStep dropColumns(Collection<? extends Field<?>> fields)

Add an DROP COLUMN clause to the ALTER TABLE statement.

drop

@NotNull
@CheckReturnValue
@Support({ACCESS,ASE,AURORA_POSTGRES,BIGQUERY,CLICKHOUSE,COCKROACHDB,CUBRID,DATABRICKS,DB2,DERBY,EXASOL,FIREBIRD,H2,HANA,HSQLDB,INFORMIX,INGRES,MARIADB,MEMSQL,ORACLE,POSTGRES,REDSHIFT,SNOWFLAKE,SQLDATAWAREHOUSE,SQLSERVER,SYBASE,TERADATA,VERTICA,YUGABYTEDB})
@NotNull AlterTableDropStep drop(Constraint constraint)

Add a DROP CONSTRAINT clause to the ALTER TABLE statement.

dropConstraint

@NotNull
@CheckReturnValue
@Support({ACCESS,ASE,AURORA_POSTGRES,BIGQUERY,CLICKHOUSE,COCKROACHDB,CUBRID,DATABRICKS,DB2,DERBY,EXASOL,FIREBIRD,H2,HANA,HSQLDB,INFORMIX,INGRES,MARIADB,ORACLE,POSTGRES,REDSHIFT,SNOWFLAKE,SQLDATAWAREHOUSE,SQLSERVER,SYBASE,TERADATA,VERTICA,YUGABYTEDB})
@NotNull AlterTableDropStep dropConstraint(Constraint constraint)

Add a DROP CONSTRAINT clause to the ALTER TABLE statement.

See Also:

• DSL.constraint(String)

dropConstraint

@NotNull
@CheckReturnValue
@Support({ACCESS,ASE,AURORA_POSTGRES,BIGQUERY,CLICKHOUSE,COCKROACHDB,CUBRID,DATABRICKS,DB2,DERBY,EXASOL,FIREBIRD,H2,HANA,HSQLDB,INFORMIX,INGRES,MARIADB,ORACLE,POSTGRES,REDSHIFT,SNOWFLAKE,SQLDATAWAREHOUSE,SQLSERVER,SYBASE,TERADATA,VERTICA,YUGABYTEDB})
@NotNull AlterTableDropStep dropConstraint(Name constraint)

Add a DROP CONSTRAINT clause to the ALTER TABLE statement.

See Also:

• DSL.constraint(String)

dropConstraint

@NotNull
@CheckReturnValue
@Support({ACCESS,ASE,AURORA_POSTGRES,BIGQUERY,CLICKHOUSE,COCKROACHDB,CUBRID,DATABRICKS,DB2,DERBY,EXASOL,FIREBIRD,H2,HANA,HSQLDB,INFORMIX,INGRES,MARIADB,ORACLE,POSTGRES,REDSHIFT,SNOWFLAKE,SQLDATAWAREHOUSE,SQLSERVER,SYBASE,TERADATA,VERTICA,YUGABYTEDB})
@NotNull AlterTableDropStep dropConstraint(String constraint)

Add a DROP CONSTRAINT clause to the ALTER TABLE statement.

See Also:

• DSL.constraint(String)

dropIfExists

@NotNull
@CheckReturnValue
@Support({AURORA_POSTGRES,BIGQUERY,CLICKHOUSE,COCKROACHDB,DATABRICKS,DB2,FIREBIRD,H2,HANA,MARIADB_10_4,ORACLE,POSTGRES,SQLSERVER,YUGABYTEDB})
@NotNull AlterTableDropStep dropIfExists(Constraint constraint)

Add a DROP CONSTRAINT IF EXISTS clause to the ALTER TABLE statement.

dropConstraintIfExists

@NotNull
@CheckReturnValue
@Support({AURORA_POSTGRES,BIGQUERY,CLICKHOUSE,COCKROACHDB,DATABRICKS,DB2,FIREBIRD,H2,HANA,MARIADB_10_4,ORACLE,POSTGRES,SQLSERVER,YUGABYTEDB})
@NotNull AlterTableDropStep dropConstraintIfExists(Constraint constraint)

Add a DROP CONSTRAINT IF EXISTS clause to the ALTER TABLE statement.

See Also:

• DSL.constraint(String)

dropConstraintIfExists

@NotNull
@CheckReturnValue
@Support({AURORA_POSTGRES,BIGQUERY,CLICKHOUSE,COCKROACHDB,DATABRICKS,DB2,FIREBIRD,H2,HANA,MARIADB_10_4,ORACLE,POSTGRES,SQLSERVER,YUGABYTEDB})
@NotNull AlterTableDropStep dropConstraintIfExists(Name constraint)

Add a DROP CONSTRAINT IF EXISTS clause to the ALTER TABLE statement.

See Also:

• DSL.constraint(String)

dropConstraintIfExists

@NotNull
@CheckReturnValue
@Support({AURORA_POSTGRES,BIGQUERY,CLICKHOUSE,COCKROACHDB,DATABRICKS,DB2,FIREBIRD,H2,HANA,MARIADB_10_4,ORACLE,POSTGRES,SQLSERVER,YUGABYTEDB})
@NotNull AlterTableDropStep dropConstraintIfExists(String constraint)

Add a DROP CONSTRAINT IF EXISTS clause to the ALTER TABLE statement.

See Also:

• DSL.constraint(String)

dropPrimaryKey

@NotNull
@CheckReturnValue
@Support({AURORA_MYSQL,AURORA_POSTGRES,BIGQUERY,DATABRICKS,DB2,DERBY,EXASOL,H2,HANA,HSQLDB,MARIADB,MYSQL,POSTGRES,SNOWFLAKE})
@NotNull AlterTableDropStep dropPrimaryKey()

Add a DROP PRIMARY KEY clause to the ALTER TABLE statement.

dropPrimaryKey

@NotNull
@CheckReturnValue
@Support({ACCESS,ASE,AURORA_MYSQL,AURORA_POSTGRES,BIGQUERY,CUBRID,DATABRICKS,DB2,DERBY,EXASOL,FIREBIRD,H2,HANA,HSQLDB,INFORMIX,INGRES,MARIADB,MYSQL,ORACLE,POSTGRES,REDSHIFT,SNOWFLAKE,SQLDATAWAREHOUSE,SQLSERVER,SYBASE,TERADATA,VERTICA})
@NotNull AlterTableDropStep dropPrimaryKey(Constraint constraint)

Add a DROP PRIMARY KEY clause to the ALTER TABLE statement.

Dialect families derived from MySQL do not know named constraints, in case of which this clause simply generates DROP PRIMARY KEY as in dropPrimaryKey(). In other dialect families, this produces a DROP CONSTRAINT [name] clause, as in dropConstraint(Constraint).

dropPrimaryKey

@NotNull
@CheckReturnValue
@Support({ACCESS,ASE,AURORA_MYSQL,AURORA_POSTGRES,BIGQUERY,CUBRID,DATABRICKS,DB2,DERBY,EXASOL,FIREBIRD,H2,HANA,HSQLDB,INFORMIX,INGRES,MARIADB,MYSQL,ORACLE,POSTGRES,REDSHIFT,SNOWFLAKE,SQLDATAWAREHOUSE,SQLSERVER,SYBASE,TERADATA,VERTICA})
@NotNull AlterTableDropStep dropPrimaryKey(Name constraint)

Add a DROP PRIMARY KEY clause to the ALTER TABLE statement.

Dialect families derived from MySQL do not know named constraints, in case of which this clause simply generates DROP PRIMARY KEY as in dropPrimaryKey(). In other dialect families, this produces a DROP CONSTRAINT [name] clause, as in dropConstraint(Name).

See Also:

• DSL.constraint(Name)

dropPrimaryKey

@NotNull
@CheckReturnValue
@Support({ACCESS,ASE,AURORA_MYSQL,AURORA_POSTGRES,BIGQUERY,CUBRID,DATABRICKS,DB2,DERBY,EXASOL,FIREBIRD,H2,HANA,HSQLDB,INFORMIX,INGRES,MARIADB,MYSQL,ORACLE,POSTGRES,REDSHIFT,SNOWFLAKE,SQLDATAWAREHOUSE,SQLSERVER,SYBASE,TERADATA,VERTICA})
@NotNull AlterTableDropStep dropPrimaryKey(String constraint)

Add a DROP PRIMARY KEY clause to the ALTER TABLE statement.

Dialect families derived from MySQL do not know named constraints, in case of which this clause simply generates DROP PRIMARY KEY as in dropPrimaryKey(). In other dialect families, this produces a DROP CONSTRAINT [name] clause, as in dropConstraint(String).

See Also:

• DSL.constraint(String)

dropUnique

@NotNull
@CheckReturnValue
@Support({ACCESS,ASE,AURORA_MYSQL,AURORA_POSTGRES,COCKROACHDB,CUBRID,DB2,DERBY,FIREBIRD,H2,HANA,HSQLDB,INFORMIX,INGRES,MARIADB,MYSQL,ORACLE,POSTGRES,REDSHIFT,SNOWFLAKE,SQLDATAWAREHOUSE,SQLSERVER,SYBASE,TERADATA,VERTICA,YUGABYTEDB})
@NotNull AlterTableDropStep dropUnique(Constraint constraint)

Add a DROP UNIQUE clause to the ALTER TABLE statement.

Some dialects (e.g. SQLDialect.COCKROACHDB) may not be able to drop constraints by name. If users specify the constraint type and the name, however, then the syntax can be emulated, e.g. using DROP INDEX … CASCADE.

dropUnique

@NotNull
@CheckReturnValue
@Support({ACCESS,ASE,AURORA_MYSQL,AURORA_POSTGRES,COCKROACHDB,CUBRID,DB2,DERBY,FIREBIRD,H2,HANA,HSQLDB,INFORMIX,INGRES,MARIADB,MYSQL,ORACLE,POSTGRES,REDSHIFT,SNOWFLAKE,SQLDATAWAREHOUSE,SQLSERVER,SYBASE,TERADATA,VERTICA,YUGABYTEDB})
@NotNull AlterTableDropStep dropUnique(Name constraint)

Add a DROP UNIQUE clause to the ALTER TABLE statement.

Some dialects (e.g. SQLDialect.COCKROACHDB) may not be able to drop constraints by name. If users specify the constraint type and the name, however, then the syntax can be emulated, e.g. using DROP INDEX … CASCADE.

See Also:

• DSL.constraint(Name)

dropUnique

@NotNull
@CheckReturnValue
@Support({ACCESS,ASE,AURORA_MYSQL,AURORA_POSTGRES,COCKROACHDB,CUBRID,DB2,DERBY,FIREBIRD,H2,HANA,HSQLDB,INFORMIX,INGRES,MARIADB,MYSQL,ORACLE,POSTGRES,REDSHIFT,SNOWFLAKE,SQLDATAWAREHOUSE,SQLSERVER,SYBASE,TERADATA,VERTICA,YUGABYTEDB})
@NotNull AlterTableDropStep dropUnique(String constraint)

Add a DROP UNIQUE clause to the ALTER TABLE statement.

Some dialects (e.g. SQLDialect.COCKROACHDB) may not be able to drop constraints by name. If users specify the constraint type and the name, however, then the syntax can be emulated, e.g. using DROP INDEX … CASCADE.

See Also:

• DSL.constraint(String)

dropForeignKey

@NotNull
@CheckReturnValue
@Support({ACCESS,ASE,AURORA_MYSQL,AURORA_POSTGRES,BIGQUERY,COCKROACHDB,CUBRID,DATABRICKS,DB2,DERBY,EXASOL,FIREBIRD,H2,HANA,HSQLDB,INFORMIX,INGRES,MARIADB,MYSQL,ORACLE,POSTGRES,REDSHIFT,SNOWFLAKE,SQLDATAWAREHOUSE,SQLSERVER,SYBASE,TERADATA,VERTICA,YUGABYTEDB})
@NotNull AlterTableDropStep dropForeignKey(Constraint constraint)

Add a DROP FOREIGN KEY clause to the ALTER TABLE statement.

dropForeignKey

@NotNull
@CheckReturnValue
@Support({ACCESS,ASE,AURORA_MYSQL,AURORA_POSTGRES,BIGQUERY,COCKROACHDB,CUBRID,DATABRICKS,DB2,DERBY,EXASOL,FIREBIRD,H2,HANA,HSQLDB,INFORMIX,INGRES,MARIADB,MYSQL,ORACLE,POSTGRES,REDSHIFT,SNOWFLAKE,SQLDATAWAREHOUSE,SQLSERVER,SYBASE,TERADATA,VERTICA,YUGABYTEDB})
@NotNull AlterTableDropStep dropForeignKey(Name constraint)

Add a DROP FOREIGN KEY clause to the ALTER TABLE statement.

See Also:

• DSL.constraint(Name)

dropForeignKey

@NotNull
@CheckReturnValue
@Support({ACCESS,ASE,AURORA_MYSQL,AURORA_POSTGRES,BIGQUERY,COCKROACHDB,CUBRID,DATABRICKS,DB2,DERBY,EXASOL,FIREBIRD,H2,HANA,HSQLDB,INFORMIX,INGRES,MARIADB,MYSQL,ORACLE,POSTGRES,REDSHIFT,SNOWFLAKE,SQLDATAWAREHOUSE,SQLSERVER,SYBASE,TERADATA,VERTICA,YUGABYTEDB})
@NotNull AlterTableDropStep dropForeignKey(String constraint)

Add a DROP FOREIGN KEY clause to the ALTER TABLE statement.

See Also:

• DSL.constraint(String)