- All Implemented Interfaces:
Serializable
,Configuration
DSLContext
, if no
custom configuration was supplied to DSL.using(Configuration)
.
The DefaultConfiguration
- Author:
- Lukas Eder
- See Also:
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal CacheProvider
Get this configuration's underlying cache provider.final CharsetProvider
Get the configuredCharsetProvider
from this configuration.final Clock
clock()
Get this configuration'sClock
, which is used for optimistic locking, transaction time, and other time-depending features.final CommitProvider
Get this configuration's underlying commit provider.final io.r2dbc.spi.ConnectionFactory
Get this configuration's underlying R2DBC connection factory.final ConnectionProvider
Get this configuration's underlying connection provider.final ConverterProvider
Get the configuredConverterProvider
from this configuration.final ConcurrentHashMap<Object,
Object> data()
Get all custom data from thisConfiguration
.final Object
Get some custom data from thisConfiguration
.final Object
Set some custom data to thisConfiguration
.final Configuration
derive()
Create a derived configuration from this one, without changing any properties.final Configuration
derive
(io.r2dbc.spi.ConnectionFactory newConnectionFactory) Create a derived configuration from this one, with a new R2DBC connection factory.final Configuration
derive
(Connection newConnection) Create a derived configuration from this one, with a new connection wrapped in aDefaultConnectionProvider
.final Configuration
Create a derived configuration from this one, with a newClock
.final Configuration
Create a derived configuration from this one, with a new executor.final Configuration
derive
(DataSource newDataSource) Create a derived configuration from this one, with a new data source wrapped in aDataSourceConnectionProvider
.final Configuration
derive
(CacheProvider newCacheProvider) Create a derived configuration from this one, with a new cache provider.final Configuration
derive
(CharsetProvider newCharsetProvider) Create a derived configuration from this one, with a new charset provider.final Configuration
derive
(CommitProvider newCommitProvider) Create a derived configuration from this one, with a new commit provider.final Configuration
Create a derived configuration from this one, with new settings.final Configuration
derive
(ConnectionProvider newConnectionProvider) Create a derived configuration from this one, with a new connection provider.final Configuration
derive
(ConverterProvider newConverterProvider) Create a derived configuration from this one, with new converter provider.final Configuration
derive
(DiagnosticsListenerProvider... newDiagnosticsListenerProviders) Create a derived configuration from this one, with new diagnostics listener providers.final Configuration
derive
(ExecuteListenerProvider... newExecuteListenerProviders) Create a derived configuration from this one, with new execute listener providers.final Configuration
derive
(ExecutorProvider newExecutorProvider) Create a derived configuration from this one, with a new executor provider.final Configuration
derive
(FormattingProvider newFormattingProvider) Create a derived configuration from this one, with new formatting provider.final Configuration
derive
(MetaProvider newMetaProvider) Create a derived configuration from this one, with a new meta provider.final Configuration
derive
(MigrationListenerProvider... newMigrationListenerProviders) Create a derived configuration from this one, with new migration listener providers.final Configuration
derive
(ParseListenerProvider... newParseListenerProviders) Create a derived configuration from this one, with new parse listener providers.final Configuration
derive
(RecordListenerProvider... newRecordListenerProviders) Create a derived configuration from this one, with new record listener providers.final Configuration
derive
(RecordMapper<?, ?> newRecordMapper) Create a derived configuration from this one, with a new record mapper.final Configuration
derive
(RecordMapperProvider newRecordMapperProvider) Create a derived configuration from this one, with a new record mapper provider.final Configuration
derive
(RecordUnmapper<?, ?> newRecordUnmapper) Create a derived configuration from this one, with a new record unmapper.final Configuration
derive
(RecordUnmapperProvider newRecordUnmapperProvider) Create a derived configuration from this one, with a new record unmapper provider.final Configuration
derive
(SQLDialect newDialect) Create a derived configuration from this one, with a new dialect.final Configuration
derive
(TransactionListenerProvider... newTransactionListenerProviders) Create a derived configuration from this one, with new transaction listener providers.final Configuration
derive
(TransactionProvider newTransactionProvider) Create a derived configuration from this one, with a new transaction provider.final Configuration
Create a derived configuration from this one, with a new unwrapper.final Configuration
derive
(UnwrapperProvider newUnwrapperProvider) Create a derived configuration from this one, with a new unwrapper provider.final Configuration
derive
(VisitListenerProvider... newVisitListenerProviders) Create a derived configuration from this one, with new visit listener providers.final Configuration
deriveSettings
(Function<? super Settings, ? extends Settings> newSettings) Create a derived configuration from this one, with new settings constructed from a clone of the current settings.final DiagnosticsListenerProvider[]
Get the configuredDiagnosticsListenerProvider
s from this configuration.final SQLDialect
dialect()
Retrieve the configured dialect.final DSLContext
dsl()
Wrap thisConfiguration
in aDSLContext
, providing access to the configuration-contextual DSL to construct executable queries.final ExecuteListenerProvider[]
Get the configuredExecuteListenerProvider
s from this configuration.final ExecutorProvider
Get this configuration's underlying executor provider.final SQLDialect
family()
Retrieve the family of the configured dialect.final FormattingProvider
Get the configuredFormattingProvider
from this configuration.final ConnectionProvider
Get this configuration's underlying interpreter connection provider, which provides connections for DDL interpretation.final MetaProvider
Get this configuration's underlying meta provider.final MigrationListenerProvider[]
Get the configuredMigrationListenerProvider
s from this configuration.final ParseListenerProvider[]
Get the configuredParseListenerProvider
instances from this configuration.final RecordListenerProvider[]
Get the configuredRecordListenerProvider
s from this configuration.final RecordMapperProvider
Get this configuration's underlying record mapper provider.final RecordUnmapperProvider
Get this configuration's underlying record unmapper provider.final SchemaMapping
Deprecated.final Configuration
set
(io.r2dbc.spi.ConnectionFactory newConnectionFactory) Change this configuration to hold a new R2DBC connection factory.final Configuration
set
(Connection newConnection) Change this configuration to hold a new connection wrapped in aDefaultConnectionProvider
.final Configuration
Change this configuration to hold a newClock
.final Configuration
Change this configuration to hold a new executor.final Configuration
set
(DataSource newDataSource) Change this configuration to hold a new data source wrapped in aDataSourceConnectionProvider
.final Configuration
set
(CacheProvider newCacheProvider) Change this configuration to hold a new cache provider.final Configuration
set
(CharsetProvider newCharsetProvider) Change this configuration to hold a new charset provider.final Configuration
set
(CommitProvider newCommitProvider) Change this configuration to hold a new commit provider.final Configuration
Change this configuration to hold a new settings.final Configuration
set
(ConnectionProvider newConnectionProvider) Change this configuration to hold a new connection provider.final Configuration
set
(ConverterProvider newConverterProvider) Change this configuration to hold a new converter provider.final Configuration
set
(DiagnosticsListenerProvider... newDiagnosticsListenerProviders) Change this configuration to hold new diagnostics listener providers.final Configuration
set
(ExecuteListenerProvider... newExecuteListenerProviders) Change this configuration to hold new execute listener providers.final Configuration
set
(ExecutorProvider newExecutorProvider) Change this configuration to hold a new executor provider.final Configuration
set
(FormattingProvider newFormattingProvider) Change this configuration to hold a new formatting provider.final Configuration
set
(MetaProvider newMetaProvider) Change this configuration to hold a new meta provider.final Configuration
set
(MigrationListenerProvider... newMigrationListenerProviders) Change this configuration to hold new migration listener providers.final Configuration
set
(ParseListenerProvider... newParseListenerProviders) Change this configuration to hold new parse listener providers.final Configuration
set
(RecordListenerProvider... newRecordListenerProviders) Change this configuration to hold new record listener providers.final Configuration
set
(RecordMapper<?, ?> newRecordMapper) Change this configuration to hold a new record mapper.final Configuration
set
(RecordMapperProvider newRecordMapperProvider) Change this configuration to hold a new record mapper provider.final Configuration
set
(RecordUnmapper<?, ?> newRecordUnmapper) Change this configuration to hold a new record unmapper.final Configuration
set
(RecordUnmapperProvider newRecordUnmapperProvider) Change this configuration to hold a new record unmapper provider.final Configuration
set
(SQLDialect newDialect) Change this configuration to hold a new dialect.final Configuration
set
(TransactionListenerProvider... newTransactionListenerProviders) Change this configuration to hold new transaction listener providers.final Configuration
set
(TransactionProvider newTransactionProvider) Change this configuration to hold a new transaction provider.final Configuration
Change this configuration to hold a new unwrapper.final Configuration
set
(UnwrapperProvider newUnwrapperProvider) Change this configuration to hold a new unwrapper provider.final Configuration
set
(VisitListenerProvider... newVisitListenerProviders) Change this configuration to hold new visit listener providers.final void
setCacheProvider
(CacheProvider newCacheProvider) final void
final void
setConnection
(Connection newConnection) final void
setConnectionFactory
(io.r2dbc.spi.ConnectionFactory newConnectionFactory) final void
setConnectionProvider
(ConnectionProvider newConnectionProvider) final void
setDataSource
(DataSource newDataSource) final void
setDiagnosticsListener
(DiagnosticsListener... newDiagnosticsListener) final void
setDiagnosticsListenerProvider
(DiagnosticsListenerProvider... newDiagnosticsListenerProviders) final void
setExecuteListener
(ExecuteListener... newExecuteListeners) final void
setExecuteListenerProvider
(ExecuteListenerProvider... newExecuteListenerProviders) final void
setExecutor
(Executor newExecutor) final void
setExecutorProvider
(ExecutorProvider newExecutorProvider) final void
setInterpreterConnectionProvider
(ConnectionProvider newInterpreterConnectionProvider) final void
setMetaProvider
(MetaProvider newMetaProvider) final void
setParseListener
(ParseListener... newParseListener) final void
setParseListenerProvider
(ParseListenerProvider... newParseListenerProviders) final void
setRecordListener
(RecordListener... newRecordListeners) final void
setRecordListenerProvider
(RecordListenerProvider... newRecordListenerProviders) final void
setRecordMapper
(RecordMapper<?, ?> newRecordMapper) final void
setRecordMapperProvider
(RecordMapperProvider newRecordMapperProvider) final void
setRecordUnmapper
(RecordUnmapper<?, ?> newRecordUnmapper) final void
setRecordUnmapperProvider
(RecordUnmapperProvider newRecordUnmapperProvider) final void
setSettings
(Settings newSettings) final void
setSQLDialect
(SQLDialect newDialect) final void
setSystemConnectionProvider
(ConnectionProvider newSystemConnectionProvider) final Settings
settings()
Retrieve the runtime configuration settings.final void
setTransactionListener
(TransactionListener... newTransactionListeners) final void
setTransactionListenerProvider
(TransactionListenerProvider... newTransactionListenerProviders) final void
setTransactionProvider
(TransactionProvider newTransactionProvider) final void
setUnwrapper
(Unwrapper newUnwrapper) final void
setUnwrapperProvider
(UnwrapperProvider newUnwrapperProvider) final void
setVersionProvider
(CommitProvider newCommitProvider) final void
setVisitListener
(VisitListener... newVisitListeners) final void
setVisitListenerProvider
(VisitListenerProvider... newVisitListenerProviders) final ConnectionProvider
Get this configuration's underlying system connection provider, which provides connections for system tasks.toString()
final TransactionListenerProvider[]
Get the configuredTransactionListenerProvider
s from this configuration.final TransactionProvider
Get this configuration's underlying transaction provider.final UnwrapperProvider
Get the configuredUnwrapperProvider
from this configuration.final VisitListenerProvider[]
Get the configuredVisitListenerProvider
instances from this configuration.Methods inherited from class org.jooq.impl.AbstractConfiguration
commercial, derive, derive, derive, derive, derive, derive, derive, deriveAppending, deriveAppending, deriveAppending, deriveAppending, deriveAppending, deriveAppending, deriveAppending, deriveAppending, deriveAppending, deriveAppending, deriveAppending, deriveAppending, deriveAppending, deriveAppending, requireCommercial, set, set, set, set, set, set, set, setAppending, setAppending, setAppending, setAppending, setAppending, setAppending, setAppending, setAppending, setAppending, setAppending, setAppending, setAppending, setAppending, setAppending
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.jooq.Configuration
commercial
-
Constructor Details
-
DefaultConfiguration
public DefaultConfiguration()Create a new configuration object.
-
-
Method Details
-
dsl
Description copied from interface:Configuration
Wrap thisConfiguration
in aDSLContext
, providing access to the configuration-contextual DSL to construct executable queries.In the
DefaultConfiguration
implementation, this is just convenience forDSL.using(Configuration)
. There's no functional difference between the two methods. -
derive
Description copied from interface:Configuration
Create a derived configuration from this one, without changing any properties.- Returns:
- The derived configuration.
-
derive
Description copied from interface:Configuration
Create a derived configuration from this one, with a new connection wrapped in aDefaultConnectionProvider
.- Parameters:
newConnection
- The new connection to be contained in the derived configuration.- Returns:
- The derived configuration.
-
derive
Description copied from interface:Configuration
Create a derived configuration from this one, with a new data source wrapped in aDataSourceConnectionProvider
.- Parameters:
newDataSource
- The new data source to be contained in the derived configuration.- Returns:
- The derived configuration.
-
derive
Description copied from interface:Configuration
Create a derived configuration from this one, with a new R2DBC connection factory.- Parameters:
newConnectionFactory
- The new connection factory to be contained in the derived configuration.- Returns:
- The derived configuration.
-
derive
Description copied from interface:Configuration
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
Description copied from interface:Configuration
Create a derived configuration from this one, with a new meta provider.- Parameters:
newMetaProvider
- The new meta provider to be contained in the derived configuration.- Returns:
- The derived configuration.
-
derive
Description copied from interface:Configuration
Create a derived configuration from this one, with a new commit provider.- Parameters:
newCommitProvider
- The new commit provider to be contained in the derived configuration.- Returns:
- The derived configuration.
-
derive
Description copied from interface:Configuration
Create a derived configuration from this one, with a new executor.This will wrap the argument
Executor
in aDefaultExecutorProvider
for convenience.- Parameters:
newExecutor
- The new executor to be contained in the derived configuration.- Returns:
- The derived configuration.
-
derive
Description copied from interface:Configuration
Create a derived configuration from this one, with a new executor provider.- Parameters:
newExecutorProvider
- The new executor provider to be contained in the derived configuration.- Returns:
- The derived configuration.
-
derive
Description copied from interface:Configuration
Create a derived configuration from this one, with a new cache provider.- Parameters:
newCacheProvider
- The new cache provider to be contained in the derived configuration.- Returns:
- The derived configuration.
-
derive
Description copied from interface:Configuration
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
Description copied from interface:Configuration
Create a derived configuration from this one, with a new record mapper.This will wrap the argument
RecordMapper
in aDefaultRecordMapperProvider
for convenience.- Parameters:
newRecordMapper
- The new record mapper to be contained in the derived configuration.- Returns:
- The derived configuration.
-
derive
Description copied from interface:Configuration
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
Description copied from interface:Configuration
Create a derived configuration from this one, with a new record unmapper.This will wrap the argument
RecordUnmapper
in aDefaultRecordUnmapperProvider
for convenience.- Parameters:
newRecordUnmapper
- The new record unmapper to be contained in the derived configuration.- Returns:
- The derived configuration.
-
derive
Description copied from interface:Configuration
Create a derived configuration from this one, with a new record unmapper provider.- Parameters:
newRecordUnmapperProvider
- The new record unmapper provider to be contained in the derived configuration.- Returns:
- The derived configuration.
-
derive
Description copied from interface:Configuration
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
Description copied from interface:Configuration
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
Description copied from interface:Configuration
Create a derived configuration from this one, with new migration listener providers.- Parameters:
newMigrationListenerProviders
- The new migration listener providers to be contained in the derived configuration.- Returns:
- The derived configuration.
-
derive
Description copied from interface:Configuration
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
Description copied from interface:Configuration
Create a derived configuration from this one, with new transaction listener providers.- Parameters:
newTransactionListenerProviders
- The new transaction listener providers to be contained in the derived configuration.- Returns:
- The derived configuration.
-
derive
Description copied from interface:Configuration
Create a derived configuration from this one, with new diagnostics listener providers.- Parameters:
newDiagnosticsListenerProviders
- The new diagnostics listener providers to be contained in the derived configuration.- Returns:
- The derived configuration.
-
derive
Description copied from interface:Configuration
Create a derived configuration from this one, with a new unwrapper.- Parameters:
newUnwrapper
- The new unwrapper to be contained in the derived configuration.- Returns:
- The derived configuration.
-
derive
Description copied from interface:Configuration
Create a derived configuration from this one, with a new unwrapper provider.- Parameters:
newUnwrapperProvider
- The new unwrapper provider to be contained in the derived configuration.- Returns:
- The derived configuration.
-
derive
Description copied from interface:Configuration
Create a derived configuration from this one, with a new charset provider.- Parameters:
newCharsetProvider
- The new charset provider to be contained in the derived configuration.- Returns:
- The derived configuration.
-
derive
Description copied from interface:Configuration
Create a derived configuration from this one, with new converter provider.- Parameters:
newConverterProvider
- The new converter provider to be contained in the derived configuration.- Returns:
- The derived configuration.
-
derive
Description copied from interface:Configuration
Create a derived configuration from this one, with new formatting provider.- Parameters:
newFormattingProvider
- The new formatting provider to be contained in the derived configuration.- Returns:
- The derived configuration.
-
derive
Description copied from interface:Configuration
Create a derived configuration from this one, with new parse listener providers.- Parameters:
newParseListenerProviders
- The new parse listener providers to be contained in the derived configuration.- Returns:
- The derived configuration.
-
derive
Description copied from interface:Configuration
Create a derived configuration from this one, with a newClock
.- Parameters:
newClock
- The new clock to be contained in the derived configuration.- Returns:
- The derived configuration.
-
derive
Description copied from interface:Configuration
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
Description copied from interface:Configuration
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.
-
deriveSettings
public final Configuration deriveSettings(Function<? super Settings, ? extends Settings> newSettings) Description copied from interface:Configuration
Create a derived configuration from this one, with new settings constructed from a clone of the current settings.- Parameters:
newSettings
- A function producing the new settings to be contained in the derived configuration based on a clone of the current settings.- Returns:
- The derived configuration.
-
set
Description copied from interface:Configuration
Change this configuration to hold a new connection wrapped in aDefaultConnectionProvider
.This method is not thread-safe and should not be used in globally available
Configuration
objects.- Parameters:
newConnection
- The new connection to be contained in the changed configuration.- Returns:
- The changed configuration.
-
set
Description copied from interface:Configuration
Change this configuration to hold a new data source wrapped in aDataSourceConnectionProvider
.This method is not thread-safe and should not be used in globally available
Configuration
objects.- Parameters:
newDataSource
- The new data source to be contained in the changed configuration.- Returns:
- The changed configuration.
-
set
Description copied from interface:Configuration
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
Description copied from interface:Configuration
Change this configuration to hold a new R2DBC connection factory.This method is not thread-safe and should not be used in globally available
Configuration
objects.- Returns:
- The changed configuration.
-
set
Description copied from interface:Configuration
Change this configuration to hold a new meta provider.This method is not thread-safe and should not be used in globally available
Configuration
objects.- Parameters:
newMetaProvider
- The new meta provider to be contained in the changed configuration.- Returns:
- The changed configuration.
-
set
Description copied from interface:Configuration
Change this configuration to hold a new commit provider.This method is not thread-safe and should not be used in globally available
Configuration
objects.- Parameters:
newCommitProvider
- The new commit provider to be contained in the changed configuration.- Returns:
- The changed configuration.
-
set
Description copied from interface:Configuration
Change this configuration to hold a new executor.This will wrap the argument
Executor
in aDefaultExecutorProvider
for convenience.This method is not thread-safe and should not be used in globally available
Configuration
objects.- Parameters:
newExecutor
- The new executor to be contained in the changed configuration.- Returns:
- The changed configuration.
-
set
Description copied from interface:Configuration
Change this configuration to hold a new executor provider.This method is not thread-safe and should not be used in globally available
Configuration
objects.- Parameters:
newExecutorProvider
- The new executor provider to be contained in the changed configuration.- Returns:
- The changed configuration.
-
set
Description copied from interface:Configuration
Change this configuration to hold a new cache provider.This method is not thread-safe and should not be used in globally available
Configuration
objects.- Parameters:
newCacheProvider
- The new cache provider to be contained in the changed configuration.- Returns:
- The changed configuration.
-
set
Description copied from interface:Configuration
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
Description copied from interface:Configuration
Change this configuration to hold a new record mapper.This will wrap the argument
RecordMapper
in aDefaultRecordMapperProvider
for convenience.This method is not thread-safe and should not be used in globally available
Configuration
objects.- Parameters:
newRecordMapper
- The new record mapper to be contained in the changed configuration.- Returns:
- The changed configuration.
-
set
Description copied from interface:Configuration
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
Description copied from interface:Configuration
Change this configuration to hold a new record unmapper.This will wrap the argument
RecordUnmapper
in aDefaultRecordUnmapperProvider
for convenience.This method is not thread-safe and should not be used in globally available
Configuration
objects.- Parameters:
newRecordUnmapper
- The new record unmapper to be contained in the changed configuration.- Returns:
- The changed configuration.
-
set
Description copied from interface:Configuration
Change this configuration to hold a new record unmapper provider.This method is not thread-safe and should not be used in globally available
Configuration
objects.- Parameters:
newRecordUnmapperProvider
- The new record unmapper provider to be contained in the changed configuration.- Returns:
- The changed configuration.
-
set
Description copied from interface:Configuration
Change this configuration to hold 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
Description copied from interface:Configuration
Change this configuration to hold 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
Description copied from interface:Configuration
Change this configuration to hold new migration listener providers.This method is not thread-safe and should not be used in globally available
Configuration
objects.- Parameters:
newMigrationListenerProviders
- The new migration listener providers to be contained in the changed configuration.- Returns:
- The changed configuration.
-
set
Description copied from interface:Configuration
Change this configuration to hold 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
Description copied from interface:Configuration
Change this configuration to hold new transaction listener providers.This method is not thread-safe and should not be used in globally available
Configuration
objects.- Parameters:
newTransactionListenerProviders
- The new transaction listener providers to be contained in the changed configuration.- Returns:
- The changed configuration.
-
set
Description copied from interface:Configuration
Change this configuration to hold new diagnostics listener providers.This method is not thread-safe and should not be used in globally available
Configuration
objects.- Parameters:
newDiagnosticsListenerProviders
- The new diagnostics listener providers to be contained in the changed configuration.- Returns:
- The changed configuration.
-
set
Description copied from interface:Configuration
Change this configuration to hold a new unwrapper.This method is not thread-safe and should not be used in globally available
Configuration
objects.- Parameters:
newUnwrapper
- The new unwrapper to be contained in the changed configuration.- Returns:
- The changed configuration.
-
set
Description copied from interface:Configuration
Change this configuration to hold a new unwrapper provider.This method is not thread-safe and should not be used in globally available
Configuration
objects.- Parameters:
newUnwrapperProvider
- The new unwrapper provider to be contained in the changed configuration.- Returns:
- The changed configuration.
-
set
Description copied from interface:Configuration
Change this configuration to hold a new charset provider.This method is not thread-safe and should not be used in globally available
Configuration
objects.- Parameters:
newCharsetProvider
- The new charset provider to be contained in the changed configuration.- Returns:
- The changed configuration.
-
set
Description copied from interface:Configuration
Change this configuration to hold a new converter provider.This method is not thread-safe and should not be used in globally available
Configuration
objects.- Parameters:
newConverterProvider
- The new converter provider to be contained in the changed configuration.- Returns:
- The changed configuration.
-
set
Description copied from interface:Configuration
Change this configuration to hold a new formatting provider.This method is not thread-safe and should not be used in globally available
Configuration
objects.- Parameters:
newFormattingProvider
- The new formatting provider to be contained in the changed configuration.- Returns:
- The changed configuration.
-
set
Description copied from interface:Configuration
Change this configuration to hold new parse listener providers.This method is not thread-safe and should not be used in globally available
Configuration
objects.- Parameters:
newParseListenerProviders
- The new parse listener providers to be contained in the changed configuration.- Returns:
- The changed configuration.
-
set
Description copied from interface:Configuration
Change this configuration to hold a newClock
.This method is not thread-safe and should not be used in globally available
Configuration
objects.- Parameters:
newClock
- The new clock to be contained in the changed configuration.- Returns:
- The changed configuration.
-
set
Description copied from interface:Configuration
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
Description copied from interface:Configuration
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.
-
setConnection
- See Also:
-
setDataSource
- See Also:
-
setConnectionFactory
public final void setConnectionFactory(io.r2dbc.spi.ConnectionFactory newConnectionFactory) - See Also:
-
setConnectionProvider
- See Also:
-
setInterpreterConnectionProvider
public final void setInterpreterConnectionProvider(ConnectionProvider newInterpreterConnectionProvider) - See Also:
-
setSystemConnectionProvider
- See Also:
-
setMetaProvider
- See Also:
-
setVersionProvider
- See Also:
-
setExecutor
- See Also:
-
setExecutorProvider
- See Also:
-
setCacheProvider
- See Also:
-
setTransactionProvider
- See Also:
-
setRecordMapper
- See Also:
-
setRecordMapperProvider
- See Also:
-
setRecordUnmapper
- See Also:
-
setRecordUnmapperProvider
- See Also:
-
setRecordListener
-
setRecordListenerProvider
- See Also:
-
setExecuteListener
-
setExecuteListenerProvider
public final void setExecuteListenerProvider(ExecuteListenerProvider... newExecuteListenerProviders) - See Also:
-
setVisitListener
-
setVisitListenerProvider
- See Also:
-
setTransactionListener
-
setTransactionListenerProvider
public final void setTransactionListenerProvider(TransactionListenerProvider... newTransactionListenerProviders) - See Also:
-
setDiagnosticsListener
-
setDiagnosticsListenerProvider
public final void setDiagnosticsListenerProvider(DiagnosticsListenerProvider... newDiagnosticsListenerProviders) - See Also:
-
setParseListener
-
setParseListenerProvider
- See Also:
-
setUnwrapper
- See Also:
-
setUnwrapperProvider
- See Also:
-
setClock
- See Also:
-
setSQLDialect
- See Also:
-
setSettings
- See Also:
-
connectionProvider
Description copied from interface:Configuration
Get this configuration's underlying connection provider. -
interpreterConnectionProvider
Description copied from interface:Configuration
Get this configuration's underlying interpreter connection provider, which provides connections for DDL interpretation.- See Also:
-
systemConnectionProvider
Description copied from interface:Configuration
Get this configuration's underlying system connection provider, which provides connections for system tasks.System tasks may include the generation of auxiliary data types or stored procedures, which users may want to generate using a different data source or transaction. By default, this connection provider is the same as
Configuration.connectionProvider()
. -
connectionFactory
public final io.r2dbc.spi.ConnectionFactory connectionFactory()Description copied from interface:Configuration
Get this configuration's underlying R2DBC connection factory. -
metaProvider
Description copied from interface:Configuration
Get this configuration's underlying meta provider. -
commitProvider
Description copied from interface:Configuration
Get this configuration's underlying commit provider. -
executorProvider
Description copied from interface:Configuration
Get this configuration's underlying executor provider.Asynchronous operations will call back to this SPI to obtain an executor. This applies, for example, to
ResultQuery.fetchAsync()
.The following logic is applied when resolving the appropriate
executor
:- If
Configuration.executorProvider()
does not returnnull
, thenExecutorProvider.provide()
is called to obtain anExecutor
for the asynchronous task. - In the jOOQ Java 8 distribution,
ForkJoinPool.commonPool()
is used ifForkJoinPool.getCommonPoolParallelism()
> 1 - A new "one thread per call"
Executor
is used in any other case.
The SPI will not be called if an asynchronous operation explicitly overrides the
Executor
, e.g. as is the case forResultQuery.fetchAsync(Executor)
. - If
-
cacheProvider
Description copied from interface:Configuration
Get this configuration's underlying cache provider.Cached operations will call this SPI to obtain a thread safe cache implementation to cache various things internally. This SPI allows for replacing the default cache implementation, which is mostly a
ConcurrentHashMap
, by a more specialised one, e.g. a LRU cache, e.g. from Guava. -
transactionProvider
Description copied from interface:Configuration
Get this configuration's underlying transaction provider.If no explicit transaction provider was specified, and if
Configuration.connectionProvider()
is aDefaultConnectionProvider
, then this will return aDefaultTransactionProvider
. -
recordMapperProvider
Description copied from interface:Configuration
Get this configuration's underlying record mapper provider. -
recordUnmapperProvider
Description copied from interface:Configuration
Get this configuration's underlying record unmapper provider. -
recordListenerProviders
Description copied from interface:Configuration
Get the configuredRecordListenerProvider
s from this configuration.This method allows for retrieving the configured
RecordListenerProvider
from this configuration. The providers will provide jOOQ withRecordListener
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 JDBCConnection
, 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:
- share this
-
executeListenerProviders
Description copied from interface:Configuration
Get the configuredExecuteListenerProvider
s from this configuration.This method allows for retrieving the configured
ExecuteListenerProvider
from this configuration. The providers will provide jOOQ withExecuteListener
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 JDBCConnection
, 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:
- share this
-
migrationListenerProviders
Description copied from interface:Configuration
Get the configuredMigrationListenerProvider
s from this configuration.This method allows for retrieving the configured
MigrationListenerProvider
from this configuration. The providers will provide jOOQ withMigrationListener
instances. These instances receive migration lifecycle notification events every time jOOQ executes migrations. 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 JDBCConnection
, or that of a transaction) - share the lifecycle of an
MigrationContext
(i.e. that of a single query execution) - follow an entirely different lifecycle.
- Returns:
- The configured set of migration listeners.
- See Also:
- share this
-
visitListenerProviders
Description copied from interface:Configuration
Get the configuredVisitListenerProvider
instances from this configuration.This method allows for retrieving the configured
VisitListenerProvider
instances from this configuration. The providers will provide jOOQ withVisitListener
instances. These instances receive query rendering lifecycle notification events every time jOOQ renders 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 JDBCConnection
, or that of a transaction) - share the lifecycle of an
ExecuteContext
(i.e. that of a single query execution) - follow an entirely different lifecycle.
- Returns:
- The configured set of visit listeners.
- See Also:
- share this
-
transactionListenerProviders
Description copied from interface:Configuration
Get the configuredTransactionListenerProvider
s from this configuration. -
diagnosticsListenerProviders
Description copied from interface:Configuration
Get the configuredDiagnosticsListenerProvider
s from this configuration. -
unwrapperProvider
Description copied from interface:Configuration
Get the configuredUnwrapperProvider
from this configuration. -
charsetProvider
Description copied from interface:Configuration
Get the configuredCharsetProvider
from this configuration. -
converterProvider
Description copied from interface:Configuration
Get the configuredConverterProvider
from this configuration. -
formattingProvider
Description copied from interface:Configuration
Get the configuredFormattingProvider
from this configuration. -
parseListenerProviders
Description copied from interface:Configuration
Get the configuredParseListenerProvider
instances from this configuration. -
clock
Description copied from interface:Configuration
Get this configuration'sClock
, which is used for optimistic locking, transaction time, and other time-depending features. -
dialect
Description copied from interface:Configuration
Retrieve the configured dialect. -
family
Description copied from interface:Configuration
Retrieve the family of the configured dialect. -
settings
Description copied from interface:Configuration
Retrieve the runtime configuration settings. -
data
Description copied from interface:Configuration
Get all custom data from thisConfiguration
.This is custom data that was previously set to the configuration using
Configuration.data(Object, Object)
. Use custom data if you want to pass data to your customQueryPart
orExecuteListener
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:
-
data
Description copied from interface:Configuration
Get some custom data from thisConfiguration
.This is custom data that was previously set to the configuration using
Configuration.data(Object, Object)
. Use custom data if you want to pass data to your customQueryPart
orExecuteListener
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 thisConfiguration
- See Also:
-
data
Description copied from interface:Configuration
Set some custom data to thisConfiguration
.Use custom data if you want to pass data to your custom
QueryPart
orExecuteListener
objects to be made available at render, bind, execution, fetch time.Be sure that your custom data implements
Serializable
if you want to serialise thisConfiguration
or objects referencing thisConfiguration
, e.g. yourRecord
types.See
ExecuteListener
for more details.- Parameters:
key
- A key to identify the custom datavalue
- The custom data- Returns:
- The previously set custom data or
null
if no data was previously set for the given key - See Also:
-
schemaMapping
Deprecated.Description copied from interface:Configuration
Retrieve the configured schema mapping. -
toString
-