The commercial jOOQ distributions support a variety of dialects, which are
grouped into dialect families. For instance, the PostgreSQL dialect family
POSTGRES is specialised by its dialects
The open source jOOQ distributions only support the dialect family, which corresponds to the latest supported dialect version of the commercial distribution. A full list of mappings between dialect families and latest supported version can be seen here https://www.jooq.org/download/support-matrix.
If a dialect is documented but does not seem to be available in your jOOQ Edition, you may be using the wrong edition, e.g. because of a transitive dependency introduced by Spring Boot. See this article about how to exclude such transitive dependencies from your classpath https://blog.jooq.org/how-to-use-jooqs-commercial-distributions-with-spring-boot/.
| Modifier and Type | Class and Description |
|---|---|
| pack-priv static record | |
| public class | SQLDialect.ThirdParty
Third party representations of the enclosing |
| Modifier and Type | Field and Description |
|---|---|
| private final SQLDialectCategory | |
| private final boolean | |
| public static final SQLDialect | CUBRID
The CUBRID dialect family. |
| public static final SQLDialect | DEFAULT
The default SQL dialect. |
| public static final SQLDialect | DERBY
The Apache Derby dialect family. |
| private static final SQLDialect[] | |
| private final SQLDialect | |
| public static final SQLDialect | FIREBIRD
The Firebird dialect family. |
| public static final SQLDialect | H2
The H2 dialect family. |
| public static final SQLDialect | HSQLDB
The Hypersonic dialect family. |
| public static final SQLDialect | IGNITE
The Apache Ignite dialect family. |
| public static final SQLDialect | MARIADB
The MariaDB dialect family. |
| public static final SQLDialect | MYSQL
The MySQL dialect family. |
| private final String | name
Hides java. |
| private static final Pattern | |
| public static final SQLDialect | POSTGRES
The PostgreSQL dialect family. |
| private SQLDialect | |
| private transient EnumSet | |
| private final SQLDialect. | |
| public static final SQLDialect | SQLITE
The SQLite dialect family. |
| private final boolean | |
| private final SQLDialect. | |
| public static final SQLDialect | YUGABYTEDB
The YugabyteDB dialect family. |
| Access | Constructor and Description |
|---|---|
| private | |
| private | |
| private | SQLDialect(String name, boolean commercial, boolean supported, SQLDialect.
|
| private | SQLDialect(String name, boolean commercial, boolean supported, SQLDialect.
|
| private | SQLDialect(String name, boolean commercial, boolean supported, SQLDialect.
|
| private | SQLDialect(String name, boolean commercial, boolean supported, SQLDialect.
|
| private | SQLDialect(String name, boolean commercial, boolean supported, SQLDialect.
|
| Modifier and Type | Method and Description |
|---|---|
| private static final void | |
| public final @NotNull SQLDialectCategory | |
| public final boolean | |
| public static final @NotNull @NotNull SQLDialect[] | |
| public final @NotNull SQLDialect | |
| public final @NotNull String | |
| public final @NotNull String | |
| public final @NotNull String | |
| public final boolean | |
| public final boolean | |
| private final int | |
| public final boolean | |
| public final boolean | precedesStrictly(SQLDialect other)
Whether this dialect strictly precedes an other dialect from the same family. |
| public final @NotNull SQLDialect | |
| public static final @NotNull Set | |
| public final @NotNull Set | |
| public final boolean | |
| public static final @NotNull Set | supportedBy(SQLDialect dialect)
Get a set of supported dialect versions and successors given a dialect version. |
| public static final @NotNull Set | supportedBy(SQLDialect... dialects)
Get a set of supported dialect versions and successors given a set of dialect versions. |
| public static final @NotNull Set | supportedUntil(SQLDialect dialect)
Get a set of supported dialect versions and predecessors given a dialect version. |
| public static final @NotNull Set | supportedUntil(SQLDialect... dialects)
Get a set of supported dialect versions and predecessors given a dialect version. |
| public final boolean | |
| public final boolean | supports(Collection<SQLDialect> other)
Deprecated
for removal since 3.14. - [#9882] - 3.14.0 - Use
Check whether this dialect supports any dialect from the argument
collection.
supportedBy(SQLDialect. instead
|
| public final boolean | supportsDatabaseVersion(int majorVersion, int minorVersion, String productVersion)
Check if this |
| public final @NotNull SQLDialect. | |
| public static SQLDialect | |
| public static SQLDialect[] |
| category | back to summary |
|---|---|
| private final SQLDialectCategory category | |
| commercial | back to summary |
|---|---|
| private final boolean commercial | |
| CUBRID | back to summary |
|---|---|
| public static final SQLDialect CUBRID
Deprecated for removal since 3.13. - [#9403] - 3.13.0 - This dialect is hardly used by anyone with jOOQ or without jOOQ and will be removed in the near future. The CUBRID dialect family.
| |
| DEFAULT | back to summary |
|---|---|
| public static final SQLDialect DEFAULT The default SQL dialect. This dialect is chosen in the absence of a more explicit dialect. It is not intended to be used with any actual database as it may combined dialect-specific things from various dialects. | |
| DERBY | back to summary |
|---|---|
| public static final SQLDialect DERBY The Apache Derby dialect family. | |
| FAMILIES | back to summary |
|---|---|
| private static final SQLDialect[] FAMILIES | |
| family | back to summary |
|---|---|
| private final SQLDialect family | |
| FIREBIRD | back to summary |
|---|---|
| public static final SQLDialect FIREBIRD The Firebird dialect family.
This family behaves like the versioned dialect | |
| H2 | back to summary |
|---|---|
| public static final SQLDialect H2 The H2 dialect family. | |
| HSQLDB | back to summary |
|---|---|
| public static final SQLDialect HSQLDB The Hypersonic dialect family. | |
| IGNITE | back to summary |
|---|---|
| public static final SQLDialect IGNITE
Deprecated for removal since 3.16. - [#12465] - 3.16.0 - This dialect is hardly used by anyone with jOOQ or without jOOQ and will be removed in the near future. If you're actively using this dialect, please get in touch for extended support: https://github.com/jOOQ/jOOQ/issues/12465 The Apache Ignite dialect family.
| |
| MARIADB | back to summary |
|---|---|
| public static final SQLDialect MARIADB The MariaDB dialect family.
This family behaves like the versioned dialect | |
| MYSQL | back to summary |
|---|---|
| public static final SQLDialect MYSQL The MySQL dialect family.
This family behaves like the versioned dialect | |
| name | back to summary |
|---|---|
| private final String name Hides java. | |
| P_PATCH_VERSION_MYSQL | back to summary |
|---|---|
| private static final Pattern P_PATCH_VERSION_MYSQL | |
| POSTGRES | back to summary |
|---|---|
| public static final SQLDialect POSTGRES The PostgreSQL dialect family.
This family behaves like the versioned dialect
While this family (and its dialects) have been observed to work to some
extent on Amazon RedShift as well, we strongly suggest you use the
official | |
| predecessor | back to summary |
|---|---|
| private SQLDialect predecessor | |
| predecessors | back to summary |
|---|---|
| private transient EnumSet<SQLDialect> predecessors | |
| requiredVersion | back to summary |
|---|---|
| private final SQLDialect. | |
| SQLITE | back to summary |
|---|---|
| public static final SQLDialect SQLITE The SQLite dialect family.
This family behaves like the versioned dialect | |
| supported | back to summary |
|---|---|
| private final boolean supported | |
| thirdParty | back to summary |
|---|---|
| private final SQLDialect. | |
| YUGABYTEDB | back to summary |
|---|---|
| public static final SQLDialect YUGABYTEDB The YugabyteDB dialect family. | |
| SQLDialect | back to summary |
|---|---|
| private SQLDialect(String name, boolean commercial, boolean supported) | |
| SQLDialect | back to summary |
|---|---|
| private SQLDialect(String name, boolean commercial, boolean supported, SQLDialectCategory category) | |
| SQLDialect | back to summary |
|---|---|
| private SQLDialect(String name, boolean commercial, boolean supported, SQLDialect. | |
| SQLDialect | back to summary |
|---|---|
| private SQLDialect(String name, boolean commercial, boolean supported, SQLDialect. | |
| SQLDialect | back to summary |
|---|---|
| private SQLDialect(String name, boolean commercial, boolean supported, SQLDialect. | |
| SQLDialect | back to summary |
|---|---|
| private SQLDialect(String name, boolean commercial, boolean supported, SQLDialect. | |
| SQLDialect | back to summary |
|---|---|
| private SQLDialect(String name, boolean commercial, boolean supported, SQLDialect. | |
| addSupportedBy | back to summary |
|---|---|
| private static final void addSupportedBy(SQLDialect dialect, EnumSet<SQLDialect> supported) | |
| category | back to summary |
|---|---|
| public final @NotNull SQLDialectCategory category() The dialect category.
| |
| commercial | back to summary |
|---|---|
| public final boolean commercial() Whether this dialect is supported with the jOOQ commercial license only. | |
| families | back to summary |
|---|---|
| public static final @NotNull @NotNull SQLDialect[] families() Get a list of all
| |
| family | back to summary |
|---|---|
| public final @NotNull SQLDialect family() The dialect family. This returns the dialect itself, if it has no "parent family". E.g.
| |
| getName | back to summary |
|---|---|
| public final @NotNull String getName() The name of this dialect as it appears in related class names.
| |
| getNameLC | back to summary |
|---|---|
| public final @NotNull String getNameLC() The name of this dialect as it appears in related package names.
| |
| getNameUC | back to summary |
|---|---|
| public final @NotNull String getNameUC() The name of this dialect as it appears in related enum values.
| |
| isFamily | back to summary |
|---|---|
| public final boolean isFamily() Whether this dialect is a | |
| isVersioned | back to summary |
|---|---|
| public final boolean isVersioned() Whether this dialect is a versioned dialect or a family with versioned dialects. | |
| patchVersion | back to summary |
|---|---|
| private final int patchVersion(String productVersion) | |
| precedes | back to summary |
|---|---|
| public final boolean precedes(SQLDialect other) Whether this dialect precedes an other dialect from the same family. This returns:
This is useful to see if some feature is supported by "at least" a given dialect version. Example:
| |
| precedesStrictly | back to summary |
|---|---|
| public final boolean precedesStrictly(SQLDialect other) Whether this dialect strictly precedes an other dialect from the same family. This returns:
This is useful to see if some feature is supported by "at least" a given dialect version. Example:
| |
| predecessor | back to summary |
|---|---|
| public final @NotNull SQLDialect predecessor() The predecessor dialect.
If this is a dialect version (e.g.
| |
| predecessors | back to summary |
|---|---|
| public static final @NotNull Set Get a set of dialects preceding a given set of dialects. The resulting set of dialects contain all the families and dialect versions that precede the argument dialects, including the argument dialects.
| |
| predecessors | back to summary |
|---|---|
| public final @NotNull Set The predecessor dialects.
Recursively calls
| |
| supported | back to summary |
|---|---|
| public final boolean supported() Whether this dialect is supported by jOOQ as an output dialect. Unsupported, non-output dialects include:
| |
| supportedBy | back to summary |
|---|---|
| public static final @NotNull Set Get a set of supported dialect versions and successors given a dialect version. The resulting set of dialects contain all the families and dialect versions that support the argument dialect, i.e. that succeed it, including the argument dialect.
| |
| supportedBy | back to summary |
|---|---|
| public static final @NotNull Set Get a set of supported dialect versions and successors given a set of dialect versions. The resulting set of dialects contain all the families and dialect versions that support the argument dialects, i.e. that succeed them, including the argument dialects.
| |
| supportedUntil | back to summary |
|---|---|
| public static final @NotNull Set Get a set of supported dialect versions and predecessors given a dialect version. The resulting set of dialects contain all the families and dialect versions that precede the argument dialect, including the argument dialect.
| |
| supportedUntil | back to summary |
|---|---|
| public static final @NotNull Set Get a set of supported dialect versions and predecessors given a dialect version. The resulting set of dialects contain all the families and dialect versions that precede the argument dialect, including the argument dialects.
| |
| supports | back to summary |
|---|---|
| public final boolean supports(SQLDialect other) Check whether this dialect supports another one. This is:
The | |
| supports | back to summary |
|---|---|
| public final boolean supports(Collection<SQLDialect> other)
Check whether this dialect supports any dialect from the argument collection.
| |
| supportsDatabaseVersion | back to summary |
|---|---|
| public final boolean supportsDatabaseVersion(int majorVersion, int minorVersion, String productVersion) Check if this | |
| thirdParty | back to summary |
|---|---|
| public final @NotNull SQLDialect. Get access to third party representations of this
| |
| valueOf | back to summary |
|---|---|
| public static SQLDialect valueOf(String name) | |
| values | back to summary |
|---|---|
| public static SQLDialect[] values() | |
| Modifier and Type | Field and Description |
|---|---|
| private final Integer | |
| private final Integer | |
| private final Integer |
| Access | Constructor and Description |
|---|---|
| pack-priv |
| Modifier and Type | Method and Description |
|---|---|
| public final boolean | equals(Object
the reference object with which to compare. o)Implements abstract java. |
| public final int | |
| public Integer | |
| public Integer | |
| public Integer | |
| public final String | toString()
Implements abstract java. |
| major | back to summary |
|---|---|
| private final Integer major Record Component accessed by major(). | |
| minor | back to summary |
|---|---|
| private final Integer minor Record Component accessed by minor(). | |
| patch | back to summary |
|---|---|
| private final Integer patch Record Component accessed by patch(). | |
| RequiredVersion | back to summary |
|---|---|
| pack-priv RequiredVersion(Integer major, Integer minor, Integer patch) | |
| equals | back to summary |
|---|---|
| public final boolean equals(Object o) Implements abstract java. Doc from java. Indicates whether some other object is "equal to" this one. In addition
to the general contract of
R copy = new R(r.c1(), r.c2(), ..., r.cn());
then it must be the case that r.equals(copy).
| |
| hashCode | back to summary |
|---|---|
| public final int hashCode() Implements abstract java. Doc from java. Returns a hash code value for the record.
Obeys the general contract of
| |
| major | back to summary |
|---|---|
| public Integer major() Record Component getter of major. | |
| minor | back to summary |
|---|---|
| public Integer minor() Record Component getter of minor. | |
| patch | back to summary |
|---|---|
| public Integer patch() Record Component getter of patch. | |
| toString | back to summary |
|---|---|
| public final String toString() Implements abstract java. Doc from java. Returns a string representation of the record.
In accordance with the general contract of In addition to this general contract, record classes must further participate in the invariant that any two records which are equal must produce equal strings. This invariant is necessarily relaxed in the rare case where corresponding equal component values might fail to produce equal strings for themselves.
| |
SQLDialect.
| Access | Constructor and Description |
|---|---|
| public |
| Modifier and Type | Method and Description |
|---|---|
| public final @NotNull String | Returns: The appropriate JDBC driver class or"java.sql.Driver" if no driver class could be
derived from the URL. Never null."Guess" the JDBC driver from a |
| public final @Nullable String | |
| public final @Nullable String |
| ThirdParty | back to summary |
|---|---|
| public ThirdParty() | |
| driver | back to summary |
|---|---|
| public final @NotNull String driver() "Guess" the JDBC driver from a | |
| hibernateDialect | back to summary |
|---|---|
| public final @Nullable String hibernateDialect() The Hibernate dialect name or
| |
| springDbName | back to summary |
|---|---|
| public final @Nullable String springDbName() The Spring DB name or
The name returned by this method corresponds to the DB id as
referenced in
| |