Module org.jooq

Package org.jooq

Interface AlterTypeStep

public interface AlterTypeStep

A step in the construction of the ALTER TYPE statement.

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

Method Summary

Modifier and Type	Method	Description
@NotNull AlterTypeFinalStep	addValue(String addValue)	Add the ADD VALUE clause to the ALTER TYPE statement.
@NotNull AlterTypeFinalStep	addValue(Field<String> addValue)	Add the ADD VALUE clause to the ALTER TYPE statement.
@NotNull AlterTypeFinalStep	renameTo(String renameTo)	Add the RENAME TO clause to the ALTER TYPE statement.
@NotNull AlterTypeFinalStep	renameTo(Name renameTo)	Add the RENAME TO clause to the ALTER TYPE statement.
@NotNull AlterTypeRenameValueToStep	renameValue(String renameValue)	Add the RENAME VALUE clause to the ALTER TYPE statement.
@NotNull AlterTypeRenameValueToStep	renameValue(Field<String> renameValue)	Add the RENAME VALUE clause to the ALTER TYPE statement.
@NotNull AlterTypeFinalStep	setSchema(String setSchema)	Add the SET SCHEMA clause to the ALTER TYPE statement.
@NotNull AlterTypeFinalStep	setSchema(Name setSchema)	Add the SET SCHEMA clause to the ALTER TYPE statement.
@NotNull AlterTypeFinalStep	setSchema(Schema setSchema)	Add the SET SCHEMA clause to the ALTER TYPE statement.

Method Details

renameTo

@Support({COCKROACHDB,POSTGRES})
@NotNull
@CheckReturnValue
@NotNull AlterTypeFinalStep renameTo(@Name
 String renameTo)

Add the RENAME TO clause to the ALTER TYPE statement.

renameTo

@Support({COCKROACHDB,POSTGRES})
@NotNull
@CheckReturnValue
@NotNull AlterTypeFinalStep renameTo(Name renameTo)

Add the RENAME TO clause to the ALTER TYPE statement.

setSchema

@Support({COCKROACHDB,POSTGRES})
@NotNull
@CheckReturnValue
@NotNull AlterTypeFinalStep setSchema(@Name
 String setSchema)

Add the SET SCHEMA clause to the ALTER TYPE statement.

setSchema

@Support({COCKROACHDB,POSTGRES})
@NotNull
@CheckReturnValue
@NotNull AlterTypeFinalStep setSchema(Name setSchema)

Add the SET SCHEMA clause to the ALTER TYPE statement.

setSchema

@Support({COCKROACHDB,POSTGRES})
@NotNull
@CheckReturnValue
@NotNull AlterTypeFinalStep setSchema(Schema setSchema)

Add the SET SCHEMA clause to the ALTER TYPE statement.

addValue

@Support({COCKROACHDB,POSTGRES})
@NotNull
@CheckReturnValue
@NotNull AlterTypeFinalStep addValue(@Param
 String addValue)

Add the ADD VALUE clause to the ALTER TYPE statement.

Parameters:

addValue - is wrapped as DSL.val(Object).

addValue

@Support({COCKROACHDB,POSTGRES})
@NotNull
@CheckReturnValue
@NotNull AlterTypeFinalStep addValue(Field<String> addValue)

Add the ADD VALUE clause to the ALTER TYPE statement.

renameValue

@Support({COCKROACHDB,POSTGRES_10})
@NotNull
@CheckReturnValue
@NotNull AlterTypeRenameValueToStep renameValue(@Param
 String renameValue)

Add the RENAME VALUE clause to the ALTER TYPE statement.

Parameters:

renameValue - is wrapped as DSL.val(Object).

renameValue

@Support({COCKROACHDB,POSTGRES_10})
@NotNull
@CheckReturnValue
@NotNull AlterTypeRenameValueToStep renameValue(Field<String> renameValue)

Add the RENAME VALUE clause to the ALTER TYPE statement.