Skip to content

Commit

Permalink
Release notes for client version 4.1.7 and 4.x migration updates
Browse files Browse the repository at this point in the history
  • Loading branch information
thejcfactor committed Aug 8, 2023
1 parent 36a87fa commit 57e7cf7
Show file tree
Hide file tree
Showing 2 changed files with 59 additions and 8 deletions.
10 changes: 2 additions & 8 deletions modules/project-docs/pages/migrating-sdk-code-to-3.n.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -701,6 +701,8 @@ Use a `collection` instance for key-value operations.
*** Datastructure methods provided by the `collection` instance have been deprecated and replaced with their respective APIs (i.e. `CouchbaseList`, `CouchbaseMap`, `CouchbaseQueue` and `CouchbaseSet`)
*** `OperationResult` (deprecated, still available from `couchbase.result`)
*** `ValueResult` (deprecated, still available from `couchbase.result`)
* The 4.x version of the Python SDK significantly improves how the SDK handles the https://docs.python.org/3/glossary.html#term-global-interpreter-lock[Global Interpreter Lock (GIL)]. As part of the improvements, the `lockmode` cluster option has been deprecated as it is a no-op (i.e. has no functionality) and will be removed in a future version of the SDK. Also, the `unlock_gil` option is no longer available.
** For details on how to use the 4.x SDK within the parallelism paradigms provided by the Python language see the https://docs.couchbase.com/sdk-api/couchbase-python-client/couchbase_api/parallelism.html[parallelism] page in the API documentation.
* Import paths have been reorganized to follow consistent patterns. While the import paths that existed in 3.x SDK are mostly available (see previous points on removal of `couchbase_core` package), some paths are deprecated and will be removed in a future release.
** All authenticators should be imported from `couchbase.auth`
** All constants should be imported from `couchbase.constants`
Expand Down Expand Up @@ -728,14 +730,6 @@ Key new features include:

* xref:howtos:distributed-acid-transactions-from-the-sdk.adoc[multi-document ACID transactions]

The following features are unsupported in 4.0.
They are available in 3.2, and will be available in a later 4.x release.

* xref:concept-docs:response-time-observability.adoc[Response Time Availability]
* xref:concept-docs:durability-replication-failure-considerations.adoc#older-server-versions[Legacy durability]
* Log forwarding
* Replica reads

In addition:

* `get` requests on locked documents now retry rather than fast-fail.
Expand Down
57 changes: 57 additions & 0 deletions modules/project-docs/pages/sdk-release-notes.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,63 @@ For more detailed installation instructions, see the xref:project-docs:sdk-full-
== Release Notes



== Version 4.1.7 (8 August 2023)

Version 4.1.7 is the next patch release of the fourth generation Python SDK, bringing a number of improvements.

[source,bash]
----
$ python3 -m pip install couchbase==4.1.7
----

*API Docs:* http://docs.couchbase.com/sdk-api/couchbase-python-client-4.1.7/

=== Behavioral Change

Since Python 3.7 has reached https://peps.python.org/pep-0537/#lifespan[end-of-life], the Couchbase Python SDK will no longer provide Python 3.7 wheels in future releases (>4.1.7). See https://docs.couchbase.com/python-sdk/current/project-docs/compatibility.html#python-version-compat[Python Version Compatibility] for details.

=== Fixes

* https://issues.couchbase.com/browse/PYCBC-1502[PYCBC-1502]:
Added `PasswordAuthenticator` validation.

=== Enhancements

* https://issues.couchbase.com/browse/PYCBC-1496[PYCBC-1496]:
Added support for query with read from replica.

* https://issues.couchbase.com/browse/PYCBC-1419[PYCBC-1419]:
Added support for Native KV Range Scans.

* https://issues.couchbase.com/browse/PYCBC-1505[PYCBC-1504];
https://issues.couchbase.com/browse/PYCBC-1505[PYCBC-1505]:
Updated API documentation to provide correct information on `LockMode`.

* https://issues.couchbase.com/browse/PYCBC-1510[PYCBC-1510]:
Updated CONTRIBUTING.md to improve contributing guidelines.

* https://issues.couchbase.com/browse/PYCBC-1095[PYCBC-1095]:
Added Subdoc mutate-in deletions with a blank path.

=== Underlying C++ SDK Core Changes

* https://issues.couchbase.com/browse/CXXCBC-349[CXXCBC-349]:
Allow to pass trust certificate by value (https://github.com/couchbaselabs/couchbase-cxx-client/pull/430[#430]).
** The change affects TLS v1.0 and v1.1 which are now disabled by default.
* https://issues.couchbase.com/browse/CXXCBC-343[CXXCBC-343]:
Continue bootsrap if DNS-SRV resolution fails (https://github.com/couchbaselabs/couchbase-cxx-client/pull/422[#422]).
* https://issues.couchbase.com/browse/CXXCBC-340[CXXCBC-340]:
Support query with read from replica (https://github.com/couchbaselabs/couchbase-cxx-client/pull/429[#429], ).
* https://issues.couchbase.com/browse/CXXCBC-339[CXXCBC-339]:
Disable older TLS protocols (https://github.com/couchbaselabs/couchbase-cxx-client/pull/418[#418]).
* https://issues.couchbase.com/browse/CXXCBC-333[CXXCBC-333]:
Fix parsing 'resolv.conf' on Linux. (https://github.com/couchbaselabs/couchbase-cxx-client/pull/416[#416]).
** The library might not ignore trailing characters when reading nameserver address from the file.
* https://issues.couchbase.com/browse/CXXCBC-242[CXXCBC-242]:
SDK Support for Native KV Range Scans (https://github.com/couchbaselabs/couchbase-cxx-client/pull/419[#419], https://github.com/couchbaselabs/couchbase-cxx-client/pull/423[#423], https://github.com/couchbaselabs/couchbase-cxx-client/pull/424[#424], https://github.com/couchbaselabs/couchbase-cxx-client/pull/426[#426], https://github.com/couchbaselabs/couchbase-cxx-client/pull/428[#428], https://github.com/couchbaselabs/couchbase-cxx-client/pull/431[#431], https://github.com/couchbaselabs/couchbase-cxx-client/pull/432[#432], https://github.com/couchbaselabs/couchbase-cxx-client/pull/433[#433], https://github.com/couchbaselabs/couchbase-cxx-client/pull/434[#434]).


== Version 4.1.6 (13 July 2023)

Version 4.1.6 is the sixth patch release of the fourth generation Python SDK, bringing a number of improvements. Most notably the 4.1.6 release adds support for Python 3.11 and significantly reduces the size of published _manylinux_ wheels.
Expand Down

0 comments on commit 57e7cf7

Please sign in to comment.