Module org.jooq

Package org.jooq

Interface AlterTableAlterStep<T>

public interface AlterTableAlterStep<T>

The step in the 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 Type	Method	Description
@NotNull AlterTableFinalStep	default_(Field<T> expression)	Specify a new column DEFAULT.
@NotNull AlterTableFinalStep	default_(T literal)	Specify a new column DEFAULT.
@NotNull AlterTableFinalStep	defaultValue(Field<T> expression)	Specify a new column DEFAULT.
@NotNull AlterTableFinalStep	defaultValue(T literal)	Specify a new column DEFAULT.
@NotNull AlterTableFinalStep	dropDefault()	Drop the column DEFAULT.
@NotNull AlterTableFinalStep	dropNotNull()	Make the column nullable.
@NotNull AlterTableFinalStep	set(DataType<?> type)	Specify a new column data type.
@NotNull AlterTableFinalStep	setDefault(Field<T> expression)	Specify a new column DEFAULT.
@NotNull AlterTableFinalStep	setDefault(T literal)	Specify a new column DEFAULT.
@NotNull AlterTableFinalStep	setNotNull()	Make the column NOT NULL.

Method Detail

defaultValue

@NotNull
@Support({ACCESS,ASE,AURORA_MYSQL,AURORA_POSTGRES,COCKROACHDB,CUBRID,DB2,DERBY,FIREBIRD,H2,HSQLDB,INGRES,MARIADB,MEMSQL,MYSQL,ORACLE,POSTGRES,SQLSERVER,SYBASE,VERTICA})
@NotNull AlterTableFinalStep defaultValue(T literal)

Specify a new column DEFAULT.

This is an alias for default_(Object).

defaultValue

@NotNull
@Support({ACCESS,ASE,AURORA_MYSQL,AURORA_POSTGRES,COCKROACHDB,CUBRID,DB2,DERBY,FIREBIRD,H2,HSQLDB,INGRES,MARIADB,MEMSQL,MYSQL,ORACLE,POSTGRES,SQLSERVER,SYBASE,VERTICA})
@NotNull AlterTableFinalStep defaultValue(Field<T> expression)

Specify a new column DEFAULT.

This is an alias for default_(Field).

default_

@NotNull
@Support({ACCESS,ASE,AURORA_MYSQL,AURORA_POSTGRES,COCKROACHDB,CUBRID,DB2,DERBY,FIREBIRD,H2,HSQLDB,INGRES,MARIADB,MEMSQL,MYSQL,ORACLE,POSTGRES,SQLSERVER,SYBASE,VERTICA})
@NotNull AlterTableFinalStep default_(T literal)

Specify a new column DEFAULT.

default_

@NotNull
@Support({ACCESS,ASE,AURORA_MYSQL,AURORA_POSTGRES,COCKROACHDB,CUBRID,DB2,DERBY,FIREBIRD,H2,HSQLDB,INGRES,MARIADB,MEMSQL,MYSQL,ORACLE,POSTGRES,SQLSERVER,SYBASE,VERTICA})
@NotNull AlterTableFinalStep default_(Field<T> expression)

Specify a new column DEFAULT.

setDefault

@NotNull
@Support({ACCESS,ASE,AURORA_MYSQL,AURORA_POSTGRES,COCKROACHDB,CUBRID,DB2,DERBY,FIREBIRD,H2,HSQLDB,INGRES,MARIADB,MEMSQL,MYSQL,ORACLE,POSTGRES,SQLSERVER,SYBASE,VERTICA})
@NotNull AlterTableFinalStep setDefault(T literal)

Specify a new column DEFAULT.

setDefault

@NotNull
@Support({ACCESS,ASE,AURORA_MYSQL,AURORA_POSTGRES,COCKROACHDB,CUBRID,DB2,DERBY,FIREBIRD,H2,HSQLDB,INGRES,MARIADB,MEMSQL,MYSQL,ORACLE,POSTGRES,SQLSERVER,SYBASE,VERTICA})
@NotNull AlterTableFinalStep setDefault(Field<T> expression)

Specify a new column DEFAULT.

dropDefault

@NotNull
@Support({ACCESS,ASE,AURORA_MYSQL,AURORA_POSTGRES,COCKROACHDB,CUBRID,DB2,DERBY,FIREBIRD,H2,HSQLDB,INGRES,MARIADB,MEMSQL,MYSQL,ORACLE,POSTGRES,SQLSERVER,SYBASE,VERTICA})
@NotNull AlterTableFinalStep dropDefault()

Drop the column DEFAULT.

set

@NotNull
@Support({ACCESS,ASE,AURORA_MYSQL,AURORA_POSTGRES,COCKROACHDB,CUBRID,DB2,DERBY,FIREBIRD,H2,HANA,HSQLDB,INFORMIX,INGRES,MARIADB,MEMSQL,MYSQL,ORACLE,POSTGRES,SQLDATAWAREHOUSE,SQLSERVER,SYBASE})
@NotNull AlterTableFinalStep set(DataType<?> type)

Specify a new column data type.

This adds or removes NOT NULL constraints on the column if DataType.nullable() is specified explicitly (not all databases support this).

setNotNull

@NotNull
@Support({ASE,AURORA_POSTGRES,COCKROACHDB,DB2,DERBY,FIREBIRD_3_0,H2,HSQLDB,ORACLE,POSTGRES,VERTICA})
@NotNull AlterTableFinalStep setNotNull()

Make the column NOT NULL.

dropNotNull

@NotNull
@Support({ASE,AURORA_POSTGRES,COCKROACHDB,DB2,DERBY,FIREBIRD_3_0,H2,HSQLDB,ORACLE,POSTGRES,VERTICA})
@NotNull AlterTableFinalStep dropNotNull()

Make the column nullable.