Couchbase Python SDK Release Notes and Archives

    +
    Release notes, installation instructions, and download archive for the Couchbase Python Client.

    Couchbase Python SDK 4.x is built upon Couchbase++, and SDK 3.x is built upon LCB (libcouchbase), but both conform to the SDK API 3.x. The move to Couchbase++ facilitates the introduction of distributed ACID transactions.

    Because the Python SDK is written primarily in C using the CPython API, the official SDK will not work on PyPy.

    Installation

    You may install previous versions of the SDK using pip (after installing the required dependencies)

    $ python3 -m pip install git+https://github.com/couchbase/couchbase-python-client@VERSION

    where VERSION is the version you wish to install. For example, to install version 3.2.6:

    $ python3 -m pip install git+https://github.com/couchbase/couchbase-python-client@3.2.6

    For more detailed installation instructions, see the full installation guide.

    Release Notes

    Version 4.0.3 (2 August 2022)

    Version 4.0.3 is the third patch release of the fourth generation Python SDK, bringing a number of improvements. Most notably the 4.0.3 release added key-value replica read operations and improved memory performance.

    $ python3 -m pip install couchbase==4.0.3

    Fixes

    Enhancements

    Known Issues

    • PYCBC-1261: Distributed tracing is not yet supported.

    • PYCBC-1276: Legacy durability operations are not yet supported.

    • PYCBC-1290: Transactions for txcouchbase are not yet supported.

    • PYCBC-1321: API docs for txcouchbase API are not yet available.

    Version 4.0.2 (29 June 2022)

    Version 4.0.2 is the second patch release of the fourth generation Python SDK, bringing a number of improvements. Most notably the 4.0.2 release provides manylinux wheels which significantly improves the installation process on Linux platforms.

    $ python3 -m pip install couchbase==4.0.2

    Fixes

    • PYCBC-1370: Added environment variables to direct CMake to use specified Python3 version.

    • PYCBC-1374: Added option to dynamically link stdc++ libs.

    Enhancements

    Known Issues

    • PYCBC-1257: Replica reads are not yet supported.

    • PYCBC-1261: Distributed tracing is not yet supported.

    • PYCBC-1276: Legacy durability operations are not yet supported.

    • PYCBC-1290: Transactions for txcouchbase are not yet supported.

    • PYCBC-1321: API docs for txcouchbase API are not yet available.

    Version 4.0.1 (9 June 2022)

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

    $ python3 -m pip install couchbase==4.0.1

    Fixes

    • PYCBC-1324: Fixed N1QL Query options scan_wait/scan_cap misspelling.

    • PYCBC-1335: Fixed issue where positional and named parameters were not used in TransactionQueryOptions.

    • PYCBC-1336: Fixed crash when using ViewOptions keys parameter.

    • PYCBC-1342: Fixed the txcouchbase API Bucket Management API.

    • PYCBC-1343: Fixed the txcouchbase Collection Management API.

    Enhancements

    • PYCBC-1328 Implemented txcouchbase test suite.

    • PYCBC-1320: Added acouchbase core API Docs.

    • PYCBC-1329: Cleaned up the acouchbase API test suite.

    • PYCBC-1331: Updated streaming API options tests to validate all parameters.

    • PYCBC-1333: Updated README, API docs for 4.0.1 release.

    • PYCBC-1334: Cleaned up couchbase API test suite.

    • PYCBC-1358: Updated Windows wheel to dynamically link against OpenSSL.

    Known Issues

    • PYCBC-1232: Core IO logging is not forwarded through to Python.

    • PYCBC-1257: Replica reads are not yet supported.

    • PYCBC-1261: Distributed tracing is not yet supported.

    • PYCBC-1276: Legacy durability operations are not yet supported.

    • PYCBC-1290: Transactions for txcouchbase are not yet supported.

    • PYCBC-1321: API docs for txcouchbase API are not yet available.

    Version 4.0.0 (6 May 2022)

    Version 4.0.0 is the first major release of the next generation Python SDK, built on the Couchbase++ library — featuring multi-document distributed ACID transactions, and bringing a number of improvements to the SDK.

    $ python3 -m pip install couchbase==4.0.0

    New Features

    • Support for distributed transactions has now been implemented.

    • Reimplemented the library using couchbase++.

    • Improved alignment between couchbase, acouchbase and txcouchbase APIs.

    • Support for Python versions 3.7 - 3.10.

    • Improved API documentation.

    Fixes

    • PYCBC-849: Implemented wait until ready.

    • PYCBC-1146: Aligned multi key-value methods with couchbase API.

    • PYCBC-1280: Fixed implementation of the CertificateAuthenticator.

    • PYCBC-1296: Updated SearchRow to not print locations when not included.

    Known Issues

    • PYCBC-1232: Core IO logging is not forwarded through to Python.

    • PYCBC-1257: Replica reads are not yet supported.

    • PYCBC-1261: Distributed tracing is not yet supported.

    • PYCBC-1276: Legacy durability operations are not yet supported.

    • PYCBC-1290: Transactions for txcouchbase are not yet supported.

    • PYCBC-1319: Management APIs for txcouchbase are not yet supported.

    • PYCBC-1320: API docs for acouchbase API are not yet available.

    • PYCBC-1321: API docs for txcouchbase API are not yet available.

    • PYCBC-1322: Scoped transactional queries currently throw a TransactionFailed error.

    Older Releases

    For documentation on older releases please refer to the 3.x release notes page.