Module org.jooq

Package org.jooq.impl

Class SQLDataType

java.lang.Object

org.jooq.impl.SQLDataType

public final class SQLDataType
extends Object

The SQL standard data types, as described in Types.

These types are usually the ones that are referenced by generated source code. Most RDBMS have an almost 1:1 mapping between their vendor-specific types and the ones in this class (except Oracle). Some RDBMS also have extensions, e.g. for geospacial data types. See the dialect-specific data type classes for more information.

Author:

Lukas Eder

Field Summary

Fields

Modifier and Type	Field	Description
static final DataType<Long>	BIGINT	The Types.BIGINT type.
static final DataType<ULong>	BIGINTUNSIGNED	The unsigned Types.BIGINT type.
static final DataType<byte[]>	BINARY	The Types.BINARY type.
static final DataType<Boolean>	BIT	The Types.BIT type.
static final DataType<byte[]>	BLOB	The Types.BLOB type.
static final DataType<Boolean>	BOOLEAN	The Types.BOOLEAN type.
static final DataType<String>	CHAR	The Types.CHAR type.
static final DataType<String>	CLOB	The Types.CLOB type.
static final DataType<Date>	DATE	The Types.DATE type.
static final DataType<BigDecimal>	DECIMAL	The Types.DECIMAL type.
static final DataType<BigInteger>	DECIMAL_INTEGER	The zero-scale Types.DECIMAL type.
static final DataType<Double>	DOUBLE	The Types.DOUBLE type.
static final DataType<Double>	FLOAT	The Types.FLOAT type.
static final DataType<Geography>	GEOGRAPHY	The Geography type.
static final DataType<Geometry>	GEOMETRY	The Geometry type.
static final DataType<Instant>	INSTANT	A Types.TIMESTAMP_WITH_TIMEZONE type that uses UTC as time zone.
static final DataType<Integer>	INTEGER	The Types.INTEGER type.
static final DataType<UInteger>	INTEGERUNSIGNED	The unsigned Types.INTEGER type.
static final DataType<YearToSecond>	INTERVAL	A vendor specific INTERVAL YEAR TO SECOND data type, which combines INTERVALYEARTOMONTH and INTERVALDAYTOSECOND.
static final DataType<DayToSecond>	INTERVALDAYTOSECOND	The SQL standard INTERVAL DAY TO SECOND data type.
static final DataType<YearToMonth>	INTERVALYEARTOMONTH	The SQL standard INTERVAL YEAR TO MONTH data type.
static final DataType<JSON>	JSON	The JSON type.
static final DataType<JSONB>	JSONB	The JSONB type.
static final DataType<LocalDate>	LOCALDATE	The Types.DATE type.
static final DataType<LocalDateTime>	LOCALDATETIME	The Types.TIMESTAMP type.
static final DataType<LocalTime>	LOCALTIME	The Types.TIME type.
static final DataType<String>	LONGNVARCHAR	The Types.LONGNVARCHAR type.
static final DataType<byte[]>	LONGVARBINARY	The Types.LONGVARBINARY type.
static final DataType<String>	LONGVARCHAR	The Types.LONGVARCHAR type.
static final DataType<String>	NCHAR	The Types.NCHAR type.
static final DataType<String>	NCLOB	The Types.NCLOB type.
static final DataType<BigDecimal>	NUMERIC	The Types.NUMERIC type.
static final DataType<String>	NVARCHAR	The Types.NVARCHAR type.
static final DataType<OffsetDateTime>	OFFSETDATETIME	The Types.TIMESTAMP_WITH_TIMEZONE type.
static final DataType<OffsetTime>	OFFSETTIME	The Types.TIME_WITH_TIMEZONE type.
static final DataType<Object>	OTHER	The Types.OTHER type.
static final DataType<Float>	REAL	The Types.REAL type.
static final DataType<Record>	RECORD	The Types.STRUCT type.
static final DataType<Result<Record>>	RESULT	The ResultSet type.
static final DataType<RowId>	ROWID	The Types.ROWID type.
static final DataType<Short>	SMALLINT	The Types.SMALLINT type.
static final DataType<UShort>	SMALLINTUNSIGNED	The unsigned Types.SMALLINT type.
static final DataType<Time>	TIME	The Types.TIME type.
static final DataType<Timestamp>	TIMESTAMP	The Types.TIMESTAMP type.
static final DataType<OffsetDateTime>	TIMESTAMPWITHTIMEZONE	The Types.TIMESTAMP_WITH_TIMEZONE type.
static final DataType<OffsetTime>	TIMEWITHTIMEZONE	The Types.TIME_WITH_TIMEZONE type.
static final DataType<Byte>	TINYINT	The Types.TINYINT type.
static final DataType<UByte>	TINYINTUNSIGNED	The unsigned Types.TINYINT type.
static final DataType<UUID>	UUID	The UUID type.
static final DataType<byte[]>	VARBINARY	The Types.VARBINARY type.
static final DataType<String>	VARCHAR	The Types.VARCHAR type.
static final DataType<XML>	XML	The XML type.
static final DataType<Year>	YEAR	A Types.SMALLINT type that represents a year.

Method Summary

Modifier and Type	Method	Description
static final DataType<byte[]>	BINARY(int length)	The Types.BINARY type.
static final DataType<byte[]>	BLOB(int length)	The Types.BLOB type.
static final DataType<String>	CHAR(int length)	The Types.CHAR type.
static final DataType<String>	CLOB(int length)	The Types.CLOB type.
static final DataType<BigDecimal>	DECIMAL(int precision)	The Types.DECIMAL type.
static final DataType<BigDecimal>	DECIMAL(int precision, int scale)	The Types.DECIMAL type.
static final DataType<BigInteger>	DECIMAL_INTEGER(int precision)	The zero-scale Types.DECIMAL type.
static final DataType<Instant>	INSTANT(int precision)	A Types.TIMESTAMP_WITH_TIMEZONE type that uses UTC as time zone.
static final DataType<LocalDateTime>	LOCALDATETIME(int precision)	The Types.TIMESTAMP type.
static final DataType<LocalTime>	LOCALTIME(int precision)	The Types.TIME type.
static final DataType<String>	LONGNVARCHAR(int length)	The Types.LONGNVARCHAR type.
static final DataType<byte[]>	LONGVARBINARY(int length)	The Types.LONGVARBINARY type.
static final DataType<String>	LONGVARCHAR(int length)	The Types.LONGVARCHAR type.
static final DataType<String>	NCHAR(int length)	The Types.NCHAR type.
static final DataType<String>	NCLOB(int length)	The Types.NCLOB type.
static final DataType<BigDecimal>	NUMERIC(int precision)	The Types.NUMERIC type.
static final DataType<BigDecimal>	NUMERIC(int precision, int scale)	The Types.NUMERIC type.
static final DataType<String>	NVARCHAR(int length)	The Types.NVARCHAR type.
static final DataType<OffsetDateTime>	OFFSETDATETIME(int precision)	The Types.TIMESTAMP_WITH_TIMEZONE type.
static final DataType<OffsetTime>	OFFSETTIME(int precision)	The Types.TIME_WITH_TIMEZONE type.
static final DataType<Time>	TIME(int precision)	The Types.TIME type.
static final DataType<Timestamp>	TIMESTAMP(int precision)	The Types.TIMESTAMP type.
static final DataType<OffsetDateTime>	TIMESTAMPWITHTIMEZONE(int precision)	The Types.TIMESTAMP_WITH_TIMEZONE type.
static final DataType<OffsetTime>	TIMEWITHTIMEZONE(int precision)	The Types.TIME_WITH_TIMEZONE type.
static final DataType<byte[]>	VARBINARY(int length)	The Types.VARBINARY type.
static final DataType<String>	VARCHAR(int length)	The Types.VARCHAR type.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

VARCHAR

public static final DataType<String> VARCHAR

The Types.VARCHAR type.

CHAR

public static final DataType<String> CHAR

The Types.CHAR type.

LONGVARCHAR

public static final DataType<String> LONGVARCHAR

The Types.LONGVARCHAR type.

CLOB

public static final DataType<String> CLOB

The Types.CLOB type.

NVARCHAR

public static final DataType<String> NVARCHAR

The Types.NVARCHAR type.

NCHAR

public static final DataType<String> NCHAR

The Types.NCHAR type.

LONGNVARCHAR

public static final DataType<String> LONGNVARCHAR

The Types.LONGNVARCHAR type.

NCLOB

public static final DataType<String> NCLOB

The Types.NCLOB type.

BOOLEAN

public static final DataType<Boolean> BOOLEAN

The Types.BOOLEAN type.

BIT

public static final DataType<Boolean> BIT

The Types.BIT type.

TINYINT

public static final DataType<Byte> TINYINT

The Types.TINYINT type.

SMALLINT

public static final DataType<Short> SMALLINT

The Types.SMALLINT type.

INTEGER

public static final DataType<Integer> INTEGER

The Types.INTEGER type.

BIGINT

public static final DataType<Long> BIGINT

The Types.BIGINT type.

DECIMAL_INTEGER

public static final DataType<BigInteger> DECIMAL_INTEGER

The zero-scale Types.DECIMAL type.

TINYINTUNSIGNED

public static final DataType<UByte> TINYINTUNSIGNED

The unsigned Types.TINYINT type.

SMALLINTUNSIGNED

public static final DataType<UShort> SMALLINTUNSIGNED

The unsigned Types.SMALLINT type.

INTEGERUNSIGNED

public static final DataType<UInteger> INTEGERUNSIGNED

The unsigned Types.INTEGER type.

BIGINTUNSIGNED

public static final DataType<ULong> BIGINTUNSIGNED

The unsigned Types.BIGINT type.

DOUBLE

public static final DataType<Double> DOUBLE

The Types.DOUBLE type.

FLOAT

public static final DataType<Double> FLOAT

The Types.FLOAT type.

REAL

public static final DataType<Float> REAL

The Types.REAL type.

NUMERIC

public static final DataType<BigDecimal> NUMERIC

The Types.NUMERIC type.

DECIMAL

public static final DataType<BigDecimal> DECIMAL

The Types.DECIMAL type.

DATE

public static final DataType<Date> DATE

The Types.DATE type.

TIMESTAMP

public static final DataType<Timestamp> TIMESTAMP

The Types.TIMESTAMP type.

TIME

public static final DataType<Time> TIME

The Types.TIME type.

INTERVAL

public static final DataType<YearToSecond> INTERVAL

A vendor specific INTERVAL YEAR TO SECOND data type, which combines INTERVALYEARTOMONTH and INTERVALDAYTOSECOND.

If you want to opt out of code generation support for this type, you can specify /configuration/generator/generate/intervalTypes to false.

INTERVALYEARTOMONTH

public static final DataType<YearToMonth> INTERVALYEARTOMONTH

The SQL standard INTERVAL YEAR TO MONTH data type.

If you want to opt out of code generation support for this type, you can specify /configuration/generator/generate/intervalTypes to false.

INTERVALDAYTOSECOND

public static final DataType<DayToSecond> INTERVALDAYTOSECOND

The SQL standard INTERVAL DAY TO SECOND data type.

If you want to opt out of code generation support for this type, you can specify /configuration/generator/generate/intervalTypes to false.

LOCALDATE

public static final DataType<LocalDate> LOCALDATE

The Types.DATE type.

LOCALTIME

public static final DataType<LocalTime> LOCALTIME

The Types.TIME type.

LOCALDATETIME

public static final DataType<LocalDateTime> LOCALDATETIME

The Types.TIMESTAMP type.

OFFSETTIME

public static final DataType<OffsetTime> OFFSETTIME

The Types.TIME_WITH_TIMEZONE type.

The behaviour of this data type is influenced by the JDBC driver and the database that is used. Some databases support actual time zones (as in ZonedDateTime), other databases support only offsets (as in OffsetDateTime). Some databases retain the actual time zone information that is stored and reproduce it with every fetch (e.g. SQLDialect.ORACLE), others use this type as a synonym for a timestamp in UTC (e.g. SQLDialect.POSTGRES), producing possibly a value in the current time zone of the database or the client. Please refer to your database for more information about the behaviour of this data type.

OFFSETDATETIME

public static final DataType<OffsetDateTime> OFFSETDATETIME

The Types.TIMESTAMP_WITH_TIMEZONE type.

The behaviour of this data type is influenced by the JDBC driver and the database that is used. Some databases support actual time zones (as in ZonedDateTime), other databases support only offsets (as in OffsetDateTime). Some databases retain the actual time zone information that is stored and reproduce it with every fetch (e.g. SQLDialect.ORACLE), others use this type as a synonym for a timestamp in UTC (e.g. SQLDialect.POSTGRES), producing possibly a value in the current time zone of the database or the client. Please refer to your database for more information about the behaviour of this data type.

TIMEWITHTIMEZONE

public static final DataType<OffsetTime> TIMEWITHTIMEZONE

The Types.TIME_WITH_TIMEZONE type.

An alias for OFFSETTIME

TIMESTAMPWITHTIMEZONE

public static final DataType<OffsetDateTime> TIMESTAMPWITHTIMEZONE

The Types.TIMESTAMP_WITH_TIMEZONE type.

An alias for OFFSETDATETIME

INSTANT

public static final DataType<Instant> INSTANT

A Types.TIMESTAMP_WITH_TIMEZONE type that uses UTC as time zone.

Neither JDBC, nor most SQL databases support the INSTANT data type, which is often the only kind of timestamp which can be expected to behave across all server and client time zone settings. This implementation is backed by the database vendor's TIMESTAMP WITH TIME ZONE data type implementation, which may (e.g. Oracle) or may not (e.g. PostgreSQL) store the timestamp information. Irrespective of that storage, this type will always produce time zone agnostic instants in client code.

YEAR

public static final DataType<Year> YEAR

A Types.SMALLINT type that represents a year.

While JDBC does not support this type, some dialects do, specifically those of the SQLDialectCategory.MYSQL category.

BINARY

public static final DataType<byte[]> BINARY

The Types.BINARY type.

VARBINARY

public static final DataType<byte[]> VARBINARY

The Types.VARBINARY type.

LONGVARBINARY

public static final DataType<byte[]> LONGVARBINARY

The Types.LONGVARBINARY type.

BLOB

public static final DataType<byte[]> BLOB

The Types.BLOB type.

OTHER

public static final DataType<Object> OTHER

The Types.OTHER type.

ROWID

public static final DataType<RowId> ROWID

The Types.ROWID type.

RECORD

public static final DataType<Record> RECORD

The Types.STRUCT type.

RESULT

public static final DataType<Result<Record>> RESULT

The ResultSet type.

This is not a JDBC standard. This type emulates REF CURSOR types and similar constructs

UUID

public static final DataType<UUID> UUID

The UUID type.

This is not a JDBC standard. This type handles UUID types where they are supported

JSON

public static final DataType<JSON> JSON

The JSON type.

This is not a JDBC standard. This type handles JSON types where they are supported.

If you want to opt out of code generation support for this type, you can specify /configuration/generator/generate/jsonTypes to false.

JSONB

public static final DataType<JSONB> JSONB

The JSONB type.

This is not a JDBC standard. This type handles JSONB types where they are supported.

If you want to opt out of code generation support for this type, you can specify /configuration/generator/generate/jsonTypes to false.

XML

public static final DataType<XML> XML

The XML type.

This is not a JDBC standard. This type handles XML types where they are supported.

If you want to opt out of code generation support for this type, you can specify /configuration/generator/generate/xmlTypes to false.

GEOGRAPHY

public static final DataType<Geography> GEOGRAPHY

The Geography type.

This is not a JDBC standard. This type handles spatial types where they are supported.

If you want to opt out of code generation support for this type, you can specify /configuration/generator/generate/spatialTypes to false.

This data type is supported only by the commercial editions of jOOQ.

GEOMETRY

public static final DataType<Geometry> GEOMETRY

The Geometry type.

This is not a JDBC standard. This type handles spatial types where they are supported.

If you want to opt out of code generation support for this type, you can specify /configuration/generator/generate/spatialTypes to false.

This data type is supported only by the commercial editions of jOOQ.

Method Details

VARCHAR

public static final DataType<String> VARCHAR(int length)

The Types.VARCHAR type.

CHAR

public static final DataType<String> CHAR(int length)

The Types.CHAR type.

LONGVARCHAR

public static final DataType<String> LONGVARCHAR(int length)

The Types.LONGVARCHAR type.

CLOB

public static final DataType<String> CLOB(int length)

The Types.CLOB type.

NVARCHAR

public static final DataType<String> NVARCHAR(int length)

The Types.NVARCHAR type.

NCHAR

public static final DataType<String> NCHAR(int length)

The Types.NCHAR type.

LONGNVARCHAR

public static final DataType<String> LONGNVARCHAR(int length)

The Types.LONGNVARCHAR type.

NCLOB

public static final DataType<String> NCLOB(int length)

The Types.NCLOB type.

DECIMAL_INTEGER

public static final DataType<BigInteger> DECIMAL_INTEGER(int precision)

The zero-scale Types.DECIMAL type.

NUMERIC

public static final DataType<BigDecimal> NUMERIC(int precision)

The Types.NUMERIC type.

NUMERIC

public static final DataType<BigDecimal> NUMERIC(int precision,
 int scale)

The Types.NUMERIC type.

DECIMAL

public static final DataType<BigDecimal> DECIMAL(int precision)

The Types.DECIMAL type.

DECIMAL

public static final DataType<BigDecimal> DECIMAL(int precision,
 int scale)

The Types.DECIMAL type.

TIMESTAMP

public static final DataType<Timestamp> TIMESTAMP(int precision)

The Types.TIMESTAMP type.

TIME

public static final DataType<Time> TIME(int precision)

The Types.TIME type.

LOCALTIME

public static final DataType<LocalTime> LOCALTIME(int precision)

The Types.TIME type.

LOCALDATETIME

public static final DataType<LocalDateTime> LOCALDATETIME(int precision)

The Types.TIMESTAMP type.

OFFSETTIME

public static final DataType<OffsetTime> OFFSETTIME(int precision)

The Types.TIME_WITH_TIMEZONE type.

The behaviour of this data type is influenced by the JDBC driver and the database that is used. Some databases support actual time zones (as in ZonedDateTime), other databases support only offsets (as in OffsetDateTime). Some databases retain the actual time zone information that is stored and reproduce it with every fetch (e.g. SQLDialect.ORACLE), others use this type as a synonym for a timestamp in UTC (e.g. SQLDialect.POSTGRES), producing possibly a value in the current time zone of the database or the client. Please refer to your database for more information about the behaviour of this data type.

OFFSETDATETIME

public static final DataType<OffsetDateTime> OFFSETDATETIME(int precision)

The Types.TIMESTAMP_WITH_TIMEZONE type.

The behaviour of this data type is influenced by the JDBC driver and the database that is used. Some databases support actual time zones (as in ZonedDateTime), other databases support only offsets (as in OffsetDateTime). Some databases retain the actual time zone information that is stored and reproduce it with every fetch (e.g. SQLDialect.ORACLE), others use this type as a synonym for a timestamp in UTC (e.g. SQLDialect.POSTGRES), producing possibly a value in the current time zone of the database or the client. Please refer to your database for more information about the behaviour of this data type.

TIMEWITHTIMEZONE

public static final DataType<OffsetTime> TIMEWITHTIMEZONE(int precision)

The Types.TIME_WITH_TIMEZONE type.

An alias for OFFSETTIME

TIMESTAMPWITHTIMEZONE

public static final DataType<OffsetDateTime> TIMESTAMPWITHTIMEZONE(int precision)

The Types.TIMESTAMP_WITH_TIMEZONE type.

An alias for OFFSETDATETIME

INSTANT

public static final DataType<Instant> INSTANT(int precision)

A Types.TIMESTAMP_WITH_TIMEZONE type that uses UTC as time zone.

Neither JDBC, nor most SQL databases support the INSTANT data type, which is often the only kind of timestamp which can be expected to behave across all server and client time zone settings. This implementation is backed by the database vendor's TIMESTAMP WITH TIME ZONE data type implementation, which may (e.g. Oracle) or may not (e.g. PostgreSQL) store the timestamp information. Irrespective of that storage, this type will always produce time zone agnostic instants in client code.

BINARY

public static final DataType<byte[]> BINARY(int length)

The Types.BINARY type.

VARBINARY

public static final DataType<byte[]> VARBINARY(int length)

The Types.VARBINARY type.

LONGVARBINARY

public static final DataType<byte[]> LONGVARBINARY(int length)

The Types.LONGVARBINARY type.

BLOB

public static final DataType<byte[]> BLOB(int length)

The Types.BLOB type.