Module org.jooq
Package org.jooq

Interface DiagnosticsContext

All Superinterfaces:
Scope
public interface DiagnosticsContext extends Scope
A parameter object that is passed to DiagnosticsListener methods.
Author:
Lukas Eder

  • Method Details

    • part

      @Nullable @Nullable QueryPart part()
      The object that was diagnosed if available, or null, if there was no specific QueryPart to attach the diagnostic to.

    • transformedPart

      @Nullable @Nullable QueryPart transformedPart()
      The transformed object from part() if available, or null, if there was no specific transformation to attach the diagnostic to.

      This helps diagnosing pattern transformations as indicated by DiagnosticsListener.transformPattern(DiagnosticsContext).

    • message

      @NotNull @NotNull String message()
      A message describing the diagnostics and the object in question.

    • resultSet

      @Nullable @Nullable ResultSet resultSet()
      The ResultSet available in this context, or null, if there was no result set.

    • resultSetConsumedRows

      int resultSetConsumedRows()
      The number of rows that were consumed from resultSet(), or -1 if there was no result set.

    • resultSetFetchedRows

      int resultSetFetchedRows()
      The number of rows that were actually available from resultSet(), or -1 if there was no result set.

      Calling this method will try to scroll to the end of the resultSet(), in order to count the number of rows, which incurs overhead!

      If the result set is still being consumed (i.e. prior to the ResultSet.close() call), and scrolling back to the current row after scrolling to the end of resultSet() is not possible (e.g. because the driver supports only ResultSet.TYPE_FORWARD_ONLY), then this will return the same value as resultSetConsumedRows().

    • resultSetConsumedColumnCount

      int resultSetConsumedColumnCount()
      The number of columns that were consumed from the resultSet(), or -1 if there was no result set.

      If the result set is still being consumed (i.e. prior to the ResultSet.close() call), then this will return the number of columns that were retrieved from the resultSet() set thus far.

    • resultSetFetchedColumnCount

      int resultSetFetchedColumnCount()
      The number of columns that were actually available from resultSet(), or -1 if there was no result set.

    • resultSetConsumedColumnNames

      @NotNull @NotNull List<String> resultSetConsumedColumnNames()
      The number of columns that were consumed from the resultSet(), or -1 if there was no result set.

      If the result set is still being consumed (i.e. prior to the ResultSet.close() call), then this will return the number of columns that were retrieved from the resultSet() set thus far.

    • resultSetFetchedColumnNames

      @NotNull @NotNull List<String> resultSetFetchedColumnNames()
      The number of columns that were actually available from resultSet(), or -1 if there was no result set.

    • resultSetUnnecessaryWasNullCall

      boolean resultSetUnnecessaryWasNullCall()
      There had been an unnecessary ResultSet.wasNull() call to check that a non-primitive type consumed previously was null, or the call was made more than once.

      resultSetColumnIndex() will return the relevant column index for which the ResultSet.wasNull() call was missing.

      See Also:

    • resultSetMissingWasNullCall

      boolean resultSetMissingWasNullCall()
      There had been a missing ResultSet.wasNull() call on a previously consumed primitive type, which is reported to be ResultSetMetaData.isNullable(int).

      resultSetColumnIndex() will return the relevant column index for which the ResultSet.wasNull() call was missing.

      See Also:

    • resultSetColumnIndex

      int resultSetColumnIndex()
      The relevant column index (1 based) in the ResultSet if applicable, or 0 if there was no result set.

    • actualStatement

      @NotNull @NotNull String actualStatement()
      The actual statement that is being executed.

    • normalisedStatement

      @NotNull @NotNull String normalisedStatement()
      The normalised statement that all duplicates correspond to.

    • duplicateStatements

      @NotNull @NotNull Set<String> duplicateStatements()
      The duplicate statements that all correspond to a single normalised statement.

      This set is used by at least:

    • repeatedStatements

      @NotNull @NotNull List<String> repeatedStatements()
      The repeated statements that all correspond to a single normalised statement.

      This set is used by at least:

    • exception

      @Nullable @Nullable Throwable exception()
      The exception that occurred while diagnosing a statement.