Skip to content

Commit 4a8ba89

Browse files
committed
#845 Document fix and breaking change in release notes
1 parent d102dcb commit 4a8ba89

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
@@ -37,6 +37,11 @@ The following has been changed or fixed since Jaybird 5.0.6:
3737
* Improvement: backported deferred blob open optimization from Jaybird 7 (https://github.com/FirebirdSQL/jaybird/issues/841[#841])
3838
+
3939
See also <<blob-performance-defer-open>>.
40+
* Fixed: `NullPointerException` in `getGeneratedKeys()` with blob columns after (auto)commit (https://github.com/FirebirdSQL/jaybird/issues/846[#846])
41+
+
42+
As part of this fix, there was an incompatible change in the internal GDS-ng API.
43+
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.
44+
See also <<breaking-changes-internal-api-5-0-7>>.
4045
4146
[#jaybird-5-0-6-changelog]
4247
=== Jaybird 5.0.6
@@ -1207,6 +1212,21 @@ The state transition `ALLOCATED` -> `PREPARED` is no longer valid, and must now
12071212

12081213
Custom statement implementations need to add a state transition to `PREPARING` before preparing a new statement text.
12091214

1215+
[#breaking-changes-internal-api-5-0-7]
1216+
==== Breaking changes internal API for 5.0.7
1217+
1218+
Bug fixes in Jaybird 5.0.7 introduced the following breaking changes in the GDS-ng API and its implementations.
1219+
As this is an internal API, our policy allows breaking changes in point releases.
1220+
This should only affect maintainers of Jaybird forks, or people using the internal API directly.
1221+
1222+
* `FbDatabase`
1223+
** `createInputBlob` and `createOutputBlob` now throw `SQLException`
1224+
* `ProtocolDescriptor`
1225+
** `createInputBlob` and `createOutputBlob` now throw `SQLException`
1226+
* `AbstractFbWireBlob` and subclasses
1227+
** Constructors now throw `SQLException` if the provided database is null or not attached, or the provided transaction is null or not active.
1228+
Previously, passing in a null transaction would result in a `NullPointerException`.
1229+
12101230
[#breaking-changes-unlikely]
12111231
=== Unlikely breaking changes
12121232

0 commit comments

Comments
 (0)