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
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:
-
org.jooq.SQLDialect
: The dialect of your database. This may be any of the currently supported database types (see SQL Dialect for more details) -
org.jooq.conf.Settings
: An optional runtime configuration (see Custom Settings for more details) -
org.jooq.ExecuteListenerProvider
: An optional reference to a provider class that can provide execute listeners to jOOQ (see ExecuteListeners for more details) -
org.jooq.RecordListenerProvider
: An optional reference to a provider class that can provide record listeners to jOOQ (see CRUD SPI: RecordListener for more details) -
org.jooq.RecordMapperProvider
: An optional reference to a provider class that can provide record mappers to jOOQ (see for more details) -
Any of these:
-
java.sql.Connection
: An optional JDBC Connection that will be re-used for the whole lifecycle of your Configuration (see Connection vs. DataSource for more details). For simplicity, this is the use-case referenced from this manual, most of the time. -
java.sql.DataSource
: An optional JDBC DataSource that will be re-used for the whole lifecycle of your Configuration. If you prefer using DataSources over Connections, jOOQ will internally fetch new Connections from your DataSource, conveniently closing them again after query execution. This is particularly useful in Java EE or Spring contexts (see Connection vs. DataSource for more details) -
org.jooq.ConnectionProvider
: A custom abstraction that is used by jOOQ to "acquire" and "release" connections. jOOQ will internally "acquire" new Connections from your ConnectionProvider, conveniently "releasing" them again after query execution. (see Connection vs. DataSource for more details)
-
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.
- Connection vs. DataSource
- 3.2.4.
- Custom data
- 3.2.5.
- Custom ExecuteListeners
- 3.2.6.
- Custom Unwrappers (new)
- 3.2.7.
- Custom Settings
- 3.2.7.1.
- Auto-attach Records
- 3.2.7.2.
- Backslash Escaping
- 3.2.7.3.
- Execute Logging
- 3.2.7.4.
- Fetch Warnings
- 3.2.7.5.
- Identifier style
- 3.2.7.6.
- Inline Threshold (new)
- 3.2.7.7.
- IN-list Padding
- 3.2.7.8.
- JDBC Flags
- 3.2.7.9.
- Keyword style
- 3.2.7.10.
- Listener Invocation Order (new)
- 3.2.7.11.
- Locales (new)
- 3.2.7.12.
- Map JPA Annotations
- 3.2.7.13.
- Object qualification
- 3.2.7.14.
- Optimistic Locking
- 3.2.7.15.
- Parameter name prefix (new)
- 3.2.7.16.
- Parameter types
- 3.2.7.17.
- Parser Configuration (new)
- 3.2.7.18.
- Reflection caching
- 3.2.7.19.
- Return all columns on store
- 3.2.7.20.
- Return Identity Value On Store (new)
- 3.2.7.21.
- Runtime schema and table mapping
- 3.2.7.22.
- Scalar subqueries for stored functions
- 3.2.7.23.
- Statement Type
- 3.2.7.24.
- Updatable Primary Keys
- 3.2.8.
- Thread safety
previous : next |
References to this page
- SQL Dialect
- Connection vs. DataSource
- Custom data
- Custom ExecuteListeners
- Auto-attach Records
- Listener Invocation Order
- SQL translator
- Serializability
- RecordMapper
- POJOs
- RecordMapperProvider
- Static statements vs. Prepared Statements
- Sequence execution
- Simple CRUD
- Batch execution
- CRUD SPI: RecordListener
- Transaction management
- ExecuteListeners
- JDBC meta data
- JDBC Connection
- Mocking Connection
- Parsing Connection
- Performance considerations
- jOOQ: Implementing the DSL types
Feedback
Do you have any feedback about this page? We'd love to hear it!