Skip to content

Commit 769ebd7

Browse files
committed
#846 Document fix and breaking change in release notes
1 parent 390bd51 commit 769ebd7

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

src/docs/asciidoc/release_notes.adoc

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,11 @@ The following was fixed or changed since Jaybird 6.0.0:
4040
* Improvement: backported deferred blob open optimization from Jaybird 7 (https://github.com/FirebirdSQL/jaybird/issues/842[#842])
4141
+
4242
See also <<blob-performance-defer-open>>.
43+
* Fixed: `NullPointerException` in `getGeneratedKeys()` with blob columns after (auto)commit (https://github.com/FirebirdSQL/jaybird/issues/846[#846])
44+
+
45+
As part of this fix, there was an incompatible change in the internal GDS-ng API.
46+
Various methods and constructors involved in blob handle creation now throw a `SQLException` if the database is not attached or the transaction is null or not active.
47+
See also <<breaking-changes-internal-api-6-0-1>>.
4348

4449
=== Jaybird 6.0.0
4550

@@ -1930,6 +1935,21 @@ The `/isc_error_msg.properties` and `/isc_error_sqlstates.properties` resources
19301935
Their replacements are the `/org/firebirdsql/firebird_N_error_msg.properties` and `/org/firebirdsql/firebird_N_sql_states.properties` resources, where _N_ is the facility code of the error.
19311936
This allows us to avoid loading messages from facilities which are not actually used.
19321937

1938+
[#breaking-changes-internal-api-6-0-1]
1939+
==== Breaking changes internal API for 6.0.1
1940+
1941+
Bug fixes in Jaybird 6.0.1 introduced the following breaking changes in the GDS-ng API and its implementations.
1942+
As this is an internal API, our policy allows breaking changes in point releases.
1943+
This should only affect maintainers of Jaybird forks, or people using the internal API directly.
1944+
1945+
* `FbDatabase`
1946+
** `createInputBlob` and `createOutputBlob` now throw `SQLException`
1947+
* `ProtocolDescriptor`
1948+
** `createInputBlob` and `createOutputBlob` now throw `SQLException`
1949+
* `AbstractFbWireBlob` and subclasses
1950+
** Constructors now throw `SQLException` if the provided database is null or not attached, or the provided transaction is null or not active.
1951+
Previously, passing in a null transaction would result in a `NullPointerException`.
1952+
19331953
[#breaking-changes-unlikely]
19341954
=== Unlikely breaking changes
19351955

0 commit comments

Comments
 (0)