Skip to content

Commit f57809b

Browse files
Gardening
* one sentence per line * bullets
1 parent f466d5a commit f57809b

File tree

1 file changed

+56
-30
lines changed

1 file changed

+56
-30
lines changed

modules/project-docs/pages/sdk-release-notes.adoc

Lines changed: 56 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -71,58 +71,84 @@ Optional artifacts on top of this SDK version are tested for the following compa
7171
|=======================
7272

7373

74-
==== Bug
7574

76-
https://couchbasecloud.atlassian.net/browse/JVMCBC-1656[JVMCBC-1656]:
77-
Fixed an issue that could prevent the SDK from periodically updating its list of KV node addresses. This could occur if the addresses in the connection string (or DNS SRV record) differ from the server’s self-reported address as they appear in the admin UI. This issue can lead to `UnknownHostException` messages in the SDK logs. To resolve the issue, the SDK now feeds both “global” and “bucket” topology info into the same funnel, so the SDK can update its list of node addresses from either source.
75+
==== Behavioral Changes
7876

79-
https://couchbasecloud.atlassian.net/browse/JVMCBC-1660[JVMCBC-1660]:
80-
BEHAVIOR CHANGE The “auto” network selection heuristic has been changed to fall back to the “external” network if the “external” network is present. Previously, if there was no exact match between an address in the connection string and an address in the cluster topology reported by the server, the SDK would select the “default” network. Now, if there is no match and an “external” network is present, the SDK selects the “external” network. If this change causes the SDK to select the incorrect network for your deployment, use the [https://docs.couchbase.com/java-sdk/current/ref/client-settings.html#io.networkResolution]https://docs.couchbase.com/java-sdk/current/ref/client-settings.html#io.networkResolution: [io.networkResolution] client setting to configure the SDK to use the “default” network.
77+
* https://couchbasecloud.atlassian.net/browse/JVMCBC-1660[JVMCBC-1660]:
78+
The "auto" network selection heuristic has been changed to fall back to the "external" network if the "external" network is present.
79+
Previously, if there was no exact match between an address in the connection string and an address in the cluster topology reported by the server, the SDK would select the "default" network.
80+
Now, if there is no match and an "external" network is present, the SDK selects the "external" network.
81+
+
82+
If this change causes the SDK to select the incorrect network for your deployment, use the xref:ref:client-settings.adoc#io.networkResolution[io.networkResolution] client setting to configure the SDK to use the "default" network.
8183

82-
https://couchbasecloud.atlassian.net/browse/JVMCBC-1662[JVMCBC-1662]:
83-
Fixed an issue that prevented the SDK from honoring the "preferred server group" option inside transactions.
84+
==== Bug Fixes
8485

85-
https://couchbasecloud.atlassian.net/browse/JVMCBC-1664[JVMCBC-1664]:
86-
Exceptionally long-running analytics queries no longer throw ArrayIndexOutOfBoundsException.
86+
* https://couchbasecloud.atlassian.net/browse/JVMCBC-1656[JVMCBC-1656]:
87+
Fixed an issue that could prevent the SDK from periodically updating its list of KV node addresses.
88+
This could occur if the addresses in the connection string (or DNS SRV record) differ from the server’s self-reported address as they appear in the admin UI.
89+
This issue can lead to `UnknownHostException` messages in the SDK logs.
90+
To resolve the issue, the SDK now feeds both “global” and “bucket” topology info into the same funnel, so the SDK can update its list of node addresses from either source.
8791

88-
https://couchbasecloud.atlassian.net/browse/JVMCBC-1671[JVMCBC-1671]:
89-
All expected attributes are now included in transactions metrics exported by the SDK.
92+
* https://couchbasecloud.atlassian.net/browse/JVMCBC-1662[JVMCBC-1662]:
93+
Fixed an issue that prevented the SDK from honoring the "preferred server group" option inside transactions.
9094

91-
==== Task
95+
* https://couchbasecloud.atlassian.net/browse/JVMCBC-1664[JVMCBC-1664]:
96+
Exceptionally long-running analytics queries no longer throw `ArrayIndexOutOfBoundsException`.
9297

93-
https://couchbasecloud.atlassian.net/browse/JVMCBC-1639[JVMCBC-1639]:
94-
We’ve adopted a mono-versioning strategy for the Couchbase JVM client libraries. The Scala and Kotlin SDKs, along with the core library and optional modules, are now aligned with the Java SDK at version 3.9.0. Although this is a technically a major version bump for some components, in this exceptional case it does not indicate a breaking change. The goal of this alignment is twofold: to minimize confusion about which versions are compatible with each other, and to enable a more disciplined branch management strategy where patch releases contain only low-risk bug fixes.
98+
* https://couchbasecloud.atlassian.net/browse/JVMCBC-1671[JVMCBC-1671]:
99+
All expected attributes are now included in transactions metrics exported by the SDK.
95100

96101
==== Improvement
97102

98-
https://couchbasecloud.atlassian.net/browse/JVMCBC-1607[JVMCBC-1607]:
99-
Improved how the SDK logs information about trusted TLS certificates on startup. It now logs up to 5 certificates at INFO level, and the full list at DEBUG level. Previously, the SDK logged the full list at INFO level, which could prevent other interesting configuration info from being included in the log, depending on how logging was configured.
103+
* https://couchbasecloud.atlassian.net/browse/JVMCBC-1639[JVMCBC-1639]:
104+
We’ve adopted a mono-versioning strategy for the Couchbase JVM client libraries.
105+
The Scala and Kotlin SDKs, along with the core library and optional modules, are now aligned with the Java SDK at version 3.9.0.
106+
+
107+
Although this is a technically a major version bump for some components, in this exceptional case it does not indicate a breaking change.
108+
The goal of this alignment is twofold: to minimize confusion about which versions are compatible with each other,
109+
and to enable a more disciplined branch management strategy where patch releases contain only low-risk bug fixes.
110+
111+
* https://couchbasecloud.atlassian.net/browse/JVMCBC-1607[JVMCBC-1607]:
112+
Improved how the SDK logs information about trusted TLS certificates on startup.
113+
It now logs up to 5 certificates at `INFO` level, and the full list at `DEBUG` level.
114+
Previously, the SDK logged the full list at `INFO` level, which could prevent other interesting configuration info from being included in the log, depending on how logging was configured.
100115

101-
https://couchbasecloud.atlassian.net/browse/JVMCBC-1612[JVMCBC-1612]:
102-
The SDK is now more aggressive about detecting dead or half-open KV connections. It closes a connection if there is no incoming traffic for the duration specified by `io.configIdleRedialTimeout` (default value: 5 minutes), and sends a NOOP request if there is no incoming traffic for hallf that duration.
116+
* https://couchbasecloud.atlassian.net/browse/JVMCBC-1612[JVMCBC-1612]:
117+
The SDK is now more aggressive about detecting dead or half-open KV connections.
118+
It closes a connection if there is no incoming traffic for the duration specified by `io.configIdleRedialTimeout` (default value: 5 minutes),
119+
and sends a `NOOP` request if there is no incoming traffic for hallf that duration.
103120

104-
https://couchbasecloud.atlassian.net/browse/JVMCBC-1648[JVMCBC-1648]:
105-
Upgraded Jackson from 2.17.3 to 2.19.2
121+
* https://couchbasecloud.atlassian.net/browse/JVMCBC-1648[JVMCBC-1648]:
122+
Upgraded `Jackson` from `2.17.3` to `2.19.2`.
106123

107-
https://couchbasecloud.atlassian.net/browse/JVMCBC-1651[JVMCBC-1651]:
124+
* https://couchbasecloud.atlassian.net/browse/JVMCBC-1651[JVMCBC-1651]:
108125
Improved internal support for sub-document replica reads against upcoming server versions.
109126

110-
https://couchbasecloud.atlassian.net/browse/JVMCBC-1652[JVMCBC-1652]:
127+
* https://couchbasecloud.atlassian.net/browse/JVMCBC-1652[JVMCBC-1652]:
111128
Shading the Couchbase SDK no longer causes it report a version number of `0.0.0`.
112129

113-
https://couchbasecloud.atlassian.net/browse/JVMCBC-1657[JVMCBC-1657]:
114-
Improved the backpressure implementation for reactive SQL++, Analytics, and Full-Text Search queries. The SDK now requires less memory to buffer results if the consumer cannot keep up with the producer.
130+
* https://couchbasecloud.atlassian.net/browse/JVMCBC-1657[JVMCBC-1657]:
131+
Improved the backpressure implementation for reactive SQL++, Analytics, and Full-Text Search queries.
132+
The SDK now requires less memory to buffer results if the consumer cannot keep up with the producer.
115133

116-
https://couchbasecloud.atlassian.net/browse/JVMCBC-1658[JVMCBC-1658]:
117-
When the SDK removes uninteresting Netty stack frames from stack traces, it now also applies the filtering to suppressed exceptions. This improves stack trace readability in some cases when Project Reactor debugging is enabled.
134+
* https://couchbasecloud.atlassian.net/browse/JVMCBC-1658[JVMCBC-1658]:
135+
When the SDK removes uninteresting Netty stack frames from stack traces, it now also applies the filtering to suppressed exceptions.
136+
This improves stack trace readability in some cases when Project Reactor debugging is enabled.
118137

119-
## New Feature
138+
==== New Features
120139

121-
https://couchbasecloud.atlassian.net/browse/JVMCBC-1637[JVMCBC-1637]:
122-
A Bill of Materials (BOM) for Couchbase JVM clients is now available. It specifies compatible versions of the Java, Scala, and Kotlin clients, as well as the optional metrics and tracing components. https://central.sonatype.com/artifact/com.couchbase.client/couchbase-client-bom[bom]
140+
* https://couchbasecloud.atlassian.net/browse/JVMCBC-1637[JVMCBC-1637]:
141+
A Bill of Materials (BOM) for Couchbase JVM clients is now available.
142+
It specifies compatible versions of the Java, Scala, and Kotlin clients, as well as the optional metrics and tracing components.
143+
https://central.sonatype.com/artifact/com.couchbase.client/couchbase-client-bom[https://central.sonatype.com/artifact/com.couchbase.client/couchbase-client-bom].
123144

124145
* https://couchbasecloud.atlassian.net/browse/JCBC-2193[JCVC-2193]:
125-
A Full-Text Search vector query now has an optional "prefilter" parameter. This is a non-vector query that the server executes first to get an intermediate result. Then it executes the vector query on the intermediate result to get the final result.
146+
A Full-Text Search vector query now has an optional "prefilter" parameter.
147+
This is a non-vector query that the server executes first to get an intermediate result.
148+
Then it executes the vector query on the intermediate result to get the final result.
149+
150+
151+
126152

127153
== Java SDK 3.8 Releases
128154

0 commit comments

Comments
 (0)