SDK 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.2 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.2.0 (14 March 2024)

    Version 4.2.0 is second minor release of the fourth generation Python SDK, bringing a number of improvements. Most notably the 4.2.0 release adds support for Vector Search, KV Range Scans, and faster failover when using the SDK with Couchbase Server 7.6.0.

    $ python3 -m pip install couchbase==4.2.0

    Known Issues

    • CXXCBC-447: This version of the SDK will not be able to connect to a cluster utilizing alternate addressing. The recommendation is to wait to upgrade to a version of the Python SDK that contains C++ SDK 1.0.0-dp.15 (or later).

    Behavioral Change

    It’s important to use Cluster.searchQuery() / Cluster.search() for global indexes, and Scope.search() for scoped indexes. Method Scope.search_query() is now deprecated and will be removed in a future release. Method Scope.search_query() will not work with scoped indexes.

    Enhancements

    • PYCBC-1548: Added support for Vector Search.

    • PYCBC-1565: Updated C++ core for transactions metadata bucket improvements.

    • PYCBC-1572: Updated search API for SDK API 3.5 support. Included deprecation of scope.search_query().

    Underlying C++ SDK Core Changes

    • CXXCBC-336: Updated DNS config to not fallback to 8.8.8.8 if SDK cannot obtain system DNS server (#533).

    • CXXCBC-461: Updated ping operation to not send to nodes that have not completed bootstrap (#540).

    • CXXCBC-462: Fixed hanging when specifying a custom metadata collection via the public API & expose errors (#532).

    • CXXCBC-479: Fixed capabilities check for replica LookupIn operations (#537).

    • CXXCBC-480: Fixed capabilities check for replica LookupIn operations (#539).

    • CXXCBC-481: Fixed potential crash when parsing search result hits (#541).

    • CXXCBC-482: Update range scan orchestrator to use best effort retry strategy by default (#542).

    Python SDK 4.1 Releases

    Version 4.1.12 (1 March 2024)

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

    $ python3 -m pip install couchbase==4.1.12

    Known Issues

    • CXXCBC-447: This version of the SDK will not be able to connect to a cluster utilizing alternate addressing. The recommendation is to wait to upgrade to a version of the Python SDK that contains C++ SDK 1.0.0-dp.15 (or later).

    Fixes

    • PYCBC-1555: Fixed bootstrap select_bucket logic to handle non-KV node.

    Enhancements

    • PYCBC-1375: Updated Query Index Management Create Index Key Encoding.

    • PYCBC-1550: Added support for Scoped Search Indexes.

    • PYCBC-1523: Updated configuration logic when 0xd response is received.

    • PYCBC-1525: Added support for LookupIn and MutateIn macros.

    • PYCBC-1560: Updated ViewQueryOptions to include full_set and raw options.

    Underlying C++ SDK Core Changes

    • CXXCBC-284: Updated config polling to not use session that is not bootstrapped (#528).

    • CXXCBC-345: Added range scan improvements and resolved concurrency issues (#525).

    • CXXCBC-421: Updated query operation to return feature_not_available if query preserve expiry is specified but is not supported on the server(#510).

    • CXXCBC-431: Added check for history retention bucket capability in collection create/update (#502, #505).

    • CXXCBC-447: Updated bootstrap logic to use addresses from the config to bootstrap bucket (#516).

    • CXXCBC-450: Updated bootstrap logic to reset bootstrap handler before re-bootstrap (#524).

      • We do not want any actions from old bootstrap handler once the session decided to re-bootstrap. For example, bucket could not be selected, but we might still get configuration responses before socket reset.

    • CXXCBC-452: Updated capabilities and fail fast when selected feature is not available. (#522, #513).

    • CXXCBC-456: Updated configuration logic when 0x0d (EConfigOnly) status code is received to have the SDK request new configuration and send current operation to retry orchestrator (#523).

    Version 4.1.11 (1 February 2024)

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

    $ python3 -m pip install couchbase==4.1.11

    Enhancements

    • PYCBC-1549: Added support for maxTTL value of -1 for collection "no expiry".

    Underlying C++ SDK Core Changes

    • CXXCBC-284: Reduced network traffic when polling for cluster configuration (#504).

    • CXXCBC-421: Updated query response to return feature_not_available when query preserve expiry is not supported (#510).

    • CXXCBC-422: Added insufficient credentials error code to common query error code conversion (#511).

    • CXXCBC-431: Added check for history retention bucket capability for collection create/update (#502, #505).

    • CXXCBC-446: Improved log formatting (#506, #508, #509).

    Version 4.1.10 (3 January 2024)

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

    $ python3 -m pip install couchbase==4.1.10

    Enhancements

    • PYCBC-1499: Added improvements for Faster Failover and Config Push.

    • PYCBC-1545: Added support for new KV error code to raise DocumentNotLockedException.

    Underlying C++ SDK Core Changes

    • CXXCBC-100: Added support for using a timeout with ping operation (#486).

    • CXXCBC-368: Added support for subscribing to clustermap notifications to speedup failover (#490).

    • CXXCBC-391: Fixed transactions API inconsistencies (#482).

    • CXXCBC-403: Updated not_my_vbucket KV response to allow retries (#480).

    • CXXCBC-404: Fixed unlock operations to expose KV_LOCKED status as cas_mismatch (#479).

    • CXXCBC-409: Added handling for index does not exist query error (#492).

    • CXXCBC-419: Updated MCBP protocol parser to start with clean state (#496).

    Version 4.1.9 (14 November 2023)

    Version 4.1.9 is the next patch release of the fourth generation Python SDK, bringing a number of improvements. Most notably the 4.1.9 release removes the OpenSSL dependency for published wheels and added musllinux wheels for supported alpine environments.

    $ python3 -m pip install couchbase==4.1.9

    Behavioral Change

    The Couchbase Python SDK now publishes wheels that statically link against BoringSSL. The change removes the OpenSSL requirement from the SDK when using a published wheel. If building the SDK from source, the build will default to dynamically linking with the system provided OpenSSL. Build options are availalbe if wanting to build from source and statically link against BoringSSL. Also, published wheels dynamically link against stdlibs where previously the default was to statically link against stdlibs. Build options are available if wanting to build from source and statically link against stdlibs.

    Fixes

    • PYCBC-1538: Fixed get with projections to not fail with InvalidArgumentException when projecting on more than 16 fields.

    • PYCBC-1534: Fixed MutateIn replace operation to not fail if path is empty.

    • PYCBC-1531: Fixed CollectionQueryIndexManager to raise InvalidArgumentException when scope_name or collection_name options are set.

    • PYCBC-1521: Fixed streaming APIs to use cluster timeout values from ClusterTimeoutOptions if provided.

    Enhancements

    • PYCBC-1536: Updated MANIFEST.in to only include necessary files for source install.

    • PYCBC-1520, PYCBC-1518: Updated published wheels to statically link against BoringSSL.

    • PYCBC-1515: Added support for bucket settings for 'no dedup' feature.

    • PYCBC-1512: Reduced default HTTP Idle Timeout.

    • PYCBC-1495: Updated wheels and build to dynamically link against stdlibs by default.

    Underlying C++ SDK Core Changes

    • CXXCBC-387: Optimising tags for noop_tracer and cache formatted mbcp_session endpoints (#461, #462, #464).

    • CXXCBC-383: Map subdoc_doc_too_deep KV status to path_too_deep error code (#455).

    • CXXCBC-377: Implement ExtParallelUnstaging in transactions (#457).

    • CXXCBC-386: Allow option to statically link against BoringSSL (#458, #465, #471, #474, #478).

    • CXXCBC-376: Revisit what 'create' and 'update' bucket operations send to the server. Make optional bucket settings fields optional, and do not send anything unless the settings explicitly specified (#451).

    • CXXCBC-374: Return 'bucket_exists' error when the bucket already exists during 'create' operation (#449).

    • CXXCBC-359: Reduced the default timeout for idle HTTP connections to 1 second. The previous default (4.5 seconds) was too close to the 5-second server-side timeout, and could lead to spurious request failures (#448).

    • CXXCBC-367; CXXCBC-370: Added history retention settings to buckets/collection management (#446).

    • CXXCBC-119: Return booleans for subdocument 'exists' operation instead of error code (#444, #452).

    • Add more information to diagnose timeouts on NMVB responses (#475).

    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

    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

    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

    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

    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

    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

    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

    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

    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

    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

    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

    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

    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.