Module org.jooq

Package org.jooq

Interface DataType<T>

Type Parameters:

T - The Java type associated with this SQL data type

All Superinterfaces:

Serializable

All Known Implementing Classes:

DefaultDataType

public interface DataType<T>
extends Serializable

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
<A extends ArrayRecord<?>> DataType<A>	asArrayDataType(Class<A> arrayDataType)	Retrieve the data type for an Oracle-style ARRAY of this data type.
<U> DataType<U>	asConvertedDataType(Binding<? super T,U> binding)	Retrieve the data type for a given binding.
<U> DataType<U>	asConvertedDataType(Converter<? super T,U> converter)	Retrieve the data type for a given converter.
<E extends EnumType> DataType<E>	asEnumDataType(Class<E> enumDataType)	Retrieve the data type for a given enum data type.
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.
DataType<T>	characterSet(CharacterSet characterSet)	Return a new data type like this, with a new character set.
Collation	collation()	Get the collation of this data type, or null if there is no collation, or if the default collation applies.
DataType<T>	collation(Collation collation)	Return a new data type like this, with a new collation.
T	convert(Object object)	Convert an arbitrary object into <T>.
T[]	convert(Object... objects)	Convert an arbitrary set of objects into <T>.
List<T>	convert(Collection<?> objects)	Convert an arbitrary set of objects into <T>.
Field<T>	default_()	The expression to be applied as the DEFAULT value for this data type.
DataType<T>	default_(Field<T> defaultValue)	Specify an expression to be applied as the DEFAULT value for this data type.
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.
DataType<T>	defaulted(boolean defaulted)	Deprecated. - [#3852] - 3.8.0 - Use defaultValue(Field) instead.
Field<T>	defaultValue()	The expression to be applied as the DEFAULT value for this data type.
DataType<T>	defaultValue(Field<T> defaultValue)	Specify an expression to be applied as the DEFAULT value for this data type.
DataType<T>	defaultValue(T defaultValue)	Specify an expression to be applied as the DEFAULT value for this data type.
DataType<T[]>	getArrayDataType()	Retrieve the data type for an ARRAY of this data type.
Class<T[]>	getArrayType()	Retrieve the Java type associated with ARRAYs of this data type.
Binding<?,T>	getBinding()	Get the data type binding associated with this data type.
String	getCastTypeName()	Retrieve the dialect-specific type name associated with this data type used for casting.
String	getCastTypeName(Configuration configuration)	Retrieve the dialect-specific type name associated with this data type used for casting.
Converter<?,T>	getConverter()	Get the converter associated with this data type.
DataType<T>	getDataType(Configuration configuration)	The dialect-specific data type representing this data type.
SQLDialect	getDialect()	Retrieve the underlying SQLDialect.
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.
Class<T>	getType()	Retrieve the Java type associated with this data type.
String	getTypeName()	Retrieve the dialect-specific type name associated with this data type.
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.
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	isBinary()	Whether this data type is any binary type.
boolean	isDate()	Whether this data type is any date type.
boolean	isDateTime()	Whether this data type is any date or time type.
boolean	isEnum()	Whether this data type is an enum type.
boolean	isInteger()	Whether this data type is any integer data type.
boolean	isInterval()	Whether this data type is any interval type.
boolean	isLob()	Whether this data type is best deserialised as a LOB.
boolean	isNumeric()	Whether this data type is any numeric data 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	isUDT()	Whether this data type is a UDT type.
int	length()	Get the length of this data type.
DataType<T>	length(int length)	Return a new data type like this, with a new length value.
Nullability	nullability()	Get the nullability of this data type.
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.
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.
DataType<T>	precision(int precision)	Return a new data type like this, with a new precision value.
DataType<T>	precision(int precision, int scale)	Return a new data type like this, with a new precision and scale value.
int	scale()	Get the scale of this data type.
DataType<T>	scale(int scale)	Return a new data type like this, with a new scale value.

Method Detail

getSQLDataType

DataType<T> getSQLDataType()

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

getDataType

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

Binding<?,T> getBinding()

Get the data type binding associated with this data type.

getConverter

Converter<?,T> getConverter()

Get the converter associated with this data type.

getType

Class<T> getType()

Retrieve the Java type associated with this data type.

getArrayType

Class<T[]> getArrayType()

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

getArrayDataType

DataType<T[]> getArrayDataType()

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

asArrayDataType

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

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

asEnumDataType

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

Retrieve the data type for a given enum data type.

asConvertedDataType

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

Retrieve the data type for a given converter.

asConvertedDataType

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

Retrieve the data type for a given binding.

getTypeName

String getTypeName()

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

getTypeName

String getTypeName(Configuration configuration)

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

getCastTypeName

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

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

SQLDialect getDialect()

Retrieve the underlying SQLDialect.

convert

T convert(Object object)

Convert an arbitrary object into <T>.

See Convert.convert(Object, Class) for details about conversion rules.

Parameters:

object - The object to be converted

Returns:

The converted object

Throws:

DataTypeException - If conversion fails.

convert

T[] convert(Object... objects)

Convert an arbitrary set of objects into <T>.

See Convert.convert(Object, Class) for details about conversion rules.

Parameters:

objects - The objects to be converted

Returns:

The converted objects

Throws:

DataTypeException - If conversion fails.

convert

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

Convert an arbitrary set of objects into <T>.

See Convert.convert(Object, Class) for details about conversion rules.

Parameters:

objects - The objects to be converted

Returns:

The converted objects

Throws:

DataTypeException - If conversion fails.

nullability

@Support
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

Nullability nullability()

Get the nullability of this data type.

Returns:

The nullability

nullable

@Support
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

collation

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

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

collation

Collation collation()

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

characterSet

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

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

characterSet

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

@Support
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

@Support
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

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

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_

@Support
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_

@Support
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_

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

@Deprecated
DataType<T> defaulted(boolean defaulted)

Deprecated.

- [#3852] - 3.8.0 - Use defaultValue(Field) instead.

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

Parameters:

defaulted - The new defaultability

Returns:

The new data type

defaulted

boolean defaulted()

Get the defaultability of this data type.

Returns:

The defaultability

precision

@Support
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

@Support
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

scale

@Support
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

length

@Support
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

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

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

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

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

isTime

boolean isTime()

Whether this data type is any time type.

This applies to any of these types.

• SQLDataType.TIME
• SQLDataType.LOCALTIME

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
• 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.

isUDT

boolean isUDT()

Whether this data type is a UDT type.

isEnum

boolean isEnum()

Whether this data type is an enum type.