A newer version of this documentation is available.

View Latest

Pre-release Archive Release Notes

      Release notes for the 3.0 Alpha & Beta Releases

      In the run-up to the SDK 3.0 API releases, several αλφα and βετα releases were made. Their release notes are maintained here for archive purposes. The 3.0 series release notes proper can be found here, along with install instructions for all supported platforms. Please note that none of the pre-releases listed below are supported; all supported (GA) releases can be found here.

      These are the pre-release α & β Release Notes maintained purely for archive and information purposes. These releases are unsupported. Supported (GA) releases can be found on the general 3.0 Release Notes page.

      Python SDK 3.0.0 Beta 3 Release Notes (January 20 2020)

      pip install couchbase==3.0.0b3


      • PYCBC-766: Bumped LCB requirement to 3.0.0.

      • PYCBC-757: Refactored for FTS/N1QL/durability LCB changes.

      • PYCBC-758: Reflected renaming of lcb_wait3 to lcb_wait in LCB.

      • PYCBC-765: Expose Collection properties and Datastructures in Sphinx docs.

      • PYCBC-610: FTS Index Management for SDK3.

      • PYCBC-750: Add Search Index manager for SDK3.


      • PYCBC-760 Fixed Collection.exists implementation.

      • PYCBC-640 Implemented replica reads according to RFC.

      • PYCBC-768: Refactored durability params to prevent impossible combinations.

      • PYCBC-639: Example N1QL statements do seem to work in "Hello Couchbase" example.

      • PYCBC-667: Fixed Upsert Group fails with 'roles: value must be supplied'.

      • PYCBC-674: Fixed deprecation warnings from sdk2 when running sdk3.

      • PYCBC-675: Brough Result objects in line with RFC, removed unidiomatic interfaces.

      • PYCBC-694: Completed query implementation.

      • PYCBC-753: Collection APIs marked volatile.

      • PYCBC-763: Corrected MutateInResult.content_as implementation.

      • PYCBC-764: Delete or renamed remaining SDK2 references in main API: Renamed SDK2/sdk2 to Core/core where applicable. Removed classes & methods inapplicable to SDK3.

      • PYCBC-704: Implemented *CollectionOptions for Collection management API.

      • PYCBC-716: Tests should no longer try to do 6.5-specific tests against a 6.0 server.

      • PYCBC-686: Applyed new naming convention for interfaces/protocols.

      • PYCBC-687: Support added for Python 3.8.

      • PYCBC-761: Added timeout to lookup_in operation.

      Python SDK 3.0.0 Beta 2 Release Notes (December 30 2019)

      pip install couchbase==3.0.0b2


      • PYCBC-680: UpsertOptions should use 'expiry' rather than 'expiration'.

      • PYCBC-692: Implement Collection.exists

      • PYCBC-693: Fix UpsertOptions constructor

      • PYCBC-697: Migrate to timedelta/datetime from FiniteDuration/Seconds etc

      • PYCBC-709: Convert from lcb_strerror to lcb_strerror_short

      • PYCBC-717: Tighten up lookup test with nonexistent path

      • PYCBC-721: Implement collection.drop_collection and drop_scope

      • PYCBC-647: Support View design documents for SDK3

      • PYCBC-725: Adjust to latest error name refactorings in LCB3

      • PYCBC-631: Add query service fast prepare support

      • PYCBC-646: View management

      • PYCBC-666: Add timeouts to management/get/store calls

      • PYCBC-678: Update sphinx-autodoc-typehints to attempt to use type comments

      • PYCBC-679: Get rid of obsolete coll/scope injection calls

      • PYCBC-683: N1QL Query Index Management

      • PYCBC-718: Refactor error handling for libcouchbase 3.0.0 Beta 2

      • PYCBC-720: Parameterise patch type for libcouchbase

      • PYCBC-728: Make CouchbaseError.Params constructor type-safe


      • PYCBC-699: Operate on non-default collection again

      • PYCBC-705: Fix segfault in test_importworks

      • PYCBC-708: Several similar admin test failures

      • PYCBC-712: Don’t test collections on older servers

      • PYCBC-715: Fix cluster arguments for analytics operations

      • PYCBC-727: Analytics test fixes

      • PYCBC-690: Set up Combination Testing for SDK 3 - Python 3.x Win and Linux

      • PYCBC-700: Fix Python 2/3 compatibility issues

      • PYCBC-724: Fix PYCBC git tag detection code for x.y.z where z>9

      Python SDK 3.0.0 Beta 1 Release Notes (October 11 2019)

      pip install couchbase==3.0.0b1


      • PYCBC-637: Added static Cluster.connect factory method.

      • PYCBC-630: Added Datastructures v2 for SDK3.

      • PYCBC-660: Renamed lcb_cmdfts_query to lcb_cmdfts_payload.

      • PYCBC-661: Safeguards added for property access when debugging partially constructed Client instances.

      • PYCBC-664: Added create bucket management API

      • PYCBC-665: Added create user management API

      Python SDK 3.0.0 Alpha 6 Release Notes (September 27 2019)

      pip install couchbase==3.0.0a6


      • PYCBC-638: scope and collection methods now marked as "uncommitted".

      • PYCBC-584: fulldoc insert with subdoc upsert now supported with LCB V4 API.

      • PYCBC-644: Updates to reflect C code changes for logging, subdocs, LCB_STORE_**, lcb_*3, and enable_mutation_tokens refactorings.

      • PYCBC-645: Changes made to handle new safety checks in LCB for bad hostname.

      • PYCBC-652: Refactored for new lcb_createopts_** API.

      • PYCBC-654: Refactored for temporary removal of observe/endure/mctx code from LCB3 for client-side durability changes.

      • PYCBC-657: Refactored for libcouchbase 3.0.0 Beta 1.

      Python SDK 3.0.0 Alpha 5 Release Notes (August 23 2019)

      pip install couchbase==3.0.0a5


      • PYCBC-616: Migrate acouchbase module to SDK3

      • PYCBC-621: Update Cluster constructor docs to indicate mandatory authenticator

      • PYCBC-623: Document Git dependency

      • PYCBC-624: Update Hello World example to indicate mandatory authenticator argument

      • PYCBC-625: Make multi-ops explicitly visible in Collection class

      • PYCBC-627: Fix eager_resources setting, fix 2.7 numpydoc incompatibility

      • PYCBC-570: Python: Author docs for SubDocument LookupIn

      • PYCBC-603: Python: SubDoc mutateIn Docs authoring

      • PYCBC-626: Add durability to subdoc, touch and counter operations

      • PYCBC-606: Synchronous Replication snippets

      • PYCBC-633: Rename KV-style Bucket classes to Client for SDK3 code

      Python SDK 3.0.0 Alpha 4 Release Notes (July 12 2019)

      pip install couchbase==3.0.0a4



      • PYCBC-607: Ensure couchbase_core is bootstrapped.

      • PYCBC-609: Fix RPATH install for distutils.

      Python SDK 3.0.0 Alpha 3 Release Notes (July 5 2019)

      pip install couchbase==3.0.0a3


      • PYCBC-585: Refined collections support for SDK3.

      • PYCBC-589: Migrated datastructures to SDK3.

      • PYCBC-595: Implemented multi-ops in Collection class.

      • PYCBC-596: Centralised Collections/Bucket functionality, giving 'legacy style' behavior within the context of a Collection.

      • PYCBC-597: Added buckets_list function to documentation index.

      • PYCBC-601: Use correct RPATH when using legacy build option (distutils).

      Python SDK 3.0.0 Alpha 2 Release Notes (June 18 2019)

      pip install couchbase==3.0.0a2


      • PYCBC-592: Fixed manifest to include extra files for distribution.

      • PYCBC-593: Restrict LCB versions to tagged >=2.10.3, >=3.0.0-alpha.3.

      Python SDK 3.0.0 Alpha 1 Release Notes (June 14 2019)

      pip install couchbase==3.0.0a1


      • PYCBC-540: Added Basic CRUD for SDK 3.0.

      • PYCBC-541: Added Basic Query for SDK 3.0.

      • PYCBC-564: Added Synchronous Durability Operations.

      • PYCBC-566: KV Operations Doc at draft level.

      • PYCBC-583: Python Doc on Error Handling for SDK 3 (v1).

      • PYCBC-546: Update CMakeLists.txt to pull in libcouchbase and other deps.

      • PYCBC-561: Update Error Handling for SDK3 Python.

      • PYCBC-562: Move to libcouchbase 3.0.0 and LCB API v4.

      • PYCBC-582: Made touch tests more reliable.

      • PYCBC-588: Fixed Centos compilation.

      Upgrading 2.x

      Versions of the Python SDK prior to 3.0.0 do not bundle libcouchbase. Be sure to upgrade your LCB installation before making a major upgrade to the Couchbase Python client.