Available in versions: Dev (3.20) | Latest (3.19) | 3.18 | 3.17 | 3.16 | 3.15 | 3.14 | 3.13 | 3.12 | 3.11 | 3.10

This documentation is for the unreleased development version of jOOQ. Click on the above version links to get this documentation for a supported version of jOOQ.

Custom Settings

Applies to ✅ Open Source Edition ✅ Express Edition ✅ Professional Edition ✅ Enterprise Edition

The jOOQ Configuration allows for some optional configuration elements to be used by advanced users. The org.jooq.conf.Settings class is a JAXB-annotated type, that can be provided to a Configuration in several ways:

In the DSLContext constructor (DSL.using()). This will override default settings below
in the org.jooq.impl.DefaultConfiguration constructor. This will override default settings below
From a location specified by a JVM parameter: -Dorg.jooq.settings
From the classpath at /jooq-settings.xml
From the settings defaults, as specified in https://www.jooq.org/xsd/jooq-runtime-3.19.0.xsd

The most specific settings for a given context will apply.

If you wish to configure your settings through XML, but explicitly load them for a given Configuration, you can do so as well, using JAXB:

Settings settings = JAXB.unmarshal(new File("/path/to/settings.xml"), Settings.class);

Example

For example, if you want to indicate to jOOQ, that it should inline all bind variables, and execute static java.sql.Statement instead of binding its variables to java.sql.PreparedStatement, you can do so by creating the following DSLContext:

Settings settings = new Settings();
settings.setStatementType(StatementType.STATIC_STATEMENT);
DSLContext create = DSL.using(connection, dialect, settings);

More details

Please refer to the jOOQ runtime configuration XSD for more details:
https://www.jooq.org/xsd/jooq-runtime-3.19.0.xsd

3.2.8.1.: Auto-attach Records
3.2.8.2.: Auto-inline bind values
3.2.8.3.: Backslash Escaping
3.2.8.4.: Batch size
3.2.8.5.: Computed column activation (new)
3.2.8.6.: Computed column emulation
3.2.8.7.: Diagnostics Connection
3.2.8.8.: Diagnostics Logging
3.2.8.9.: Dialect compatibility
3.2.8.10.: Dirty tracking (new)
3.2.8.11.: Dollar quoted string token
3.2.8.12.: Execute Logging
3.2.8.13.: Execute Logging SQL Exceptions
3.2.8.14.: Fetching trimmed CHAR types (new)
3.2.8.15.: Fetch Warnings
3.2.8.16.: GROUP_CONCAT Configuration
3.2.8.17.: Identifier style
3.2.8.18.: Implicit join type
3.2.8.19.: Inline Threshold
3.2.8.20.: IN-list Padding
3.2.8.21.: Interpreter Configuration
3.2.8.22.: JDBC Flags
3.2.8.23.: Keyword style
3.2.8.24.: Listener Invocation Order
3.2.8.25.: Locales
3.2.8.26.: Map JPA Annotations
3.2.8.27.: Object qualification
3.2.8.28.: Object qualification for columns
3.2.8.29.: Optimistic Locking
3.2.8.30.: Parameter name prefix
3.2.8.31.: Parameter types
3.2.8.32.: Parser Configuration
3.2.8.33.: Readonly column behaviour
3.2.8.34.: Reflection caching
3.2.8.35.: Return all columns on store
3.2.8.36.: Return computed columns on store
3.2.8.37.: Return DEFAULT columns on store
3.2.8.38.: Return Identity Value On Store
3.2.8.39.: Runtime catalog, schema and table mapping
3.2.8.40.: Scalar subqueries for stored functions
3.2.8.41.: SEEK clause implementation
3.2.8.42.: Statement Type
3.2.8.43.: Updatable Primary Keys

previous : next

References to this page

Feedback

Do you have any feedback about this page? We'd love to hear it!

Tell us a little bit about yourself and join our newsletter (examples)

Custom Settings

Example

More details

Table of contents

References to this page

Feedback

Community

Support

Legal

Documentation