previous : next

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.

The DSLContext API

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

DSLContext references a org.jooq.Configuration, an object that configures jOOQ's behaviour when executing queries (see SQL execution for more details). Unlike the static DSL, the DSLContext allow for creating SQL statements that are already "configured" and ready for execution.

Fluent creation of a DSLContext object

The DSLContext object can be created fluently from the DSL type: 

// Create it from a pre-existing configuration
DSLContext create = DSL.using(configuration);

// Create it from ad-hoc arguments
DSLContext create = DSL.using(connection, dialect);

If you do not have a reference to a pre-existing Configuration object (e.g. created from org.jooq.impl.DefaultConfiguration), the various overloaded DSL.using() methods will create one for you.

Contents of a Configuration object

A Configuration can be supplied with these objects:

Usage of DSLContext

Wrapping a Configuration object, a DSLContext can construct statements, for later execution. An example is given here: 

// The DSLContext is "configured" with a Connection and a SQLDialect
DSLContext create = DSL.using(connection, dialect);

// This select statement contains an internal reference to the DSLContext's Configuration:
Select<?> select = create.selectOne();

// Using the internally referenced Configuration, the select statement can now be executed:
Result<?> result = select.fetch();

Note that you do not need to keep a reference to a DSLContext. You may as well inline your local variable, and fluently execute a SQL statement as such: 

// Execute a statement from a single execution chain:
Result<?> result =
DSL.using(connection, dialect)
   .select()
   .from(BOOK)
   .where(BOOK.TITLE.like("Animal%"))
   .fetch();

Table of contents

3.2.1.
SQL Dialect
3.2.2.
SQL Dialect Family
3.2.3.
SQL Dialect Category
3.2.4.
Connection vs. DataSource
3.2.5.
Custom data
3.2.6.
Custom ExecuteListeners
3.2.7.
Custom Unwrappers
3.2.8.
Custom Settings
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
3.2.9.
Thread safety

previous : next

References to this page

Feedback

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

↑ Back to top

Community

Support

Legal

Documentation

The jOOQ Logo