Module org.jooq

Package org.jooq

Interface DataType<T>

Type Parameters:

T - The Java type associated with this SQL data type

All Superinterfaces:

Named, QueryPart, Serializable

All Known Implementing Classes:

BuiltInDataType, DefaultDataType

public interface DataType<T>
extends Named

A common interface to all dialect-specific data types.

jOOQ provides built in data types through SQLDataType. Users can define their own data types programmatically by calling asConvertedDataType(Converter) or asConvertedDataType(Binding), for example. Custom data types can also be defined on generated code using the <forcedType/> configuration, see the manual for more details

Author:

Lukas Eder

Method Summary

Modifier and Type	Method	Description
@NotNull DataType<T[]>	array()	A convenient short for form getArrayDataType() for DSL usage
<A extends ArrayRecord<?>> @NotNull DataType<A>	asArrayDataType(Class<A> arrayDataType)	Retrieve the data type for an Oracle-style ARRAY of this data type.
<A extends AssociativeArrayRecord<?, ?>> @NotNull DataType<A>	asAssociativeArrayDataType(Class<A> arrayDataType)	Retrieve the data type for an Oracle-style associative array of this data type.
default <U> @NotNull DataType<U>	asConvertedDataType(Class<U> toType, Function<? super T,? extends U> from, Function<? super U,? extends T> to)	Convenience method for converting this type using Converter.of(Class, Class, Function, Function).
<U> @NotNull DataType<U>	asConvertedDataType(Binding<? super T,U> binding)	Retrieve the data type for a given binding.
<U> @NotNull DataType<U>	asConvertedDataType(Converter<? super T,U> converter)	Retrieve the data type for a given converter.
default <U> @NotNull DataType<U>	asConvertedDataTypeFrom(Class<U> toType, Function<? super T,? extends U> from)	Convenience method for converting this type to a read-only type using Converter.from(Class, Class, Function).
default <U> @NotNull DataType<U>	asConvertedDataTypeFrom(Function<? super T,? extends U> from)	Convenience method for converting this type to a read-only type using Converter.from(Class, Class, Function).
default <U> @NotNull DataType<U>	asConvertedDataTypeTo(Class<U> toType, Function<? super U,? extends T> to)	Convenience method for converting this type to a write-only type using Converter.to(Class, Class, Function).
default <U> @NotNull DataType<U>	asConvertedDataTypeTo(Function<? super U,? extends T> to)	Convenience method for converting this type to a write-only type using Converter.to(Class, Class, Function).
<E extends EnumType> @NotNull DataType<E>	asEnumDataType(Class<E> enumDataType)	Retrieve the data type for a given enum data type.
@Nullable CharacterSet	characterSet()	Get the character set of this data type, or null if there is no character set, or if the default character set applies.
@NotNull DataType<T>	characterSet(CharacterSet characterSet)	Return a new data type like this, with a new character set.
@Nullable Collation	collation()	Get the collation of this data type, or null if there is no collation, or if the default collation applies.
@NotNull DataType<T>	collation(Collation collation)	Return a new data type like this, with a new collation.
boolean	computed()	Whether this column is computed.
boolean	computedOnClient()	Whether this column is computed on the client.
boolean	computedOnClient(Configuration configuration)	Whether this column is computed on the client.
boolean	computedOnClientStored()	Whether this column is computed on the client.
boolean	computedOnClientStored(Configuration configuration)	Whether this column is computed on the client.
boolean	computedOnClientStoredOn(GeneratorStatementType statementType)	Whether this column is computed on the client.
boolean	computedOnClientStoredOn(GeneratorStatementType statementType, Configuration configuration)	Whether this column is computed on the client.
boolean	computedOnClientVirtual()	Whether this column is computed on the client.
boolean	computedOnClientVirtual(Configuration configuration)	Whether this column is computed on the client.
boolean	computedOnServer()	Whether this column is computed on the server.
boolean	computedOnServer(Configuration configuration)	Whether this column is computed on the server.
T	convert(Object object)	Convert an arbitrary object into <T>.
T @NotNull []	convert(Object... objects)	Convert an arbitrary set of objects into <T>.
@NotNull List<T>	convert(Collection<?> objects)	Convert an arbitrary set of objects into <T>.
@Nullable Field<T>	default_()	The expression to be applied as the DEFAULT value for this data type.
@NotNull DataType<T>	default_(Field<T> defaultValue)	Specify an expression to be applied as the DEFAULT value for this data type.
@NotNull DataType<T>	default_(T defaultValue)	Specify an expression to be applied as the DEFAULT value for this data type.
boolean	defaulted()	Get the defaultability of this data type.
@Nullable Field<T>	defaultValue()	The expression to be applied as the DEFAULT value for this data type.
@NotNull DataType<T>	defaultValue(Field<T> defaultValue)	Specify an expression to be applied as the DEFAULT value for this data type.
@NotNull DataType<T>	defaultValue(T defaultValue)	Specify an expression to be applied as the DEFAULT value for this data type.
@Nullable Field<T>	generatedAlwaysAs()	Get the computed column expression of this data type, if any.
@NotNull DataType<T>	generatedAlwaysAs(Field<T> generatedAlwaysAsValue)	Set the computed column expression of this data type to a constant expression.
@NotNull DataType<T>	generatedAlwaysAs(Generator<?,?,T> generatedAlwaysAsValue)	Set the computed column expression of this data type to a dynamic expression.
@NotNull DataType<T>	generatedAlwaysAs(T generatedAlwaysAsValue)	Set the computed column expression of this data type to a constant value.
@Nullable Generator<?,?,T>	generatedAlwaysAsGenerator()	Get the computed column expression of this data type, if any.
@NotNull QOM.GenerationLocation	generationLocation()	Get the QOM.GenerationLocation of the computed column expression of this data type, if any.
@NotNull DataType<T>	generationLocation(QOM.GenerationLocation generationOption)	Set the generationLocation() of the computed column expression.
@NotNull QOM.GenerationOption	generationOption()	Get the QOM.GenerationOption of the computed column expression of this data type, if any.
@NotNull DataType<T>	generationOption(QOM.GenerationOption generationOption)	Set the generationOption() of the computed column expression.
@NotNull DataType<?>	getArrayBaseDataType()	Retrieve the Java component data type if this is an ARRAY type, or this, otherwise.
@NotNull Class<?>	getArrayBaseType()	Retrieve the Java base type if this is an ARRAY type, or getType(), otherwise.
@Nullable DataType<?>	getArrayComponentDataType()	Retrieve the Java component data type if this is an ARRAY type, or null, otherwise.
@Nullable Class<?>	getArrayComponentType()	Retrieve the Java component type if this is an ARRAY type, or null, otherwise.
@NotNull DataType<T[]>	getArrayDataType()	Retrieve the data type for an ARRAY of this data type.
@NotNull Class<T[]>	getArrayType()	Retrieve the Java type associated with ARRAYs of this data type.
@NotNull Binding<?,T>	getBinding()	Get the data type binding associated with this data type.
@NotNull String	getCastTypeName()	Retrieve the dialect-specific type name associated with this data type used for casting.
@NotNull String	getCastTypeName(Configuration configuration)	Retrieve the dialect-specific type name associated with this data type used for casting.
@NotNull ContextConverter<?,T>	getConverter()	Get the converter associated with this data type.
@NotNull DataType<T>	getDataType(Configuration configuration)	The dialect-specific data type representing this data type.
@Nullable SQLDialect	getDialect()	Retrieve the underlying SQLDialect.
@Nullable Domain<T>	getDomain()	Get the defining DOMAIN type or NULL if there is no such type.
@NotNull Class<?>	getFromType()	The Converter.fromType() (or database type) in case this DataType has a converter.
@Nullable Class<? extends Record>	getRecordType()	Get the nested record's record type definition, if this is a isRecord(), or a isMultiset(), or NULL otherwise.
@Nullable Row	getRow()	Get the nested record's Row definition, if this is a isRecord(), or a isMultiset(), or NULL otherwise.
@Nullable DataType<T>	getSQLDataType()	Get the standard SQL data type of this (dialect-specific) data type if available.
int	getSQLType()	Get JDBC Types value.
int	getSQLType(Configuration configuration)	Get the dialect-specific JDBC Types value.
@NotNull Class<T>	getToType()	The Converter.toType() (or user type) in case this DataType has a converter.
@NotNull Class<T>	getType()	Retrieve the Java type associated with this data type.
@NotNull String	getTypeName()	Retrieve the dialect-specific type name associated with this data type.
@NotNull String	getTypeName(Configuration configuration)	Retrieve the dialect-specific type name associated with this data type.
boolean	hasLength()	Whether this data type has a length.
boolean	hasPrecision()	Whether this data type has a precision.
boolean	hasScale()	Whether this data type has a scale.
boolean	identity()	Get the identity flag of this data type.
@NotNull DataType<T>	identity(boolean identity)	Return a new data type like this, with a new identity flag.
boolean	isArray()	Whether this data type is an array type.
boolean	isAssociativeArray()	Whether this data type is an array type.
boolean	isBinary()	Whether this data type is any binary type.
boolean	isBoolean()	Whether this data type is any boolean data type.
boolean	isDate()	Whether this data type is any date type.
boolean	isDateTime()	Whether this data type is any date or time type.
boolean	isDecimal()	Whether this data type is any decimal numeric data type.
boolean	isEmbeddable()	Whether this data type is an embeddable type.
boolean	isEnum()	Whether this data type is an enum type.
boolean	isFloat()	Whether this data type is any floating point data type.
boolean	isInteger()	Whether this data type is any integer data type.
boolean	isInterval()	Whether this data type is any interval type.
boolean	isJSON()	Whether this data type is a JSON type.
boolean	isLob()	Whether this data type is best deserialised as a LOB.
boolean	isMultiset()	Whether this data type is a nested collection type.
boolean	isNString()	Whether this data type is any national character data type.
boolean	isNumeric()	Whether this data type is any numeric data type.
boolean	isOther()	Whether this data type is an OTHER type.
boolean	isRecord()	Whether this data type is a nested record type.
boolean	isRowId()	Whether this data type is a RowId type.
boolean	isSpatial()	Whether this data type is a spatial type.
boolean	isString()	Whether this data type is any character data type.
boolean	isTemporal()	Whether this data type is any date or time type.
boolean	isTime()	Whether this data type is any time type.
boolean	isTimestamp()	Whether this data type is any timestamp type.
boolean	isTimestampWithTimeZone()	Whether this data type is any timestamp type.
boolean	isTimeWithTimeZone()	Whether this data type is any time type.
boolean	isUDT()	Whether this data type is a UDT type.
boolean	isUUID()	Whether this data type is a UUID type.
boolean	isXML()	Whether this data type is an XML type.
int	length()	Get the length of this data type.
@NotNull DataType<T>	length(int length)	Return a new data type like this, with a new length value.
boolean	lengthDefined()	Whether the precision returned by length() is defined.
@NotNull DataType<T>	notNull()	Synonym for nullable(boolean), passing false as an argument.
@NotNull DataType<T>	null_()	Synonym for nullable(boolean), passing true as an argument.
@NotNull Nullability	nullability()	Get the nullability of this data type.
@NotNull DataType<T>	nullability(Nullability nullability)	Return a new data type like this, with a new nullability.
boolean	nullable()	Get the nullability of this data type.
@NotNull DataType<T>	nullable(boolean nullable)	Return a new data type like this, with a new nullability.
int	precision()	Get the precision of this data type.
@NotNull DataType<T>	precision(int precision)	Return a new data type like this, with a new precision value.
@NotNull DataType<T>	precision(int precision, int scale)	Return a new data type like this, with a new precision and scale value.
boolean	precisionDefined()	Whether the precision returned by precision() is defined.
boolean	readonly()	Get the readonly attribute of this data type.
@NotNull DataType<T>	readonly(boolean readonly)	Return a new data type like this, with a new readonly attribute.
boolean	readonlyInternal()	Get the readonly attribute of this data type, combined with other flags that influence readonly behaviour.
boolean	readonlyInternal(Configuration configuration)	Get the readonly attribute of this data type, combined with other flags that influence readonly behaviour.
int	scale()	Get the scale of this data type.
@NotNull DataType<T>	scale(int scale)	Return a new data type like this, with a new scale value.
boolean	scaleDefined()	Whether the precision returned by scale() is defined.
@NotNull DataType<T>	stored()	Set the generationOption() of the computed column expression to QOM.GenerationOption.STORED.
@NotNull DataType<T>	virtual()	Set the generationOption() of the computed column expression to QOM.GenerationOption.VIRTUAL.

Methods inherited from interface org.jooq.Named

$name, getComment, getCommentPart, getName, getQualifiedName, getUnqualifiedName

Methods inherited from interface org.jooq.QueryPart

$replace, $replace, $traverse, $traverse, equals, hashCode, toString

Method Details

getSQLDataType

@Nullable
@Nullable DataType<T> getSQLDataType()

Get the standard SQL data type of this (dialect-specific) data type if available.

getDataType

@NotNull
@NotNull DataType<T> getDataType(Configuration configuration)

The dialect-specific data type representing this data type.

getSQLType

int getSQLType()

Get JDBC Types value.

getSQLType

int getSQLType(Configuration configuration)

Get the dialect-specific JDBC Types value.

getBinding

@NotNull
@NotNull Binding<?,T> getBinding()

Get the data type binding associated with this data type.

getConverter

@NotNull
@NotNull ContextConverter<?,T> getConverter()

Get the converter associated with this data type.

getType

@NotNull
@NotNull Class<T> getType()

Retrieve the Java type associated with this data type.

This is the same as

invalid reference

#getUserType()

.

getFromType

@NotNull
@NotNull Class<?> getFromType()

The Converter.fromType() (or database type) in case this DataType has a converter.

getToType

@NotNull
@NotNull Class<T> getToType()

The Converter.toType() (or user type) in case this DataType has a converter.

getDomain

@Nullable
@Nullable Domain<T> getDomain()

Get the defining DOMAIN type or NULL if there is no such type.

getRow

@Nullable
@Nullable Row getRow()

Get the nested record's Row definition, if this is a isRecord(), or a isMultiset(), or NULL otherwise.

getRecordType

@Nullable
@Nullable Class<? extends Record> getRecordType()

Get the nested record's record type definition, if this is a isRecord(), or a isMultiset(), or NULL otherwise.

getArrayType

@NotNull
@NotNull Class<T[]> getArrayType()

Retrieve the Java type associated with ARRAYs of this data type.

getArrayDataType

@NotNull
@NotNull DataType<T[]> getArrayDataType()
                                 throws DataTypeException

Retrieve the data type for an ARRAY of this data type.

Built-in data types, as well as custom data types that have a custom getConverter() can be translated to array data types using Converter.forArrays(). Data types with custom getBinding() cannot be translated to an array data type. Use this idiom, instead:

 // Doesn't work
 DataTypeinvalid input: '<'UserType[]> t1 =
   SQLDataType.INTEGER.asConvertedDataType(binding).getArrayDataType();

 // Works
 DataTypeinvalid input: '<'UserType[]> t2 =
   SQLDataType.INTEGER.getArrayDataType().asConvertedDataType(arrayBinding);
 

Throws:

DataTypeException - When this data type has a custom getBinding(), which cannot be automatically translated to an array Binding.

array

@NotNull
@Support({AURORA_POSTGRES,COCKROACHDB,DUCKDB,H2,HSQLDB,POSTGRES,TRINO,YUGABYTEDB})
@NotNull DataType<T[]> array()
                      throws DataTypeException

A convenient short for form getArrayDataType() for DSL usage

Throws:

DataTypeException

getArrayComponentType

@Nullable
@Nullable Class<?> getArrayComponentType()

Retrieve the Java component type if this is an ARRAY type, or null, otherwise.

E.g. for DataTypeinvalid input: '<'String[][][]>, this will return String[][].

getArrayComponentDataType

@Nullable
@Nullable DataType<?> getArrayComponentDataType()

Retrieve the Java component data type if this is an ARRAY type, or null, otherwise.

E.g. for DataTypeinvalid input: '<'String[][][]>, this will return DataType<String[][]>.

getArrayBaseType

@NotNull
@NotNull Class<?> getArrayBaseType()

Retrieve the Java base type if this is an ARRAY type, or getType(), otherwise.

E.g. for DataTypeinvalid input: '<'String[][][]>, this will return String.

getArrayBaseDataType

@NotNull
@NotNull DataType<?> getArrayBaseDataType()

Retrieve the Java component data type if this is an ARRAY type, or this, otherwise.

E.g. for DataTypeinvalid input: '<'String[][][]>, this will return DataType<String>.

asArrayDataType

@NotNull
@Pro
<A extends ArrayRecord<?>> @NotNull DataType<A> asArrayDataType(Class<A> arrayDataType)

Retrieve the data type for an Oracle-style ARRAY of this data type.

asAssociativeArrayDataType

@NotNull
@Pro
<A extends AssociativeArrayRecord<?,
?>>
@NotNull DataType<A> asAssociativeArrayDataType(Class<A> arrayDataType)

Retrieve the data type for an Oracle-style associative array of this data type.

asEnumDataType

@NotNull
<E extends EnumType> @NotNull DataType<E> asEnumDataType(Class<E> enumDataType)

Retrieve the data type for a given enum data type.

asConvertedDataType

@NotNull
<U> @NotNull DataType<U> asConvertedDataType(Converter<? super T,U> converter)

Retrieve the data type for a given converter.

asConvertedDataType

@NotNull
default <U> @NotNull DataType<U> asConvertedDataType(Class<U> toType,
 Function<? super T,? extends U> from,
 Function<? super U,? extends T> to)

Convenience method for converting this type using Converter.of(Class, Class, Function, Function).

asConvertedDataTypeFrom

@NotNull
default <U> @NotNull DataType<U> asConvertedDataTypeFrom(Class<U> toType,
 Function<? super T,? extends U> from)

Convenience method for converting this type to a read-only type using Converter.from(Class, Class, Function).

asConvertedDataTypeFrom

@NotNull
default <U> @NotNull DataType<U> asConvertedDataTypeFrom(Function<? super T,? extends U> from)

Convenience method for converting this type to a read-only type using Converter.from(Class, Class, Function).

Unlike asConvertedDataTypeFrom(Class, Function), this method attempts to work without an explicit Class reference for the underlying Converter.toType(). There may be some edge cases where this doesn't work (e.g. when arrays are involved), in case of which, an explicit class literal should be passed.

asConvertedDataTypeTo

@NotNull
default <U> @NotNull DataType<U> asConvertedDataTypeTo(Class<U> toType,
 Function<? super U,? extends T> to)

Convenience method for converting this type to a write-only type using Converter.to(Class, Class, Function).

asConvertedDataTypeTo

@NotNull
default <U> @NotNull DataType<U> asConvertedDataTypeTo(Function<? super U,? extends T> to)

Convenience method for converting this type to a write-only type using Converter.to(Class, Class, Function).

Unlike asConvertedDataTypeTo(Class, Function), this method attempts to work without an explicit Class reference for the underlying Converter.toType(). There may be some edge cases where this doesn't work (e.g. when arrays are involved), in case of which, an explicit class literal should be passed.

asConvertedDataType

@NotNull
<U> @NotNull DataType<U> asConvertedDataType(Binding<? super T,U> binding)

Retrieve the data type for a given binding.

getTypeName

@NotNull
@NotNull String getTypeName()

Retrieve the dialect-specific type name associated with this data type.

getTypeName

@NotNull
@NotNull String getTypeName(Configuration configuration)

Retrieve the dialect-specific type name associated with this data type.

getCastTypeName

@NotNull
@NotNull String getCastTypeName()

Retrieve the dialect-specific type name associated with this data type used for casting.

This is useful for some dialects that have specialised type names for cast expressions. Other dialects require type-length binding when casting, (e.g. VARCHAR(32767))

getCastTypeName

@NotNull
@NotNull String getCastTypeName(Configuration configuration)

Retrieve the dialect-specific type name associated with this data type used for casting.

This is useful for some dialects that have specialised type names for cast expressions. Other dialects require type-length binding when casting, (e.g. VARCHAR(32767))

getDialect

@Nullable
@Nullable SQLDialect getDialect()

Retrieve the underlying SQLDialect.

convert

T convert(Object object)

Convert an arbitrary object into <T>.

See

invalid reference

Convert#convert(Object, Class)

for details about conversion rules. Notice this does not pass through any Configuration.converterProvider().

Parameters:

object - The object to be converted

Returns:

The converted object

Throws:

DataTypeException - If conversion fails.

convert

T @NotNull [] convert(Object... objects)

Convert an arbitrary set of objects into <T>.

See

invalid reference

Convert#convert(Object, Class)

for details about conversion rules. Notice this does not pass through any Configuration.converterProvider().

Parameters:

objects - The objects to be converted

Returns:

The converted objects

Throws:

DataTypeException - If conversion fails.

convert

@NotNull
@NotNull List<T> convert(Collection<?> objects)

Convert an arbitrary set of objects into <T>.

See

invalid reference

Convert#convert(Object, Class)

for details about conversion rules. Notice this does not pass through any Configuration.converterProvider().

Parameters:

objects - The objects to be converted

Returns:

The converted objects

Throws:

DataTypeException - If conversion fails.

nullability

@NotNull
@Support
@NotNull DataType<T> nullability(Nullability nullability)

Return a new data type like this, with a new nullability.

[#5709] A nullable column cannot have an identity().

Parameters:

nullability - The new nullability

Returns:

The new data type

nullability

@NotNull
@NotNull Nullability nullability()

Get the nullability of this data type.

Returns:

The nullability

nullable

@NotNull
@Support
@NotNull DataType<T> nullable(boolean nullable)

Return a new data type like this, with a new nullability.

This is the same as calling nullability(Nullability) with any of Nullability.NULL or Nullability.NOT_NULL as an argument.

[#5709] A nullable column cannot have an identity().

Parameters:

nullable - The new nullability

Returns:

The new data type

nullable

boolean nullable()

Get the nullability of this data type.

This returns true by default, i.e. if nullability() is Nullability.DEFAULT.

Returns:

The nullability

readonly

@NotNull
@Support
@NotNull DataType<T> readonly(boolean readonly)

Return a new data type like this, with a new readonly attribute.

This feature is implemented in commercial distributions only.

Parameters:

readonly - The new readonly attribute value.

Returns:

The new data type

readonly

boolean readonly()

Get the readonly attribute of this data type.

This feature is implemented in commercial distributions only.

readonlyInternal

boolean readonlyInternal()

Get the readonly attribute of this data type, combined with other flags that influence readonly behaviour.

A column may be marked as readonly() for various reasons, including:

• When it is marked as readonly explicitly by the code generator.
• When it is marked as readonly implicitly because it's a computed column with QOM.GenerationLocation.SERVER or with QOM.GenerationLocation.CLIENT and QOM.GenerationOption.VIRTUAL.

Some columns are readonly for users, meaning users of the jOOQ API cannot write to them, but jOOQ, internally, may still write to those columns. Such columns may include:

• Columns that are computed with QOM.GenerationLocation.CLIENT and QOM.GenerationOption.STORED
• Columns used for optimistic locking

This method returns the static information for this data type. The information may be overridden by a Settings value, e.g. Settings.isEmulateComputedColumns(), in case of which readonlyInternal(Configuration) should be called.

This feature is implemented in commercial distributions only.

readonlyInternal

boolean readonlyInternal(Configuration configuration)

Get the readonly attribute of this data type, combined with other flags that influence readonly behaviour.

A column may be marked as readonly() for various reasons, including:

• When it is marked as readonly explicitly by the code generator.
• When it is marked as readonly implicitly because it's a computed column with QOM.GenerationLocation.SERVER or with QOM.GenerationLocation.CLIENT and QOM.GenerationOption.VIRTUAL.

Some columns are readonly for users, meaning users of the jOOQ API cannot write to them, but jOOQ, internally, may still write to those columns. Such columns may include:

• Columns that are computed with QOM.GenerationLocation.CLIENT and QOM.GenerationOption.STORED
• Columns used for optimistic locking

This feature is implemented in commercial distributions only.

computed

boolean computed()

Whether this column is computed.

This feature is implemented in commercial distributions only.

computedOnServer

boolean computedOnServer()

Whether this column is computed on the server.

This is true only if all of these hold true:

• computed()
• generationLocation() == QOM.GenerationLocation.SERVER

This method returns the static information for this data type. The information may be overridden by a Settings value, e.g. Settings.isEmulateComputedColumns(), in case of which computedOnServer(Configuration) should be called.

This feature is implemented in commercial distributions only.

computedOnServer

boolean computedOnServer(Configuration configuration)

Whether this column is computed on the server.

This is true only if all of these hold true:

• computed()
• generationLocation() == QOM.GenerationLocation.SERVER
• == false

This feature is implemented in commercial distributions only.

computedOnClient

boolean computedOnClient()

Whether this column is computed on the client.

This is true only if all of these hold true:

• computed()
• generationLocation() == QOM.GenerationLocation.CLIENT

This method returns the static information for this data type. The information may be overridden by a Settings value, e.g. Settings.isEmulateComputedColumns(), in case of which computedOnClient(Configuration) should be called.

This feature is implemented in commercial distributions only.

computedOnClient

boolean computedOnClient(Configuration configuration)

Whether this column is computed on the client.

This is true only if all of these hold true:

• computed()
• generationLocation() == QOM.GenerationLocation.CLIENT

Alternatively, this makes the result true as well:

• computed()
• generationLocation() == QOM.GenerationLocation.SERVER
• == true

This feature is implemented in commercial distributions only.

computedOnClientStored

boolean computedOnClientStored()

Whether this column is computed on the client.

This is true only if all of these hold true:

• computed()
• generationLocation() == QOM.GenerationLocation.CLIENT
• generationOption() == QOM.GenerationOption.STORED
• generatedAlwaysAsGenerator() produces a generator that Generator.supports(GeneratorStatementType) any of GeneratorStatementType.INSERT or GeneratorStatementType.UPDATE

This method returns the static information for this data type. The information may be overridden by a Settings value, e.g. Settings.isEmulateComputedColumns(), in case of which computedOnClientStored(Configuration) should be called.

This feature is implemented in commercial distributions only.

computedOnClientStored

boolean computedOnClientStored(Configuration configuration)

Whether this column is computed on the client.

This is true only if all of these hold true:

• computed()
• generationLocation() == QOM.GenerationLocation.CLIENT
• generationOption() == QOM.GenerationOption.STORED
• generatedAlwaysAsGenerator() produces a generator that Generator.supports(GeneratorStatementType) any of GeneratorStatementType.INSERT or GeneratorStatementType.UPDATE

This feature is implemented in commercial distributions only.

computedOnClientStoredOn

boolean computedOnClientStoredOn(GeneratorStatementType statementType)

Whether this column is computed on the client.

This is true only if all of these hold true:

• computed()
• generationLocation() == QOM.GenerationLocation.CLIENT
• generationOption() == QOM.GenerationOption.STORED
• generatedAlwaysAsGenerator() produces a generator that Generator.supports(GeneratorStatementType) the argument statementType

This method returns the static information for this data type. The information may be overridden by a Settings value, e.g. Settings.isEmulateComputedColumns(), in case of which computedOnClientStoredOn(GeneratorStatementType, Configuration) should be called.

This feature is implemented in commercial distributions only.

computedOnClientStoredOn

boolean computedOnClientStoredOn(GeneratorStatementType statementType,
 Configuration configuration)

Whether this column is computed on the client.

This is true only if all of these hold true:

• computed()
• generationLocation() == QOM.GenerationLocation.CLIENT
• generationOption() == QOM.GenerationOption.STORED
• generatedAlwaysAsGenerator() produces a generator that Generator.supports(GeneratorStatementType) the argument statementType

This feature is implemented in commercial distributions only.

computedOnClientVirtual

boolean computedOnClientVirtual()

Whether this column is computed on the client.

This is true only if all of these hold true:

• computed()
• generationLocation() == QOM.GenerationLocation.CLIENT
• generationOption() == QOM.GenerationOption.VIRTUAL
• generatedAlwaysAsGenerator() produces a generator that Generator.supports(GeneratorStatementType) the type GeneratorStatementType.SELECT

This method returns the static information for this data type. The information may be overridden by a Settings value, e.g. Settings.isEmulateComputedColumns(), in case of which computedOnClientVirtual(Configuration) should be called.

This feature is implemented in commercial distributions only.

computedOnClientVirtual

boolean computedOnClientVirtual(Configuration configuration)

Whether this column is computed on the client.

This is true only if all of these hold true:

• computed()
• generationLocation() == QOM.GenerationLocation.CLIENT
• generationOption() == QOM.GenerationOption.VIRTUAL
• generatedAlwaysAsGenerator() produces a generator that Generator.supports(GeneratorStatementType) the type GeneratorStatementType.SELECT

This feature is implemented in commercial distributions only.

generatedAlwaysAs

@NotNull
@Support({AURORA_POSTGRES,COCKROACHDB,DB2,DERBY,DUCKDB,FIREBIRD,H2,HANA,HSQLDB,MARIADB,MYSQL_5_7,ORACLE12C,POSTGRES_12,SQLSERVER})
@NotNull DataType<T> generatedAlwaysAs(T generatedAlwaysAsValue)

Set the computed column expression of this data type to a constant value.

This implicitly sets readonly() to true.

This feature is implemented in commercial distributions only.

generatedAlwaysAs

@NotNull
@Support({AURORA_POSTGRES,COCKROACHDB,DB2,DERBY,DUCKDB,FIREBIRD,H2,HANA,HSQLDB,MARIADB,MYSQL_5_7,ORACLE12C,POSTGRES_12,SQLSERVER})
@NotNull DataType<T> generatedAlwaysAs(Field<T> generatedAlwaysAsValue)

Set the computed column expression of this data type to a constant expression.

This implicitly sets readonly() to true.

This feature is implemented in commercial distributions only.

generatedAlwaysAs

@NotNull
@NotNull DataType<T> generatedAlwaysAs(Generator<?,?,T> generatedAlwaysAsValue)

Set the computed column expression of this data type to a dynamic expression.

Unlike generatedAlwaysAs(Object) and generatedAlwaysAs(Field), which produce a constant value or expression, this allows for generating a dynamic expression if used along with generationLocation() and QOM.GenerationLocation.CLIENT, in order to implement client side computed columns.

If generationLocation() is QOM.GenerationLocation.SERVER, then this does not affect generated DML statements, and will be evaluated only in DDL statements, when creating the table.

This implicitly sets readonly() to true.

This feature is implemented in commercial distributions only.

generatedAlwaysAs

@Nullable
@Nullable Field<T> generatedAlwaysAs()

Get the computed column expression of this data type, if any.

This eagerly evaluates the generatedAlwaysAsGenerator() generator, which may not produce the same expression upon execution of a query, in case generationLocation() is QOM.GenerationLocation.CLIENT. The behaviour of QOM.GenerationLocation.SERVER is not affected. The method has been left unmodified for backwards compatibility with jOOQ 3.16.

This feature is implemented in commercial distributions only.

generatedAlwaysAsGenerator

@Nullable
@Nullable Generator<?,?,T> generatedAlwaysAsGenerator()

Get the computed column expression of this data type, if any.

This feature is implemented in commercial distributions only.

stored

@NotNull
@Support({AURORA_POSTGRES,COCKROACHDB,DB2,DERBY,DUCKDB,FIREBIRD,H2,HANA,HSQLDB,MARIADB,MYSQL_5_7,ORACLE12C,POSTGRES_12,SQLSERVER})
@NotNull DataType<T> stored()

Set the generationOption() of the computed column expression to QOM.GenerationOption.STORED.

If not supported by the dialect, this will be ignored.

This feature is implemented in commercial distributions only.

virtual

@NotNull
@Support({AURORA_POSTGRES,COCKROACHDB,DB2,DERBY,DUCKDB,FIREBIRD,H2,HANA,HSQLDB,MARIADB,MYSQL_5_7,ORACLE12C,POSTGRES_12,SQLSERVER})
@NotNull DataType<T> virtual()

Set the generationOption() of the computed column expression to QOM.GenerationOption.VIRTUAL.

If not supported by the dialect, this will be ignored.

This feature is implemented in commercial distributions only.

generationOption

@NotNull
@Support({AURORA_POSTGRES,COCKROACHDB,DB2,DERBY,DUCKDB,FIREBIRD,H2,HANA,HSQLDB,MARIADB,MYSQL_5_7,ORACLE12C,POSTGRES_12,SQLSERVER})
@NotNull DataType<T> generationOption(QOM.GenerationOption generationOption)

Set the generationOption() of the computed column expression.

If not supported by the dialect, this will be ignored.

This feature is implemented in commercial distributions only.

generationOption

@NotNull
@Support
@NotNull QOM.GenerationOption generationOption()

Get the QOM.GenerationOption of the computed column expression of this data type, if any.

This feature is implemented in commercial distributions only.

generationLocation

@NotNull
@Support
@NotNull DataType<T> generationLocation(QOM.GenerationLocation generationOption)

Set the generationLocation() of the computed column expression.

Specifies whether the generatedAlwaysAs() expression is computed on the QOM.GenerationLocation.SERVER (by default) or in the QOM.GenerationLocation.CLIENT. The latter is supported in all dialects, the former only in relevant dialects.

The computation happens in Insert, Update, or Merge statements in case generationOption() is QOM.GenerationOption.STORED, or in Select in case the generationOption() is QOM.GenerationOption.VIRTUAL.

This feature is implemented in commercial distributions only.

generationLocation

@NotNull
@Support
@NotNull QOM.GenerationLocation generationLocation()

Get the QOM.GenerationLocation of the computed column expression of this data type, if any.

Specifies whether the generatedAlwaysAs() expression is computed on the QOM.GenerationLocation.SERVER (by default) or in the QOM.GenerationLocation.CLIENT. The latter is supported in all dialects, the former only in relevant dialects.

The computation happens in Insert, Update, or Merge statements in case generationOption() is QOM.GenerationOption.STORED, or in Select in case the generationOption() is QOM.GenerationOption.VIRTUAL.

This feature is implemented in commercial distributions only.

null_

@NotNull
@Support
@NotNull DataType<T> null_()

Synonym for nullable(boolean), passing true as an argument.

notNull

@NotNull
@Support
@NotNull DataType<T> notNull()

Synonym for nullable(boolean), passing false as an argument.

collation

@NotNull
@Support({AURORA_MYSQL,AURORA_POSTGRES,COCKROACHDB,HSQLDB,MARIADB,MEMSQL,MYSQL,ORACLE,POSTGRES,SQLDATAWAREHOUSE,SQLITE,SQLSERVER,YUGABYTEDB})
@NotNull DataType<T> collation(Collation collation)

Return a new data type like this, with a new collation.

collation

@Nullable
@Nullable Collation collation()

Get the collation of this data type, or null if there is no collation, or if the default collation applies.

characterSet

@NotNull
@Support({AURORA_MYSQL,MARIADB,MEMSQL,MYSQL})
@NotNull DataType<T> characterSet(CharacterSet characterSet)

Return a new data type like this, with a new character set.

characterSet

@Nullable
@Nullable CharacterSet characterSet()

Get the character set of this data type, or null if there is no character set, or if the default character set applies.

identity

@NotNull
@Support({ACCESS,ASE,AURORA_MYSQL,AURORA_POSTGRES,COCKROACHDB,DB2,DERBY,EXASOL,FIREBIRD_3_0,H2,HANA,HSQLDB,INFORMIX,INGRES,MARIADB,MEMSQL,MYSQL,ORACLE,POSTGRES,REDSHIFT,SNOWFLAKE,SQLDATAWAREHOUSE,SQLITE,SQLSERVER,SYBASE,TERADATA,VERTICA,YUGABYTEDB})
@NotNull DataType<T> identity(boolean identity)

Return a new data type like this, with a new identity flag.

[#5709] The IDENTITY flag imposes a NOT NULL constraint, and removes all DEFAULT values.

Parameters:

identity - The new identity flag

Returns:

The new data type

identity

boolean identity()

Get the identity flag of this data type.

Returns:

The identity flag.

defaultValue

@NotNull
@Support({ACCESS,ASE,AURORA_MYSQL,AURORA_POSTGRES,BIGQUERY,COCKROACHDB,CUBRID,DB2,DERBY,DUCKDB,EXASOL,FIREBIRD,H2,HANA,HSQLDB,IGNITE,INFORMIX,INGRES,MARIADB,MEMSQL,MYSQL,ORACLE,POSTGRES,REDSHIFT,SNOWFLAKE,SQLDATAWAREHOUSE,SQLITE,SQLSERVER,SYBASE,TERADATA,VERTICA,YUGABYTEDB})
@NotNull DataType<T> defaultValue(T defaultValue)

Specify an expression to be applied as the DEFAULT value for this data type.

[#5709] A defaulted column cannot have an identity().

This is an alias for default_(Object).

See Also:

• defaultValue(Field)

defaultValue

@NotNull
@Support({ACCESS,ASE,AURORA_MYSQL,AURORA_POSTGRES,BIGQUERY,COCKROACHDB,CUBRID,DB2,DERBY,DUCKDB,EXASOL,FIREBIRD,H2,HANA,HSQLDB,IGNITE,INFORMIX,INGRES,MARIADB,MEMSQL,MYSQL,ORACLE,POSTGRES,REDSHIFT,SNOWFLAKE,SQLDATAWAREHOUSE,SQLITE,SQLSERVER,SYBASE,TERADATA,VERTICA,YUGABYTEDB})
@NotNull DataType<T> defaultValue(Field<T> defaultValue)

Specify an expression to be applied as the DEFAULT value for this data type.

A default value of a data type applies to DDL statements, such as

• CREATE TABLE
• ALTER TABLE

The distinct types of possible DEFAULT expressions is defined by the underlying database. Please refer to your database manual to learn what expressions are possible.

This is an alias for default_(Field).

defaultValue

@Nullable
@Nullable Field<T> defaultValue()

The expression to be applied as the DEFAULT value for this data type.

This is an alias for default_().

Returns:

The default value if present, or null if no default value is specified for this data type.

See Also:

• defaultValue(Field)

default_

@NotNull
@Support({ACCESS,ASE,AURORA_MYSQL,AURORA_POSTGRES,BIGQUERY,COCKROACHDB,CUBRID,DB2,DERBY,DUCKDB,EXASOL,FIREBIRD,H2,HANA,HSQLDB,IGNITE,INFORMIX,INGRES,MARIADB,MEMSQL,MYSQL,ORACLE,POSTGRES,REDSHIFT,SNOWFLAKE,SQLDATAWAREHOUSE,SQLITE,SQLSERVER,SYBASE,TERADATA,VERTICA,YUGABYTEDB})
@NotNull DataType<T> default_(T defaultValue)

Specify an expression to be applied as the DEFAULT value for this data type.

[#5709] A defaulted column cannot have an identity().

See Also:

• defaultValue(Field)

default_

@NotNull
@Support({ACCESS,ASE,AURORA_MYSQL,AURORA_POSTGRES,BIGQUERY,COCKROACHDB,CUBRID,DB2,DERBY,DUCKDB,EXASOL,FIREBIRD,H2,HANA,HSQLDB,IGNITE,INFORMIX,INGRES,MARIADB,MEMSQL,MYSQL,ORACLE,POSTGRES,REDSHIFT,SNOWFLAKE,SQLDATAWAREHOUSE,SQLITE,SQLSERVER,SYBASE,TERADATA,VERTICA,YUGABYTEDB})
@NotNull DataType<T> default_(Field<T> defaultValue)

Specify an expression to be applied as the DEFAULT value for this data type.

A default value of a data type applies to DDL statements, such as

• CREATE TABLE
• ALTER TABLE

The distinct types of possible DEFAULT expressions is defined by the underlying database. Please refer to your database manual to learn what expressions are possible.

default_

@Nullable
@Nullable Field<T> default_()

The expression to be applied as the DEFAULT value for this data type.

Returns:

The default value if present, or null if no default value is specified for this data type.

See Also:

• defaultValue(Field)

defaulted

boolean defaulted()

Get the defaultability of this data type.

Returns:

The defaultability

precision

@NotNull
@Support
@NotNull DataType<T> precision(int precision)

Return a new data type like this, with a new precision value.

This will have no effect if hasPrecision() is false

This is the same as calling precision(int, int) with scale == 0

Parameters:

precision - The new precision value

Returns:

The new data type

precision

@NotNull
@Support
@NotNull DataType<T> precision(int precision,
 int scale)

Return a new data type like this, with a new precision and scale value.

This will have no effect if hasPrecision() is false , or if scale > 0 and hasScale() is false

Parameters:

precision - The new precision value

scale - The new scale value

Returns:

The new data type

precision

int precision()

Get the precision of this data type.

Returns:

The precision of this data type

hasPrecision

boolean hasPrecision()

Whether this data type has a precision.

Returns:

Whether this data type has a precision

precisionDefined

boolean precisionDefined()

Whether the precision returned by precision() is defined.

The default precision is 0 for all data types. If a data type does not have a precision (see hasPrecision()), or if it was initialised without precision (e.g. SQLDataType.TIMESTAMP), then the precision is not defined.

scale

@NotNull
@Support
@NotNull DataType<T> scale(int scale)

Return a new data type like this, with a new scale value.

This will have no effect if hasScale() is false

Parameters:

scale - The new scale value

Returns:

The new data type

scale

int scale()

Get the scale of this data type.

Returns:

The scale of this data type

hasScale

boolean hasScale()

Whether this data type has a scale.

Returns:

Whether this data type has a scale

scaleDefined

boolean scaleDefined()

Whether the precision returned by scale() is defined.

The default scale is 0 for all data types. If a data type does not have a scale (see hasScale()), or if it was initialised without scale (e.g. SQLDataType.TIMESTAMP), then the scale is not defined.

length

@NotNull
@Support
@NotNull DataType<T> length(int length)

Return a new data type like this, with a new length value.

This will have no effect if hasLength() is false

Parameters:

length - The new length value

Returns:

The new data type

length

int length()

Get the length of this data type.

Returns:

The length of this data type

hasLength

boolean hasLength()

Whether this data type has a length.

Returns:

Whether this data type has a length

lengthDefined

boolean lengthDefined()

Whether the precision returned by length() is defined.

The default length is 0 for all data types. If a data type does not have a length (see hasLength()), or if it was initialised without length (e.g. SQLDataType.TIMESTAMP), then the length is not defined.

isNumeric

boolean isNumeric()

Whether this data type is any numeric data type.

This applies to any of these types:

• SQLDataType.TINYINT
• SQLDataType.SMALLINT
• SQLDataType.INTEGER
• SQLDataType.BIGINT
• SQLDataType.FLOAT
• SQLDataType.DOUBLE
• SQLDataType.REAL
• SQLDataType.DECIMAL
• SQLDataType.DECIMAL_INTEGER
• SQLDataType.NUMERIC

See Also:

• isNumeric()

isInteger

boolean isInteger()

Whether this data type is any integer data type.

This applies to any of these types:

• SQLDataType.TINYINT
• SQLDataType.SMALLINT
• SQLDataType.INTEGER
• SQLDataType.BIGINT

isFloat

boolean isFloat()

Whether this data type is any floating point data type.

This applies to any of these types:

• SQLDataType.FLOAT
• SQLDataType.DOUBLE
• SQLDataType.REAL

isDecimal

boolean isDecimal()

Whether this data type is any decimal numeric data type.

This applies to any of these types:

• SQLDataType.DECIMAL
• SQLDataType.DECIMAL_INTEGER
• SQLDataType.NUMERIC

isBoolean

boolean isBoolean()

Whether this data type is any boolean data type.

This applies to any of these types:

• SQLDataType.BIT
• SQLDataType.BOOLEAN

isString

boolean isString()

Whether this data type is any character data type.

This applies to any of these types:

• SQLDataType.CHAR
• SQLDataType.CLOB
• SQLDataType.LONGNVARCHAR
• SQLDataType.LONGVARCHAR
• SQLDataType.NCHAR
• SQLDataType.NCLOB
• SQLDataType.NVARCHAR
• SQLDataType.VARCHAR

isNString

boolean isNString()

Whether this data type is any national character data type.

This applies to any of these types:

• SQLDataType.LONGNVARCHAR
• SQLDataType.NCHAR
• SQLDataType.NCLOB
• SQLDataType.NVARCHAR

isDateTime

boolean isDateTime()

Whether this data type is any date or time type.

This applies to any of these types.

• SQLDataType.DATE
• SQLDataType.TIME
• SQLDataType.TIMESTAMP
• SQLDataType.LOCALDATE
• SQLDataType.LOCALTIME
• SQLDataType.LOCALDATETIME
• SQLDataType.OFFSETTIME
• SQLDataType.OFFSETDATETIME
• SQLDataType.INSTANT
• SQLDataType.YEAR

See Also:

• isDate()

isDate

boolean isDate()

Whether this data type is any date type.

This applies to any of these types.

• SQLDataType.DATE
• SQLDataType.LOCALDATE

isTimestamp

boolean isTimestamp()

Whether this data type is any timestamp type.

This applies to any of these types.

• SQLDataType.TIMESTAMP
• SQLDataType.LOCALDATETIME

isTimestampWithTimeZone

boolean isTimestampWithTimeZone()

Whether this data type is any timestamp type.

This applies to any of these types.

• SQLDataType.TIMESTAMPWITHTIMEZONE
• SQLDataType.INSTANT

isTime

boolean isTime()

Whether this data type is any time type.

This applies to any of these types.

• SQLDataType.TIME
• SQLDataType.LOCALTIME

isTimeWithTimeZone

boolean isTimeWithTimeZone()

Whether this data type is any time type.

This applies to any of these types.

• SQLDataType.TIMEWITHTIMEZONE

isTemporal

boolean isTemporal()

Whether this data type is any date or time type.

This applies to any of these types.

• SQLDataType.DATE
• SQLDataType.TIME
• SQLDataType.TIMESTAMP
• SQLDataType.LOCALDATE
• SQLDataType.LOCALTIME
• SQLDataType.LOCALDATETIME
• SQLDataType.OFFSETTIME
• SQLDataType.OFFSETDATETIME
• SQLDataType.INSTANT
• SQLDataType.YEAR
• YearToSecond
• YearToMonth
• DayToSecond

This is a combination of isDateTime() or isInterval()

isInterval

boolean isInterval()

Whether this data type is any interval type.

This applies to any of these types.

• YearToSecond
• YearToMonth
• DayToSecond

isBinary

boolean isBinary()

Whether this data type is any binary type.

This applies to any of these types.

• SQLDataType.BINARY
• SQLDataType.BLOB
• SQLDataType.LONGVARBINARY
• SQLDataType.VARBINARY

isLob

boolean isLob()

Whether this data type is best deserialised as a LOB.

This applies to any of these types.

• SQLDataType.BLOB
• SQLDataType.CLOB
• SQLDataType.NCLOB

isArray

boolean isArray()

Whether this data type is an array type.

isAssociativeArray

boolean isAssociativeArray()

Whether this data type is an array type.

isEmbeddable

boolean isEmbeddable()

Whether this data type is an embeddable type.

isUDT

boolean isUDT()

Whether this data type is a UDT type.

isRecord

boolean isRecord()

Whether this data type is a nested record type.

This is true for anonymous, structural nested record types constructed with DSL.row(SelectField...) or for nominal nested record types, such as isUDT() or isEmbeddable().

isMultiset

boolean isMultiset()

Whether this data type is a nested collection type.

This is true for anonymous, structural nested collection types constructed with DSL.multiset(TableLike) or DSL.multisetAgg(Field...).

isEnum

boolean isEnum()

Whether this data type is an enum type.

isJSON

boolean isJSON()

Whether this data type is a JSON type.

isXML

boolean isXML()

Whether this data type is an XML type.

isSpatial

boolean isSpatial()

Whether this data type is a spatial type.

isUUID

boolean isUUID()

Whether this data type is a UUID type.

isRowId

boolean isRowId()

Whether this data type is a RowId type.

isOther

boolean isOther()

Whether this data type is an OTHER type.

The SQLDataType.OTHER type maps any unknown data types to a jOOQ DataType. This includes unknown vendor specific types as well as unknown user defined types which do not have any custom Converter or Binding attached. The type may still be usable with the jOOQ API, but jOOQ's behaviour may not be well defined. Please note that any future minor release may add support for a vendor specific type, meaning the type loses its "otherness."