public interface AlterTableAlterStep<T>
The step in the Referencing
ALTER TABLE
DSL used to ALTER
columns.
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 TypeMethodDescription@NotNull AlterTableFinalStep
Specify a new columnDEFAULT
.@NotNull AlterTableFinalStep
Specify a new columnDEFAULT
.@NotNull AlterTableFinalStep
defaultValue
(Field<T> expression) Specify a new columnDEFAULT
.@NotNull AlterTableFinalStep
defaultValue
(T literal) Specify a new columnDEFAULT
.@NotNull AlterTableFinalStep
Drop the columnDEFAULT
.@NotNull AlterTableFinalStep
Make the column nullable.@NotNull AlterTableFinalStep
Specify a new column data type.@NotNull AlterTableFinalStep
setDefault
(Field<T> expression) Specify a new columnDEFAULT
.@NotNull AlterTableFinalStep
setDefault
(T literal) Specify a new columnDEFAULT
.@NotNull AlterTableFinalStep
Make the columnNOT NULL
.
-
Method Details
-
defaultValue
@NotNull @CheckReturnValue @Support({ACCESS,ASE,AURORA_MYSQL,AURORA_POSTGRES,BIGQUERY,COCKROACHDB,CUBRID,DB2,DERBY,DUCKDB,EXASOL,FIREBIRD,H2,HSQLDB,INGRES,MARIADB,MEMSQL,MYSQL,ORACLE,POSTGRES,SNOWFLAKE,SQLSERVER,SYBASE,VERTICA,YUGABYTEDB}) @NotNull AlterTableFinalStep defaultValue(T literal) Specify a new columnDEFAULT
.This is an alias for
default_(Object)
. -
defaultValue
@NotNull @CheckReturnValue @Support({ACCESS,ASE,AURORA_MYSQL,AURORA_POSTGRES,BIGQUERY,COCKROACHDB,CUBRID,DB2,DERBY,DUCKDB,EXASOL,FIREBIRD,H2,HSQLDB,INGRES,MARIADB,MEMSQL,MYSQL,ORACLE,POSTGRES,SNOWFLAKE,SQLSERVER,SYBASE,VERTICA,YUGABYTEDB}) @NotNull AlterTableFinalStep defaultValue(Field<T> expression) Specify a new columnDEFAULT
.This is an alias for
default_(Field)
. -
default_
@NotNull @CheckReturnValue @Support({ACCESS,ASE,AURORA_MYSQL,AURORA_POSTGRES,BIGQUERY,COCKROACHDB,CUBRID,DB2,DERBY,DUCKDB,EXASOL,FIREBIRD,H2,HSQLDB,INGRES,MARIADB,MEMSQL,MYSQL,ORACLE,POSTGRES,SNOWFLAKE,SQLSERVER,SYBASE,VERTICA,YUGABYTEDB}) @NotNull AlterTableFinalStep default_(T literal) Specify a new columnDEFAULT
. -
default_
@NotNull @CheckReturnValue @Support({ACCESS,ASE,AURORA_MYSQL,AURORA_POSTGRES,BIGQUERY,COCKROACHDB,CUBRID,DB2,DERBY,DUCKDB,EXASOL,FIREBIRD,H2,HSQLDB,INGRES,MARIADB,MEMSQL,MYSQL,ORACLE,POSTGRES,SNOWFLAKE,SQLSERVER,SYBASE,VERTICA,YUGABYTEDB}) @NotNull AlterTableFinalStep default_(Field<T> expression) Specify a new columnDEFAULT
. -
setDefault
@NotNull @CheckReturnValue @Support({ACCESS,ASE,AURORA_MYSQL,AURORA_POSTGRES,BIGQUERY,COCKROACHDB,CUBRID,DB2,DERBY,DUCKDB,EXASOL,FIREBIRD,H2,HSQLDB,INGRES,MARIADB,MEMSQL,MYSQL,ORACLE,POSTGRES,SNOWFLAKE,SQLSERVER,SYBASE,VERTICA,YUGABYTEDB}) @NotNull AlterTableFinalStep setDefault(T literal) Specify a new columnDEFAULT
. -
setDefault
@NotNull @CheckReturnValue @Support({ACCESS,ASE,AURORA_MYSQL,AURORA_POSTGRES,BIGQUERY,COCKROACHDB,CUBRID,DB2,DERBY,DUCKDB,EXASOL,FIREBIRD,H2,HSQLDB,INGRES,MARIADB,MEMSQL,MYSQL,ORACLE,POSTGRES,SNOWFLAKE,SQLSERVER,SYBASE,VERTICA,YUGABYTEDB}) @NotNull AlterTableFinalStep setDefault(Field<T> expression) Specify a new columnDEFAULT
. -
dropDefault
@NotNull @CheckReturnValue @Support({ACCESS,ASE,AURORA_MYSQL,AURORA_POSTGRES,BIGQUERY,COCKROACHDB,CUBRID,DB2,DERBY,DUCKDB,EXASOL,FIREBIRD,H2,HSQLDB,INGRES,MARIADB,MEMSQL,MYSQL,ORACLE,POSTGRES,SNOWFLAKE,SQLSERVER,SYBASE,VERTICA,YUGABYTEDB}) @NotNull AlterTableFinalStep dropDefault()Drop the columnDEFAULT
. -
set
@NotNull @CheckReturnValue @Support({ACCESS,ASE,AURORA_MYSQL,AURORA_POSTGRES,COCKROACHDB,CUBRID,DB2,DERBY,DUCKDB,EXASOL,FIREBIRD,H2,HANA,HSQLDB,INFORMIX,INGRES,MARIADB,MEMSQL,MYSQL,ORACLE,POSTGRES,SNOWFLAKE,SQLDATAWAREHOUSE,SQLSERVER,SYBASE,TRINO,YUGABYTEDB}) @NotNull AlterTableFinalStep set(DataType<?> type) Specify a new column data type.This adds or removes
NOT NULL
constraints on the column ifDataType.nullable()
is specified explicitly (not all databases support this). -
setNotNull
@NotNull @CheckReturnValue @Support({ASE,AURORA_POSTGRES,COCKROACHDB,DB2,DERBY,DUCKDB,EXASOL,FIREBIRD_3_0,H2,HSQLDB,ORACLE,POSTGRES,SNOWFLAKE,VERTICA,YUGABYTEDB}) @NotNull AlterTableFinalStep setNotNull()Make the columnNOT NULL
. -
dropNotNull
@NotNull @CheckReturnValue @Support({ASE,AURORA_POSTGRES,COCKROACHDB,DB2,DERBY,DUCKDB,EXASOL,FIREBIRD_3_0,H2,HSQLDB,ORACLE,POSTGRES,SNOWFLAKE,VERTICA,YUGABYTEDB}) @NotNull AlterTableFinalStep dropNotNull()Make the column nullable.
-