Skip to content

Commit 8dc49e8

Browse files
committed
Document forceCloseOnFatal system properties
See also FirebirdSQL/jaybird#893
1 parent 9ca9542 commit 8dc49e8

1 file changed

Lines changed: 24 additions & 0 deletions

File tree

src/docs/asciidoc/appendices/systemproperties/systemproperties.adoc

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -159,6 +159,30 @@ The order of buffers for output is as follows:
159159
Jaybird => output [=> deflate] => socket
160160
----
161161

162+
[#systemproperties-force-close-on-fatal]
163+
=== Close connection on fatal error
164+
165+
since:[Jaybird 5.0.13/6.0.6]
166+
167+
The following system properties configure if Jaybird forcibly closes connections on fatal errors (default) or not.
168+
169+
`org.firebirdsql.jdbc.connection.forceCloseOnFatal`::
170+
Boolean property.
171+
Configures force close behaviour of "`normal`" JDBC connections (i.e. created with `org.firebirdsql.jaybird.xca.FBStandAloneConnectionManager`);
172+
defaults to `true`.
173+
174+
`org.firebirdsql.ds.xa.connection.forceCloseOnFatal`::
175+
Boolean property.
176+
Configures force close behaviour of (XA) connections created by `org.firebirdsql.ds.FBXADataSource`;
177+
defaults to `true`.
178+
179+
These system properties are checked _dynamically_, so they can be changed at run time.
180+
181+
These properties should only be used for debugging or workarounds.
182+
Correct behaviour of a connection after a fatal error is ignored is not guaranteed.
183+
184+
See also https://github.com/FirebirdSQL/jaybird/blob/master/devdoc/jdp/jdp-2026-04-disable-closing-of-broken-connections.adoc[jdp-2026-04: Disable closing of broken connections].
185+
162186
[[systemproperties-other]]
163187
=== Other properties
164188

0 commit comments

Comments
 (0)