Module org.jooq
Package org.jooq.impl

Class DefaultConfiguration

java.lang.Object
org.jooq.impl.AbstractConfiguration
org.jooq.impl.DefaultConfiguration
All Implemented Interfaces:
Serializable, Configuration

public class DefaultConfiguration extends AbstractConfiguration
A default implementation for configurations within a DSLContext, if no custom configuration was supplied to DSL.using(Configuration).

The DefaultConfiguration

Author:
Lukas Eder
See Also:
  • Constructor Details Link icon

    • DefaultConfiguration Link icon

      public DefaultConfiguration()
      Create a new configuration object.
  • Method Details Link icon

    • dsl Link icon

      public final DSLContext dsl()
      Description copied from interface: Configuration
      Wrap this Configuration in a DSLContext, providing access to the configuration-contextual DSL to construct executable queries.

      In the DefaultConfiguration implementation, this is just convenience for DSL.using(Configuration). There's no functional difference between the two methods.

    • derive Link icon

      public final Configuration derive()
      Description copied from interface: Configuration
      Create a derived configuration from this one, without changing any properties.
      Returns:
      The derived configuration.
    • derive Link icon

      public final Configuration derive(Connection newConnection)
      Description copied from interface: Configuration
      Create a derived configuration from this one, with a new connection wrapped in a DefaultConnectionProvider.
      Parameters:
      newConnection - The new connection to be contained in the derived configuration.
      Returns:
      The derived configuration.
    • derive Link icon

      public final Configuration derive(DataSource newDataSource)
      Description copied from interface: Configuration
      Create a derived configuration from this one, with a new data source wrapped in a DataSourceConnectionProvider.
      Parameters:
      newDataSource - The new data source to be contained in the derived configuration.
      Returns:
      The derived configuration.
    • derive Link icon

      public final Configuration derive(io.r2dbc.spi.ConnectionFactory newConnectionFactory)
      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 Link icon

      public final Configuration derive(ConnectionProvider newConnectionProvider)
      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 Link icon

      public final Configuration derive(MetaProvider newMetaProvider)
      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 Link icon

      public final Configuration derive(CommitProvider newCommitProvider)
      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 Link icon

      public final Configuration derive(Executor newExecutor)
      Description copied from interface: Configuration
      Create a derived configuration from this one, with a new executor.

      This will wrap the argument Executor in a DefaultExecutorProvider for convenience.

      Parameters:
      newExecutor - The new executor to be contained in the derived configuration.
      Returns:
      The derived configuration.
    • derive Link icon

      public final Configuration derive(ExecutorProvider newExecutorProvider)
      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 Link icon

      public final Configuration derive(CacheProvider newCacheProvider)
      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 Link icon

      public final Configuration derive(TransactionProvider newTransactionProvider)
      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 Link icon

      public final Configuration derive(ConstructorPropertiesProvider newConstructorPropertiesProvider)
      Description copied from interface: Configuration
      Create a derived configuration from this one, with a new constructor properties provider.
      Parameters:
      newConstructorPropertiesProvider - The new constructor properties provider to be contained in the derived configuration.
      Returns:
      The derived configuration.
    • derive Link icon

      public final Configuration derive(AnnotatedPojoMemberProvider newAnnotatedPojoMemberProvider)
      Description copied from interface: Configuration
      Create a derived configuration from this one, with a new annotated POJO member provider.
      Parameters:
      newAnnotatedPojoMemberProvider - The new annotated POJO member provider to be contained in the derived configuration.
      Returns:
      The derived configuration.
    • derive Link icon

      public final Configuration derive(RecordMapper<?,?> newRecordMapper)
      Description copied from interface: Configuration
      Create a derived configuration from this one, with a new record mapper.

      This will wrap the argument RecordMapper in a DefaultRecordMapperProvider for convenience.

      Parameters:
      newRecordMapper - The new record mapper to be contained in the derived configuration.
      Returns:
      The derived configuration.
    • derive Link icon

      public final Configuration derive(RecordMapperProvider newRecordMapperProvider)
      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 Link icon

      public final Configuration derive(RecordUnmapper<?,?> newRecordUnmapper)
      Description copied from interface: Configuration
      Create a derived configuration from this one, with a new record unmapper.

      This will wrap the argument RecordUnmapper in a DefaultRecordUnmapperProvider for convenience.

      Parameters:
      newRecordUnmapper - The new record unmapper to be contained in the derived configuration.
      Returns:
      The derived configuration.
    • derive Link icon

      public final Configuration derive(RecordUnmapperProvider newRecordUnmapperProvider)
      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 Link icon

      public final Configuration derive(RecordListenerProvider... newRecordListenerProviders)
      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 Link icon

      public final Configuration derive(ExecuteListenerProvider... newExecuteListenerProviders)
      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 Link icon

      public final Configuration derive(MigrationListenerProvider... newMigrationListenerProviders)
      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 Link icon

      public final Configuration derive(VisitListenerProvider... newVisitListenerProviders)
      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 Link icon

      public final Configuration derive(TransactionListenerProvider... newTransactionListenerProviders)
      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 Link icon

      public final Configuration derive(DiagnosticsListenerProvider... newDiagnosticsListenerProviders)
      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 Link icon

      public final Configuration derive(Unwrapper newUnwrapper)
      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 Link icon

      public final Configuration derive(UnwrapperProvider newUnwrapperProvider)
      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 Link icon

      public final Configuration derive(CharsetProvider newCharsetProvider)
      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 Link icon

      public final Configuration derive(ConverterProvider newConverterProvider)
      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 Link icon

      public final Configuration derive(FormattingProvider newFormattingProvider)
      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 Link icon

      public final Configuration derive(SubscriberProvider<?> newSubscriberProvider)
      Description copied from interface: Configuration
      Create a derived configuration from this one, with a new subscriber provider.
      Parameters:
      newSubscriberProvider - The new subscriber provider to be contained in the derived configuration.
      Returns:
      The derived configuration.
    • derive Link icon

      @Pro public final Configuration derive(ParseListenerProvider... newParseListenerProviders)
      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 Link icon

      @Pro public final Configuration derive(AuditProvider newAuditProvider)
      Description copied from interface: Configuration
      Create a derived configuration from this one, with a new audit provider.
      Parameters:
      newAuditProvider - The new audit provider to be contained in the derived configuration.
      Returns:
      The derived configuration.
    • derive Link icon

      @Pro public final Configuration derive(PolicyProvider... newPolicyProviders)
      Description copied from interface: Configuration
      Create a derived configuration from this one, with a new policy provider.
      Parameters:
      newPolicyProviders - The new policy providers to be contained in the derived configuration.
      Returns:
      The derived configuration.
    • derive Link icon

      @Pro public final Configuration derive(TransformProvider newTransformProvider)
      Description copied from interface: Configuration
      Create a derived configuration from this one, with a new transform provider.
      Parameters:
      newTransformProvider - The new transform provider to be contained in the derived configuration.
      Returns:
      The derived configuration.
    • derive Link icon

      public final Configuration derive(Clock newClock)
      Description copied from interface: Configuration
      Create a derived configuration from this one, with a new Clock.
      Parameters:
      newClock - The new clock to be contained in the derived configuration.
      Returns:
      The derived configuration.
    • derive Link icon

      public final Configuration derive(SQLDialect newDialect)
      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 Link icon

      public final Configuration derive(Settings newSettings)
      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 Link icon

      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 Link icon

      public final Configuration set(Connection newConnection)
      Description copied from interface: Configuration
      Change this configuration to hold a new connection wrapped in a DefaultConnectionProvider.

      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 Link icon

      public final Configuration set(DataSource newDataSource)
      Description copied from interface: Configuration
      Change this configuration to hold a new data source wrapped in a DataSourceConnectionProvider.

      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 Link icon

      public final Configuration set(ConnectionProvider newConnectionProvider)
      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 Link icon

      public final Configuration set(io.r2dbc.spi.ConnectionFactory newConnectionFactory)
      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 Link icon

      public final Configuration set(MetaProvider newMetaProvider)
      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 Link icon

      public final Configuration set(CommitProvider newCommitProvider)
      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 Link icon

      public final Configuration set(Executor newExecutor)
      Description copied from interface: Configuration
      Change this configuration to hold a new executor.

      This will wrap the argument Executor in a DefaultExecutorProvider 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 Link icon

      public final Configuration set(ExecutorProvider newExecutorProvider)
      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 Link icon

      public final Configuration set(CacheProvider newCacheProvider)
      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 Link icon

      public final Configuration set(TransactionProvider newTransactionProvider)
      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 Link icon

      public final Configuration set(AnnotatedPojoMemberProvider newAnnotatedPojoMemberProvider)
      Description copied from interface: Configuration
      Change this configuration to hold a new annotated POJO member provider.

      This method is not thread-safe and should not be used in globally available Configuration objects.

      Parameters:
      newAnnotatedPojoMemberProvider - The new annotated POJO member provider to be contained in the changed configuration.
      Returns:
      The changed configuration.
    • set Link icon

      public final Configuration set(ConstructorPropertiesProvider newConstructorPropertiesProvider)
      Description copied from interface: Configuration
      Change this configuration to hold a new constructor properties provider.

      This method is not thread-safe and should not be used in globally available Configuration objects.

      Parameters:
      newConstructorPropertiesProvider - The new constructor properties provider to be contained in the changed configuration.
      Returns:
      The changed configuration.
    • set Link icon

      public final Configuration set(RecordMapper<?,?> newRecordMapper)
      Description copied from interface: Configuration
      Change this configuration to hold a new record mapper.

      This will wrap the argument RecordMapper in a DefaultRecordMapperProvider 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 Link icon

      public final Configuration set(RecordMapperProvider newRecordMapperProvider)
      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 Link icon

      public final Configuration set(RecordUnmapper<?,?> newRecordUnmapper)
      Description copied from interface: Configuration
      Change this configuration to hold a new record unmapper.

      This will wrap the argument RecordUnmapper in a DefaultRecordUnmapperProvider 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 Link icon

      public final Configuration set(RecordUnmapperProvider newRecordUnmapperProvider)
      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 Link icon

      public final Configuration set(RecordListenerProvider... newRecordListenerProviders)
      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 Link icon

      public final Configuration set(ExecuteListenerProvider... newExecuteListenerProviders)
      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 Link icon

      public final Configuration set(MigrationListenerProvider... newMigrationListenerProviders)
      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 Link icon

      public final Configuration set(VisitListenerProvider... newVisitListenerProviders)
      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 Link icon

      public final Configuration set(TransactionListenerProvider... newTransactionListenerProviders)
      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 Link icon

      public final Configuration set(DiagnosticsListenerProvider... newDiagnosticsListenerProviders)
      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 Link icon

      public final Configuration set(Unwrapper newUnwrapper)
      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 Link icon

      public final Configuration set(UnwrapperProvider newUnwrapperProvider)
      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 Link icon

      public final Configuration set(CharsetProvider newCharsetProvider)
      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 Link icon

      public final Configuration set(ConverterProvider newConverterProvider)
      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 Link icon

      public final Configuration set(FormattingProvider newFormattingProvider)
      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 Link icon

      public final Configuration set(SubscriberProvider<?> newSubscriberProvider)
      Description copied from interface: Configuration
      Change this configuration to hold new subscriber provider.

      This method is not thread-safe and should not be used in globally available Configuration objects.

      Parameters:
      newSubscriberProvider - The new subscriber provider to be contained in the changed configuration.
      Returns:
      The changed configuration.
    • set Link icon

      @Pro public final Configuration set(ParseListenerProvider... newParseListenerProviders)
      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 Link icon

      public final Configuration set(AuditProvider newAuditProvider)
      Description copied from interface: Configuration
      Change this configuration to hold new audit provider.

      This method is not thread-safe and should not be used in globally available Configuration objects.

      Parameters:
      newAuditProvider - The new audit provider to be contained in the changed configuration.
      Returns:
      The changed configuration.
    • set Link icon

      public final Configuration set(PolicyProvider... newPolicyProviders)
      Description copied from interface: Configuration
      Change this configuration to hold new policy provider.

      This method is not thread-safe and should not be used in globally available Configuration objects.

      Parameters:
      newPolicyProviders - The new policy provider to be contained in the changed configuration.
      Returns:
      The changed configuration.
    • set Link icon

      public final Configuration set(TransformProvider newTransformProvider)
      Description copied from interface: Configuration
      Change this configuration to hold new transform provider.

      This method is not thread-safe and should not be used in globally available Configuration objects.

      Parameters:
      newTransformProvider - The new transform provider to be contained in the changed configuration.
      Returns:
      The changed configuration.
    • set Link icon

      public final Configuration set(Clock newClock)
      Description copied from interface: Configuration
      Change this configuration to hold a new Clock.

      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 Link icon

      public final Configuration set(SQLDialect newDialect)
      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 Link icon

      public final Configuration set(Settings newSettings)
      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 Link icon

      public final void setConnection(Connection newConnection)
      See Also:
    • setDataSource Link icon

      public final void setDataSource(DataSource newDataSource)
      See Also:
    • setConnectionFactory Link icon

      public final void setConnectionFactory(io.r2dbc.spi.ConnectionFactory newConnectionFactory)
      See Also:
    • setConnectionProvider Link icon

      public final void setConnectionProvider(ConnectionProvider newConnectionProvider)
      See Also:
    • setInterpreterConnectionProvider Link icon

      public final void setInterpreterConnectionProvider(ConnectionProvider newInterpreterConnectionProvider)
      See Also:
    • setSystemConnectionProvider Link icon

      public final void setSystemConnectionProvider(ConnectionProvider newSystemConnectionProvider)
      See Also:
    • setMetaProvider Link icon

      public final void setMetaProvider(MetaProvider newMetaProvider)
      See Also:
    • setVersionProvider Link icon

      public final void setVersionProvider(CommitProvider newCommitProvider)
      See Also:
    • setExecutor Link icon

      public final void setExecutor(Executor newExecutor)
      See Also:
    • setExecutorProvider Link icon

      public final void setExecutorProvider(ExecutorProvider newExecutorProvider)
      See Also:
    • setCacheProvider Link icon

      public final void setCacheProvider(CacheProvider newCacheProvider)
      See Also:
    • setTransactionProvider Link icon

      public final void setTransactionProvider(TransactionProvider newTransactionProvider)
      See Also:
    • setAnnotatedPojoMemberProvider Link icon

      public final void setAnnotatedPojoMemberProvider(AnnotatedPojoMemberProvider newAnnotatedPojoMemberProvider)
      See Also:
    • setConstructorPropertiesProvider Link icon

      public final void setConstructorPropertiesProvider(ConstructorPropertiesProvider newConstructorPropertiesProvider)
      See Also:
    • setRecordMapper Link icon

      public final void setRecordMapper(RecordMapper<?,?> newRecordMapper)
      See Also:
    • setRecordMapperProvider Link icon

      public final void setRecordMapperProvider(RecordMapperProvider newRecordMapperProvider)
      See Also:
    • setRecordUnmapper Link icon

      public final void setRecordUnmapper(RecordUnmapper<?,?> newRecordUnmapper)
      See Also:
    • setRecordUnmapperProvider Link icon

      public final void setRecordUnmapperProvider(RecordUnmapperProvider newRecordUnmapperProvider)
      See Also:
    • setRecordListener Link icon

      public final void setRecordListener(RecordListener... newRecordListeners)
      See Also:
    • setRecordListenerProvider Link icon

      public final void setRecordListenerProvider(RecordListenerProvider... newRecordListenerProviders)
      See Also:
    • setExecuteListener Link icon

      public final void setExecuteListener(ExecuteListener... newExecuteListeners)
      See Also:
    • setExecuteListenerProvider Link icon

      public final void setExecuteListenerProvider(ExecuteListenerProvider... newExecuteListenerProviders)
      See Also:
    • setVisitListener Link icon

      public final void setVisitListener(VisitListener... newVisitListeners)
      See Also:
    • setVisitListenerProvider Link icon

      public final void setVisitListenerProvider(VisitListenerProvider... newVisitListenerProviders)
      See Also:
    • setTransactionListener Link icon

      public final void setTransactionListener(TransactionListener... newTransactionListeners)
      See Also:
    • setTransactionListenerProvider Link icon

      public final void setTransactionListenerProvider(TransactionListenerProvider... newTransactionListenerProviders)
      See Also:
    • setDiagnosticsListener Link icon

      public final void setDiagnosticsListener(DiagnosticsListener... newDiagnosticsListener)
      See Also:
    • setDiagnosticsListenerProvider Link icon

      public final void setDiagnosticsListenerProvider(DiagnosticsListenerProvider... newDiagnosticsListenerProviders)
      See Also:
    • setParseListener Link icon

      @Pro public final void setParseListener(ParseListener... newParseListener)
      See Also:
    • setParseListenerProvider Link icon

      @Pro public final void setParseListenerProvider(ParseListenerProvider... newParseListenerProviders)
      See Also:
    • setAuditProvider Link icon

      @Pro public final void setAuditProvider(AuditProvider newAuditProvider)
      See Also:
    • setPolicyProvider Link icon

      @Pro public final void setPolicyProvider(PolicyProvider newPolicyProvider)
      See Also:
      • invalid reference
        #set(PolicyProvider)
    • setTransformProvider Link icon

      @Pro public final void setTransformProvider(TransformProvider newTransformProvider)
      See Also:
    • setUnwrapper Link icon

      public final void setUnwrapper(Unwrapper newUnwrapper)
      See Also:
    • setUnwrapperProvider Link icon

      public final void setUnwrapperProvider(UnwrapperProvider newUnwrapperProvider)
      See Also:
    • setClock Link icon

      public final void setClock(Clock newClock)
      See Also:
    • setSQLDialect Link icon

      public final void setSQLDialect(SQLDialect newDialect)
      See Also:
    • setSettings Link icon

      public final void setSettings(Settings newSettings)
      See Also:
    • connectionProvider Link icon

      public final ConnectionProvider connectionProvider()
      Description copied from interface: Configuration
      Get this configuration's underlying connection provider.
    • interpreterConnectionProvider Link icon

      public final ConnectionProvider interpreterConnectionProvider()
      Description copied from interface: Configuration
      Get this configuration's underlying interpreter connection provider, which provides connections for DDL interpretation.
      See Also:
    • systemConnectionProvider Link icon

      public final ConnectionProvider 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 Link icon

      public final io.r2dbc.spi.ConnectionFactory connectionFactory()
      Description copied from interface: Configuration
      Get this configuration's underlying R2DBC connection factory.
    • metaProvider Link icon

      public final MetaProvider metaProvider()
      Description copied from interface: Configuration
      Get this configuration's underlying meta provider.
    • commitProvider Link icon

      public final CommitProvider commitProvider()
      Description copied from interface: Configuration
      Get this configuration's underlying commit provider.
    • executorProvider Link icon

      public final ExecutorProvider 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:

      1. If Configuration.executorProvider() does not return null, then ExecutorProvider.provide() is called to obtain an Executor for the asynchronous task.
      2. In the jOOQ Java 8 distribution, ForkJoinPool.commonPool() is used if ForkJoinPool.getCommonPoolParallelism() > 1
      3. 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 for ResultQuery.fetchAsync(Executor).

    • cacheProvider Link icon

      public final CacheProvider 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 Link icon

      public final TransactionProvider 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 a DefaultConnectionProvider, then this will return a DefaultTransactionProvider.

    • annotatedPojoMemberProvider Link icon

      public final AnnotatedPojoMemberProvider annotatedPojoMemberProvider()
      Description copied from interface: Configuration
      Get this configuration's underlying annotated POJO member provider.
    • constructorPropertiesProvider Link icon

      public final ConstructorPropertiesProvider constructorPropertiesProvider()
      Description copied from interface: Configuration
      Get this configuration's underlying constructor properties provider.
    • recordMapperProvider Link icon

      public final RecordMapperProvider recordMapperProvider()
      Description copied from interface: Configuration
      Get this configuration's underlying record mapper provider.
    • recordUnmapperProvider Link icon

      public final RecordUnmapperProvider recordUnmapperProvider()
      Description copied from interface: Configuration
      Get this configuration's underlying record unmapper provider.
    • recordListenerProviders Link icon

      public final RecordListenerProvider[] recordListenerProviders()
      Description copied from interface: Configuration
      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:
    • executeListenerProviders Link icon

      public final ExecuteListenerProvider[] executeListenerProviders()
      Description copied from interface: Configuration
      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:
    • migrationListenerProviders Link icon

      public final MigrationListenerProvider[] migrationListenerProviders()
      Description copied from interface: Configuration
      Get the configured MigrationListenerProviders from this configuration.

      This method allows for retrieving the configured MigrationListenerProvider from this configuration. The providers will provide jOOQ with MigrationListener 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 JDBC Connection, 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:
    • visitListenerProviders Link icon

      public final VisitListenerProvider[] visitListenerProviders()
      Description copied from interface: Configuration
      Get the configured VisitListenerProvider instances from this configuration.

      This method allows for retrieving the configured VisitListenerProvider instances from this configuration. The providers will provide jOOQ with VisitListener 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 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.
      Returns:
      The configured set of visit listeners.
      See Also:
    • transactionListenerProviders Link icon

      public final TransactionListenerProvider[] transactionListenerProviders()
      Description copied from interface: Configuration
      Get the configured TransactionListenerProviders from this configuration.
    • diagnosticsListenerProviders Link icon

      public final DiagnosticsListenerProvider[] diagnosticsListenerProviders()
      Description copied from interface: Configuration
      Get the configured DiagnosticsListenerProviders from this configuration.
    • unwrapperProvider Link icon

      public final UnwrapperProvider unwrapperProvider()
      Description copied from interface: Configuration
      Get the configured UnwrapperProvider from this configuration.
    • charsetProvider Link icon

      public final CharsetProvider charsetProvider()
      Description copied from interface: Configuration
      Get the configured CharsetProvider from this configuration.
    • converterProvider Link icon

      public final ConverterProvider converterProvider()
      Description copied from interface: Configuration
      Get the configured ConverterProvider from this configuration.
    • formattingProvider Link icon

      public final FormattingProvider formattingProvider()
      Description copied from interface: Configuration
      Get the configured FormattingProvider from this configuration.
    • subscriberProvider Link icon

      public final SubscriberProvider<?> subscriberProvider()
      Description copied from interface: Configuration
      Get the configured SubscriberProvider from this configuration.
    • parseListenerProviders Link icon

      public final ParseListenerProvider[] parseListenerProviders()
      Description copied from interface: Configuration
      Get the configured ParseListenerProvider instances from this configuration.
    • auditProvider Link icon

      public final AuditProvider auditProvider()
      Description copied from interface: Configuration
      Get the configured AuditProvider from this configuration.
    • policyProviders Link icon

      public final PolicyProvider[] policyProviders()
      Description copied from interface: Configuration
      Get the configured PolicyProvider instances from this configuration.
    • transformProvider Link icon

      public final TransformProvider transformProvider()
      Description copied from interface: Configuration
      Get the configured TransformProvider from this configuration.
    • clock Link icon

      public final Clock clock()
      Description copied from interface: Configuration
      Get this configuration's Clock, which is used for optimistic locking, transaction time, and other time-depending features.
    • dialect Link icon

      public final SQLDialect dialect()
      Description copied from interface: Configuration
      Retrieve the configured dialect.
    • family Link icon

      public final SQLDialect family()
      Description copied from interface: Configuration
      Retrieve the family of the configured dialect.
    • settings Link icon

      public final Settings settings()
      Description copied from interface: Configuration
      Retrieve the runtime configuration settings.
    • data Link icon

      public final ConcurrentHashMap<Object,Object> data()
      Description copied from interface: Configuration
      Get all custom data from this Configuration.

      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 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:
    • data Link icon

      public final Object data(Object key)
      Description copied from interface: Configuration
      Get some custom data from this Configuration.

      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 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:
    • data Link icon

      public final Object data(Object key, Object value)
      Description copied from interface: Configuration
      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:
    • schemaMapping Link icon

      @Deprecated public final SchemaMapping schemaMapping()
      Deprecated.
      Description copied from interface: Configuration
      Retrieve the configured schema mapping.
    • toString Link icon

      public String toString()
      Overrides:
      toString in class Object