Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
mrotteveel committed Nov 6, 2024
1 parent 2133e4c commit 8fc6dfc
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -304,6 +304,12 @@ Boolean property.
Attempts to create a database if it does not exist.
See <<ref-create-database-if-not-exist>> for more information.

a|`reportSQLWarnings`
a|Jaybird specific property ([.since]_Jaybird 6_)
Possible values (case-insensitive): `ALL` (default), `NONE`.
Can be used to disable reporting of ``SQLWarning``s.
See <<ref-report-sql-warnings>> for more information.

|===

In addition, Jaybird allows using arbitrary Database Parameters Block entries as connection properties (provided they are defined in Jaybird's `DpbItems` and `SpbItems` ([.since]_Jaybird 5_), or `ISCConstants` ([.until]_Jaybird 5_)).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,14 @@ The property values are read for each connect, so the value can be changed at an
Configures the default value for the `enableProtocol` connection property.
See <<ref-enable-protocol>> for more information.

[#systemproperties-default-report-sql-warnings]

=== Default `reportSQLWarnings` value

`org.firebirdsql.jdbc.defaultReportSQLWarnings`::
Configures the default value for the `reportSQLWarnings` connection property.
See <<ref-report-sql-warnings>> for more information.

[[systemproperties-wire-buffers]]
=== Wire protocol buffer sizes

Expand Down
22 changes: 22 additions & 0 deletions src/docs/asciidoc/reference/connection/reportsqlwarnings.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
[#ref-report-sql-warnings]
=== Reporting of ``SQLWarning``s

The JDBC Specification requires that a JDBC driver reports a `SQLWarning` when it deviates from certain JDBC-specified behaviour (for example, changing a requested result set type), or when the server reports a warning.

These warnings are reported on the `Connection`, `Statement`, or ``ResultSet``footnote:[In the current implementation, Jaybird never has warnings on `ResultSet`], and can be retrieved with `getWarnings()`.

[.since]_Jaybird 6_ The connection property `reportSQLWarnings` can be used to disable the reporting of ``SQLWarning``s.

This connection property supports the following values (case-insensitive):

[horizontal.compact]
`ALL`::
(default) report all ``SQLWarning``s
`NONE`::
Do not report any ``SQLWarning``s

Invalid values on the connection property will be rejected.

The default value can be overridden with the system property `org.firebirdsql.jdbc.defaultReportSQLWarnings`.
It supports the same values as connection property `reportSQLWarnings`.
Invalid values of the system property are ignored.

0 comments on commit 8fc6dfc

Please sign in to comment.