Please use the form below to provide your feedback. Because your feedback is valuable to us, the information you submit in this form is recorded in our issue tracking system (JIRA), which is publicly available. You can track the status of your feedback using the ticket number displayed in the dialog once you submit the form.

Release Notes

  • reference
    +
    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 4.1.0:

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

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

    Python SDK 4.1 Releases

    We always recommend using the latest version of the SDK — it contains all of the latest security patches and support for new and upcoming features. All patch releases for each dot minor release should be API compatible, and safe to upgrade; any changes to expected behavior are noted in the release notes that follow.

    Version 4.1.8 (25 August 2023)

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

    $ python3 -m pip install couchbase==4.1.8

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

    Behavioral Change

    The Couchbase Python SDK no longer provides Python 3.7 wheels as Python 3.7 has reached end-of-life. See Python Version Compatibility for details.

    Fixes

    • PYCBC-1514: Fixed parsing of LookupIn options if provided for lookup-in operations.

    Enhancements

    • PYCBC-1497: Added support for Sub-Document Read from Replica.

    Underlying C++ SDK Core Changes

    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.

    $ 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 end-of-life, the Couchbase Python SDK will no longer provide Python 3.7 wheels in future releases (>4.1.7). See Python Version Compatibility for details.

    Fixes

    • PYCBC-1502: Added PasswordAuthenticator validation.

    Enhancements

    • PYCBC-1496: Added support for Query with Read from Replica.

    • PYCBC-1419: Added support for Native KV Range Scans.

    • PYCBC-1504; PYCBC-1505: Updated API documentation to provide correct information on LockMode.

    • PYCBC-1510: Updated CONTRIBUTING.md to improve contributing guidelines.

    • PYCBC-1095: Added Subdoc mutate-in deletions with a blank path.

    Underlying C++ SDK Core Changes

    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.

    $ python3 -m pip install couchbase==4.1.6

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

    Fixes

    • PYCBC-1500: Added max_expiry to CollectionSpec for collections returned in get_all_scopes() result.

    Enhancements

    • PYCBC-1473: Added Support for Python 3.11.

    • PYCBC-1459: Reduced size of manylinux wheels.

    • PYCBC-1494: Updated API docs to include binary multiOptions.

    • PYCBC-1498: Updated connection tests to only use valid mixed environment format.

    Version 4.1.5 (8 June 2023)

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

    $ python3 -m pip install couchbase==4.1.5

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

    Behavioral Change

    Accessing content from an Exist operation with the LookupInResult’s `content_as method now returns a boolean. This boolean is True if the path exists, False otherwise. Prior to this change the SDK raised a DocumentNotFoundException if the path existed or PathNotFoundException if the path didn’t exist. The behavioral change aligns the Python SDK with Couchbase’s CRUD RFC.

    Fixes

    • PYCBC-1480: Fixed subdocument read operations to allow for null values.

    • PYCBC-1486: Fixed broken imports for search GeoBoundingBoxQuery, GeoDistanceQuery, and GeoPolygonQuery.

    • PYCBC-1487: Updated Transcoders to be able to decode value when flags=0.

    • PYCBC-1490: Fixed InternalServerFailureException when executing a Regex Search query.

    • PYCBC-1493: Updated search operations to correctly pass MutationState to C++ core.

    Enhancements

    Underlying C++ SDK Core Changes

    • CXXCBC-328: Fix socket reconnection during rebalance process (#406).

      • Several improvements have been implemented to make the library resilient to rapid topology changes when both DNS-SRV bootstrap is being used along with alternative addresses. The changes include:

        • Taking into account alternative hostname and ports during detection of added/removed nodes on configuration update.

        • Replacing node index tracking with hostname/port matching when restarting the connections — this way the library ensures that no duplicate connections will be left, or live connections replaced by restarted session.

        • Improved logging of critical events during rebalance: restarting, preservation, and removing connections.

    Version 4.1.4 (9 May 2023)

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

    $ python3 -m pip install couchbase==4.1.4

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

    Fixes

    • PYCBC-1469: Added check to determine if Python interpreter is finalizing prior to logging.

    • PYCBC-1471: Fixed acouchbase streaming API blocking behavior while when executing queries.

    • PYCBC-1474: Fixed transaction error handling.

    • PYCBC-1475: Updated exception classes to allow first positional arg to be a string message.

    • PYCBC-1477: Fixed potential crash in certain scenarios that use MutationState.

    Enhancements

    • PYCBC-1468: Added replica read operations to API docs.

    • PYCBC-1472: Updated API Docs to indicate expiry option should be a timedelta.

    • PYCBC-1478: Added missing bootstrap timeouts to WAN Config Profile.

    Underlying C++ SDK Core Changes

    • CXXCBC-31: Allow the use of schemaless connection strings (e.g. "cb1.example.com,cb2.example.com") (#394).

    • CXXCBC-320: Negative expiry in atr was leaving docs in a stuck state — this has been fixed, with expiry atr now becoming an int32_t (#393).

    • CXXCBC-318: Always try TCP if UDP fails in DNS-SRV resolver (#390).

    • CXXCBC-145: Search query request raw option now used (#380).

    • CXXCBC-144: Search query on collections now no longer requires scope_name, as it can be inferred from the index (#379).

    Version 4.1.3 (9 March 2023)

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

    $ python3 -m pip install couchbase==4.1.3

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

    Fixes

    Enhancements

    • PYCBC-1431: Updated the SDK to handle new query_context changes.

    • PYCBC-1444: Improved CertificateAuthenticator parameter validation.

    • PYCBC-1445: Updated the SDK to only populate allowed_sasl_mechanisms if user explicitly chooses.

    Version 4.1.2 (9 February 2023)

    Version 4.1.2 is the second patch release of the fourth generation Python SDK, bringing a number of improvements. Most notably the 4.1.2 release provides improved performance for key-value operations.

    $ python3 -m pip install couchbase==4.1.2

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

    Fixes

    • PYCBC-1433: Fixed initialization of legacy durability options in C++ bindings.

    • PYCBC-1434: Added Python SDK and Python version to C++ user_agent option.

    • PYCBC-1441: Fixed inconsistencies when handling of MutationState in streaming APIs.

    Enhancements

    • PYCBC-1371: Implemented ChangePassword feature in user management API.

    • PYCBC-1436: Updated pre-commit iSort Revision.

    • PYCBC-1440: Updated logging to get latest from C++ client.

    • PYCBC-1438: Updated Test Suite/Framework.

    Version 4.1.1 (14 December 2022)

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

    $ python3 -m pip install couchbase==4.1.1

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

    Fixes

    • PYCBC-1428: Fixed view query ViewOrdering to allow user specified ordering to be applied.

    • PYCBC-1429: Fixed defaults for boolean options in N1QL query QueryOptions.

    Version 4.1.0 (3 November 2022)

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

    $ python3 -m pip install couchbase==4.1.0

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

    Fixes

    • PYCBC-1420: Fixed potential InternalSDKException for replica read operations.

    Enhancements

    • PYCBC-1402: Added support for using PYCBC_LOG_LEVEL to create console logger.

    • PYCBC-1417: Updated authentication error message for Bucket Hibernation.

    • PYCBC-1422: Updated Couchbase++ version to incorporate latest changes.

    • PYCBC-1167: Added support for Serverless Execution Environments.

    • PYCBC-1423: Added durability improvements.

    Python SDK 4.0 Releases

    Version 4.0.5 (7 October 2022)

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

    $ python3 -m pip install couchbase==4.0.5

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

    Fixes

    • PYCBC-1312; PYCBC-1407: Fixed crash related to closing a cluster connection.

    • PYCBC-1409: Updated to version of Couchbase++ client that correctly closes HTTP connections.

    • PYCBC-1413: Fixed possible streaming API exceptions when executing in threaded environment.

    • PYCBC-1415: Updated async APIs to use correct future chaining method for read KV operations.

    • PYCBC-1416: Fixed txcouchbase search API.

    Enhancements

    • PYCBC-1405: Updated legacy durability to use the internal Couchbase++ client API.

    • PYCBC-1406: Updated replica reads to use the internal Couchbase++ client API.

    • PYCBC-1411: Added support for LDAP authentication.

    Version 4.0.4 (8 September 2022)

    Version 4.0.4 is the fourth patch release of the fourth generation Python SDK, bringing a number of improvements. Most notably the 4.0.4 release added legacy durability to mutation operations, tracing, and metrics.

    $ python3 -m pip install couchbase==4.0.4

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

    Fixes

    • PYCBC-1398: Fixed potential crash when accessing error_context from a base_exception object.

    Enhancements

    • PYCBC-1261: Added Tracing API, including the ability to use an external tracer such as OpenTelemetry.

    • PYCBC-1276: Added legacy durability to mutation operations. This allows the use of client durability within operations that allow for a durability option.

    • PYCBC-1399: Added Metrics API — users can now provide a custom meter for logging metrics.

    • PYCBC-1391: Removed _raw_metrics property from streaming API Metrics result objects.

    • PYCBC-1392: Updated collection.exists() logic to align with a recent change in the underlying Couchbase++ client. Users will no longer see an error if a document doesn’t exist, instead the resp.exists() method will be needed to determine whether a document is there or not.

    • PYCBC-1395: Updated build deferred index logic to align with recent change in Couchbase++ client.

    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

    API Docs: http://docs.couchbase.com/sdk-api/couchbase-python-client-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

    API Docs: http://docs.couchbase.com/sdk-api/couchbase-python-client-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

    API Docs: http://docs.couchbase.com/sdk-api/couchbase-python-client-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

    API Docs: http://docs.couchbase.com/sdk-api/couchbase-python-client-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.