Configuration (jOOQ 3.4.5 API)

All Superinterfaces:

Serializable

All Known Implementing Classes:

DefaultConfiguration
```
public interface Configuration
extends Serializable
```
A Configuration configures a DSLContext, providing it with information for query construction, rendering and execution.
A Configuration wraps all information elements that are needed...
- by a DSLContext to construct Query objects
- 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 itself
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.
Author:

Lukas Eder

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`ConnectionProvider`	`connectionProvider()` Get this configuration's underlying connection provider.
`Map<Object,Object>`	`data()` Get all custom data from this `Configuration`.
`Object`	`data(Object key)` Get some custom data from this `Configuration`.
`Object`	`data(Object key, Object value)` Set some custom data to this `Configuration`.
`Configuration`	`derive()` Create a derived configuration from this one, without changing any properties.
`Configuration`	`derive(ConnectionProvider newConnectionProvider)` Create a derived configuration from this one, with a new connection provider.
`Configuration`	`derive(ExecuteListenerProvider... newExecuteListenerProviders)` Create a derived configuration from this one, with new execute listener providers.
`Configuration`	`derive(RecordListenerProvider... newRecordListenerProviders)` Create a derived configuration from this one, with new record listener providers.
`Configuration`	`derive(RecordMapperProvider newRecordMapperProvider)` Create a derived configuration from this one, with a new record mapper provider.
`Configuration`	`derive(Settings newSettings)` Create a derived configuration from this one, with new settings.
`Configuration`	`derive(SQLDialect newDialect)` Create a derived configuration from this one, with a new dialect.
`Configuration`	`derive(TransactionProvider newTransactionProvider)` Create a derived configuration from this one, with a new transaction provider.
`Configuration`	`derive(VisitListenerProvider... newVisitListenerProviders)` Create a derived configuration from this one, with new visit listener providers.
`SQLDialect`	`dialect()` Retrieve the configured dialect.
`ExecuteListenerProvider[]`	`executeListenerProviders()` Get the configured `ExecuteListenerProvider`s from this configuration.
`RecordListenerProvider[]`	`recordListenerProviders()` Get the configured `RecordListenerProvider`s from this configuration.
`RecordMapperProvider`	`recordMapperProvider()` Get this configuration's underlying record mapper provider.
`SchemaMapping`	`schemaMapping()` Deprecated. - 2.0.5 - Use `settings()` instead
`Configuration`	`set(ConnectionProvider newConnectionProvider)` Change this configuration to hold a new connection provider.
`Configuration`	`set(ExecuteListenerProvider... newExecuteListenerProviders)` Change this configuration to hold a new execute listener providers.
`Configuration`	`set(RecordListenerProvider... newRecordListenerProviders)` Change this configuration to hold a new record listener providers.
`Configuration`	`set(RecordMapperProvider newRecordMapperProvider)` Change this configuration to hold a new record mapper provider.
`Configuration`	`set(Settings newSettings)` Change this configuration to hold a new settings.
`Configuration`	`set(SQLDialect newDialect)` Change this configuration to hold a new dialect.
`Configuration`	`set(TransactionProvider newTransactionProvider)` Change this configuration to hold a new transaction provider.
`Configuration`	`set(VisitListenerProvider... newVisitListenerProviders)` Change this configuration to hold a new visit listener providers.
`Settings`	`settings()` Retrieve the runtime configuration settings.
`TransactionProvider`	`transactionProvider()` Get this configuration's underlying transaction provider.
`VisitListenerProvider[]`	`visitListenerProviders()` TODO [#2667]

- Method Detail
  - data
```
Map<Object,Object> data()
```
    Get all custom data from this Configuration.
    This is custom data that was previously set to the configuration using data(Object, Object). Use custom data if you want to pass data to your custom QueryPart or ExecuteListener objects to be made available at render, bind, execution, fetch time.
    See ExecuteListener for more details.
    
    Returns:
    
    The custom data. This is never null
    
    See Also:
    
    ExecuteListener
  - data
```
Object data(Object key)
```
    Get some custom data from this Configuration.
    This is custom data that was previously set to the configuration using data(Object, Object). Use custom data if you want to pass data to your custom QueryPart or ExecuteListener objects to be made available at render, bind, execution, fetch time.
    See ExecuteListener for more details.
    
    Parameters:
    
    key - A key to identify the custom data
    
    Returns:
    
    The custom data or null if no such data is contained in this Configuration
    
    See Also:
    
    ExecuteListener
  - data
```
Object data(Object key,
            Object value)
```
    Set some custom data to this Configuration.
    Use custom data if you want to pass data to your custom QueryPart or ExecuteListener objects to be made available at render, bind, execution, fetch time.
    Be sure that your custom data implements Serializable if you want to serialise this Configuration or objects referencing this Configuration, e.g. your Record types.
    See ExecuteListener for more details.
    
    Parameters:
    
    key - A key to identify the custom data
    
    value - The custom data
    
    Returns:
    
    The previously set custom data or null if no data was previously set for the given key
    
    See Also:
    
    ExecuteListener
  - connectionProvider
```
ConnectionProvider connectionProvider()
```
    Get this configuration's underlying connection provider.
  - transactionProvider
```
TransactionProvider transactionProvider()
```
    Get this configuration's underlying transaction provider.
    If no explicit transaction provider was specified, and if connectionProvider() is a DefaultConnectionProvider, then this will return a DefaultTransactionProvider.
  - recordMapperProvider
```
RecordMapperProvider recordMapperProvider()
```
    Get this configuration's underlying record mapper provider.
  - recordListenerProviders
```
RecordListenerProvider[] recordListenerProviders()
```
    Get the configured RecordListenerProviders from this configuration.
    This method allows for retrieving the configured RecordListenerProvider from this configuration. The providers will provide jOOQ with RecordListener instances. These instances receive record manipulation notification events every time jOOQ executes queries. jOOQ makes no assumptions about the internal state of these listeners, i.e. listener instances may
    - share this Configuration's lifecycle (i.e. that of a JDBC Connection, or that of a transaction)
    - share the lifecycle of an RecordContext (i.e. that of a single record manipulation)
    - follow an entirely different lifecycle.
    Returns:
    
    The configured set of record listeners.
    
    See Also:
    
    RecordListenerProvider, RecordListener, RecordContext
  - executeListenerProviders
```
ExecuteListenerProvider[] executeListenerProviders()
```
    Get the configured ExecuteListenerProviders from this configuration.
    This method allows for retrieving the configured ExecuteListenerProvider from this configuration. The providers will provide jOOQ with ExecuteListener instances. These instances receive execution lifecycle notification events every time jOOQ executes queries. jOOQ makes no assumptions about the internal state of these listeners, i.e. listener instances may
    - share this Configuration's lifecycle (i.e. that of a JDBC Connection, or that of a transaction)
    - share the lifecycle of an ExecuteContext (i.e. that of a single query execution)
    - follow an entirely different lifecycle.
    Note, depending on your Settings.isExecuteLogging(), some additional listeners may be prepended to this list, internally. Those listeners will never be exposed through this method, though.
    Returns:
    
    The configured set of execute listeners.
    
    See Also:
    
    ExecuteListenerProvider, ExecuteListener, ExecuteContext
  - visitListenerProviders
```
VisitListenerProvider[] visitListenerProviders()
```
    TODO [#2667]
  - schemaMapping
```
@Deprecated
SchemaMapping schemaMapping()
```
    Deprecated. - 2.0.5 - Use settings() instead
    
    Retrieve the configured schema mapping.
  - dialect
```
SQLDialect dialect()
```
    Retrieve the configured dialect.
  - settings
```
Settings settings()
```
    Retrieve the runtime configuration settings.
  - set
```
Configuration set(ConnectionProvider newConnectionProvider)
```
    Change this configuration to hold a new connection provider.
    This method is not thread-safe and should not be used in globally available Configuration objects.
    
    Parameters:
    
    newConnectionProvider - The new connection provider to be contained in the changed configuration.
    
    Returns:
    
    The changed configuration.
  - set
```
Configuration set(TransactionProvider newTransactionProvider)
```
    Change this configuration to hold a new transaction provider.
    This method is not thread-safe and should not be used in globally available Configuration objects.
    
    Parameters:
    
    newTransactionProvider - The new transaction provider to be contained in the changed configuration.
    
    Returns:
    
    The changed configuration.
  - set
```
Configuration set(RecordMapperProvider newRecordMapperProvider)
```
    Change this configuration to hold a new record mapper provider.
    This method is not thread-safe and should not be used in globally available Configuration objects.
    
    Parameters:
    
    newRecordMapperProvider - The new record mapper provider to be contained in the changed configuration.
    
    Returns:
    
    The changed configuration.
  - set
```
Configuration set(RecordListenerProvider... newRecordListenerProviders)
```
    Change this configuration to hold a new record listener providers.
    This method is not thread-safe and should not be used in globally available Configuration objects.
    
    Parameters:
    
    newRecordListenerProviders - The new record listener providers to be contained in the changed configuration.
    
    Returns:
    
    The changed configuration.
  - set
```
Configuration set(ExecuteListenerProvider... newExecuteListenerProviders)
```
    Change this configuration to hold a new execute listener providers.
    This method is not thread-safe and should not be used in globally available Configuration objects.
    
    Parameters:
    
    newExecuteListenerProviders - The new execute listener providers to be contained in the changed configuration.
    
    Returns:
    
    The changed configuration.
  - set
```
Configuration set(VisitListenerProvider... newVisitListenerProviders)
```
    Change this configuration to hold a new visit listener providers.
    This method is not thread-safe and should not be used in globally available Configuration objects.
    
    Parameters:
    
    newVisitListenerProviders - The new visit listener providers to be contained in the changed configuration.
    
    Returns:
    
    The changed configuration.
  - set
```
Configuration set(SQLDialect newDialect)
```
    Change this configuration to hold a new dialect.
    This method is not thread-safe and should not be used in globally available Configuration objects.
    
    Parameters:
    
    newDialect - The new dialect to be contained in the changed configuration.
    
    Returns:
    
    The changed configuration.
  - set
```
Configuration set(Settings newSettings)
```
    Change this configuration to hold a new settings.
    This method is not thread-safe and should not be used in globally available Configuration objects.
    
    Parameters:
    
    newSettings - The new settings to be contained in the changed configuration.
    
    Returns:
    
    The changed configuration.
  - derive
```
Configuration derive()
```
    Create a derived configuration from this one, without changing any properties.
    
    Returns:
    
    The derived configuration.
  - derive
```
Configuration derive(ConnectionProvider newConnectionProvider)
```
    Create a derived configuration from this one, with a new connection provider.
    
    Parameters:
    
    newConnectionProvider - The new connection provider to be contained in the derived configuration.
    
    Returns:
    
    The derived configuration.
  - derive
```
Configuration derive(TransactionProvider newTransactionProvider)
```
    Create a derived configuration from this one, with a new transaction provider.
    
    Parameters:
    
    newTransactionProvider - The new transaction provider to be contained in the derived configuration.
    
    Returns:
    
    The derived configuration.
  - derive
```
Configuration derive(RecordMapperProvider newRecordMapperProvider)
```
    Create a derived configuration from this one, with a new record mapper provider.
    
    Parameters:
    
    newRecordMapperProvider - The new record mapper provider to be contained in the derived configuration.
    
    Returns:
    
    The derived configuration.
  - derive
```
Configuration derive(RecordListenerProvider... newRecordListenerProviders)
```
    Create a derived configuration from this one, with new record listener providers.
    
    Parameters:
    
    newRecordListenerProviders - The new record listener providers to be contained in the derived configuration.
    
    Returns:
    
    The derived configuration.
  - derive
```
Configuration derive(ExecuteListenerProvider... newExecuteListenerProviders)
```
    Create a derived configuration from this one, with new execute listener providers.
    
    Parameters:
    
    newExecuteListenerProviders - The new execute listener providers to be contained in the derived configuration.
    
    Returns:
    
    The derived configuration.
  - derive
```
Configuration derive(VisitListenerProvider... newVisitListenerProviders)
```
    Create a derived configuration from this one, with new visit listener providers.
    
    Parameters:
    
    newVisitListenerProviders - The new visit listener providers to be contained in the derived configuration.
    
    Returns:
    
    The derived configuration.
  - derive
```
Configuration derive(SQLDialect newDialect)
```
    Create a derived configuration from this one, with a new dialect.
    
    Parameters:
    
    newDialect - The new dialect to be contained in the derived configuration.
    
    Returns:
    
    The derived configuration.
  - derive
```
Configuration derive(Settings newSettings)
```
    Create a derived configuration from this one, with new settings.
    
    Parameters:
    
    newSettings - The new settings to be contained in the derived configuration.
    
    Returns:
    
    The derived configuration.

Interface Configuration

Method Summary

Method Detail

data

data

data

connectionProvider

transactionProvider

recordMapperProvider

recordListenerProviders

executeListenerProviders

visitListenerProviders

schemaMapping

dialect

settings

set

set

set

set

set

set

set

set

derive

derive

derive

derive

derive

derive

derive

derive

derive