Available in versions: Dev (3.18)

This documentation is for the unreleased development version of jOOQ. Click on the above version links to get this documentation for a supported version of jOOQ.

Diagnostics Connection

Applies to ✅ Open Source Edition   ✅ Express Edition   ✅ Professional Edition   ✅ Enterprise Edition

The diagnosticsConnection setting allows for turning on/off the diagnostics functionality within jOOQ. It has 3 possible values:

  • DEFAULT: By default, the diagnostics functionality is turned off, but can be used explicitly via DSLContext.diagnosticsConnection() or DSLContext.diagnosticsDataSource(). This is ideal when building custom diagnostics utilities on top of jOOQ's SPIs.
  • ON: The diagnostics connection is activated implicitly on any JDBC java.sql.Connection that jOOQ works with. This is ideal when quickly turning on diagnostics on a development or integration test environment.
  • OFF: The diagnostics connection is deactivated even when used explicitly.

Example configuration

Settings settings = new Settings()
    .withDiagnosticsConnection(DiagnosticsConnection.ON); // Defaults to DEFAULT

Feedback

Do you have any feedback about this page? We'd love to hear it!

The jOOQ Logo