Couchbase PHP Release Notes and Archives

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

These pages cover the 3.0 versions of the Couchbase PHP SDK. For release notes, download links, and installation methods for 2.6 and earlier releases of the Couchbase PHP Client, please see the 2.x PHP Release Notes & Download Archive.

SDK Installation

Installing on Linux-like systems

Before installing the PHP SDK, you must install the C SDK — libcouchbase (LCB); version 3.0.0 or higher is required for PHP Client 3.0.2.

After installing the C SDK, install the PHP SDK through your PHP distribution’s pecl command:

$ pecl install https://packages.couchbase.com/clients/php/couchbase-3.0.2.tgz

Installing on Microsoft Windows

When using Microsoft Windows, instead of using PECL, download a pre-built binary matching your environment. You may also download the source for the SDK and build it directly in your environment if you have a complete build toolchain.

Binaries that marked with (TLS) contain libcouchbase.dll, that linked against OpenSSL 1.1.1d (MSVC15) and support secure connection to Couchbase. We highly recommend to use TLS, as it keeps all communication between SDK and Cluster secure. The packages do not include OpenSSL binaries, therefore they have to be installed in the PATH (see https://wiki.openssl.org/index.php/Binaries).

Platform

Source

couchbase-3.0.2.tgz

Checksum

couchbase-3.0.2.sha256sum

PHP 7.2 VC14 NTS

php_couchbase-3.0.2-7.2-nts-x64.zip

PHP 7.2 VC14 ZTS

php_couchbase-3.0.2-7.2-zts-x64.zip

PHP 7.3 VC15 NTS

php_couchbase-3.0.2-7.3-nts-x64.zip

PHP 7.3 VC15 ZTS

php_couchbase-3.0.2-7.3-zts-x64.zip

PHP 7.4 VC15 NTS

php_couchbase-3.0.2-7.4-nts-x64.zip

PHP 7.4 VC15 ZTS

php_couchbase-3.0.2-7.4-zts-x64.zip

PHP 7.3 VC15 NTS (TLS)

php_couchbase-3.0.2-7.3-nts-x64-openssl.zip

PHP 7.3 VC15 ZTS (TLS)

php_couchbase-3.0.2-7.3-zts-x64-openssl.zip

PHP 7.4 VC15 NTS (TLS)

php_couchbase-3.0.2-7.4-nts-x64-openssl.zip

PHP 7.4 VC15 ZTS (TLS)

php_couchbase-3.0.2-7.4-zts-x64-openssl.zip

Post Installation for All Platforms

Once the PHP SDK has been installed, you need to specify that the PHP interpreter should load the Couchbase SDK as an extension. To do this:

  1. Locate your php.ini file. This can be done using the command php --ini

     $ php --ini
     Configuration File (php.ini) Path: /usr/local/etc/php/7.4
     Loaded Configuration File:         /usr/local/etc/php/7.4/php.ini
     Scan for additional .ini files in: /usr/local/etc/php/7.4/conf.d
     Additional .ini files parsed:      (none)
  2. Insert a line in the php.ini file specifying the extension to be loaded; this should be in the [PHP] section. If you don’t know where that is, simply search for existing commented or uncommented extension= entries in the file. Note that the line differs for Linux/Mac OS from Microsoft Windows.

extension=couchbase.so

extension=couchbase.dll

Note on Extension Dependencies

The Couchbase SDK depends on the JSON module, therefore it has to be loaded before the SDK.

Version 3.0.2 (March 4, 2020)

  • PCBC-660: Fixed detection of replace with CAS, so CasMismatchException now raised where necessary instead of KeyExistsException.

  • PCBC-663: Search method now increases refcounter of search object, avoiding double-free error in the script termination handler.

  • Fixed memory leaks.

  • Fixed manifest issue leading to install failure.

Version 3.0.1 (February 4, 2020)

  • Exposed manager APIs on Cluster level:

    • Cluster#queryIndexes() → QueryIndexManager

    • Cluster#searchIndexes() → SearchIndexManager

    • Cluster#users() → UserManager

    • Cluster#buckets() → BucketManager

  • Exposed manager APIs on Bucket level:

    • Bucket#collections() → CollectionManager

    • Bucket#viewIndexes() → ViewIndexManager

Version 3.0.0 (January 21, 2020)

First GA release

Pre-releases

Numerous Alpha and Beta releases were made in the run-up to the 3.0 release, and although unsupported, the release notes and download links are retained for archive purposes here.