org.jooq

Interface Configuration

All Superinterfaces:

Serializable

All Known Implementing Classes:

DefaultConfiguration, MockConfiguration

public interface Configuration
extends Serializable

A Configuration configures a DSLContext, providing it with information for query rendering and execution.

A Configuration wraps all information elements that are needed...

• by a RenderContext to render Query objects and QueryParts
• by a BindContext to bind values to Query objects and QueryParts
• by a Query or Routine object to execute themselves

The simplest usage of a Configuration instance is to use it exactly for a single Query execution, disposing it immediately. This will make it very simple to implement thread-safe behaviour.

At the same time, jOOQ does not require Configuration instances to be that short-lived. Thread-safety will then be delegated to component objects, such as the ConnectionProvider, the ExecuteListener list, etc.

A Configuration is composed of types composing its state and of SPIs:

Types composing its state:

• dialect(): The SQLDialect that defines the underlying database's behaviour when generating SQL syntax, or bind variables, or when executing the query
• settings(): The Settings that define general jOOQ behaviour
• data(): A Map containing user-defined data for the Scope of this configuration.

SPIs:

• connectionProvider(): The ConnectionProvider that defines the semantics of ConnectionProvider.acquire() and ConnectionProvider.release(Connection) for all queries executed in the context of this Configuration.
  
  jOOQ-provided default implementations include:
  • DefaultConnectionProvider: a non-thread-safe implementation that wraps a single JDBC Connection. Ideal for batch processing.
  • DataSourceConnectionProvider: a possibly thread-safe implementation that wraps a JDBC DataSource. Ideal for use with connection pools, Java EE, or Spring.
• transactionProvider(): The TransactionProvider that defines and implements the behaviour of the DSLContext.transaction(TransactionalRunnable) and DSLContext.transactionResult(TransactionalCallable) methods.
  
  jOOQ-provided default implementations include:
  • DefaultTransactionProvider: an implementation backed by JDBC directly, via Connection.commit(), Connection.rollback(), and Connection.rollback(Savepoint) for nested transactions.
• recordMapperProvider(): The RecordMapperProvider that defines and implements the behaviour of Record.into(Class), ResultQuery.fetchInto(Class), Cursor.fetchInto(Class), and various related methods.
  
  jOOQ-provided default implementations include:
  • DefaultRecordMapperProvider: an implementation delegating to the DefaultRecordMapper, which implements the most common mapping use-cases.
• recordListenerProviders(): A set of RecordListenerProvider that implement Record fetching and storing lifecycle management, specifically for use with UpdatableRecord.
  
  jOOQ does not provide any implementations.
• executeListenerProviders(): A set of ExecuteListenerProvider that implement Query execution lifecycle management.
  
  jOOQ-provided example implementations include:
  • LoggerListener: generating default query execution log output (active by default)
  • StopWatchListener: generating default query execution speed log output (inactive by default)
• visitListenerProviders(): A set of VisitListenerProvider that implement Query rendering and variable binding lifecycle management, and that are allowed to implement query transformation - e.g. to implement row-level security, or multi-tenancy.
  
  jOOQ does not provide any implementations.

Author:

Lukas Eder