Install Couchbase with PHP on Centos8 / Debian and Ubuntu

Installing on Linux

For installation on Linux, follow the below steps,

install the couchbase-release repository, and then install the libcouchbase packages. The following examples download and install couchbase-release repository, a C and C++ compiler, the C SDK development files (libcouchbase-devel [RPM] or libcouchbase-dev [DEB]), PHP development files, and finally the PHP SDK using pecl.Debian and Ubuntu

# Only needed during first-time setup:
wget http://packages.couchbase.com/releases/couchbase-release/couchbase-release-1.0-6-amd64.deb
sudo dpkg -i couchbase-release-1.0-6-amd64.deb
# Will install or upgrade packages
sudo apt-get update
sudo apt-get install libcouchbase-dev build-essential php-dev zlib1g-dev
sudo pecl install igbinary
sudo pecl install pcs-1.3.3 
sudo pecl install couchbase

For Ubuntu 18.10, and other Debian based releases unsupported by couchbase-release-1.0-6-amd64.deb, either replace the above first-time setup instructions with the following — using the bionic repo of Ubuntu 18.04 to install on Ubuntu 18.10 Cosmic, Ubuntu 19.04 Disco, or other recent versions:

sudo wget -O - http://packages.couchbase.com/ubuntu/couchbase.key | sudo apt-key add -
echo "deb http://packages.couchbase.com/ubuntu bionic bionic/main" | sudo tee /etc/apt/sources.list.d/couchbase.list

or, see the detailed instructions on manually adding repos for your version in the C SDK installation instructions.

On Ubuntu 14.04 (Trusty), and possibly some other distributions, you will need to substitute for php-dev with php5-dev. To find particular variants of php-dev for your Ubuntu or Debian-based distribution, use the command$ apt-cache search php | grep dev

RHEL and CentOS

# Only needed during first-time setup:
wget http://packages.couchbase.com/releases/couchbase-release/couchbase-release-1.0-8-x86_64.rpm
sudo rpm -iv couchbase-release-1.0-8-x86_64.rpm
# Will install or upgrade existing packages
sudo dnf install libcouchbase-devel gcc gcc-c++ php-devel zlib-devel
sudo pecl install igbinary
sudo pecl install pcs-1.3.3
sudo pecl install couchbase

Some older versions of Red Hat, such as CentOS 7, also need:

sudo yum install php-pear

to get PECL installed.

CentOS 7 ships with PHP 5.4, which must be upgraded to at least PHP 5.6 in order to run the Couchbase PHP SDK. Doing this is beyond the scope of this quick start guide, but instructions can be found online. Do this before the yum step above.

Installation on Mac OS X

On MacOS, the libcouchbase package is available in homebrew/core, and can be installed with:

brew install libcouchbase@2

As homebrew/php is no longer available, the current best way to install newer versions of PHP (and one with the necessary permissions) is found at https://php-osx.liip.ch. Download install.sh from there or, if you are happy with the script, install in one line (in this example, PHP 7.2) with:

curl -s https://php-osx.liip.ch/install.sh | bash -s 7.2

Once you have PHP installed, then use PECL to install the Couchbase PHP SDK (read your PHP distribution manual to find out where pecl is located and whether the user needs special permissions to install new extensions):

/path/to/pecl install couchbase

Installing on Microsoft Windows

When using Microsoft Windows, download one of the pre-built binaries at Archives, matching your environment or at PECL. You also have the option of downloading the source for the SDK and building it directly.

Be sure to pay attention to the placement of the files after installation.

Post Installation – Setting up the php.ini

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 the location of your php.ini file. This can be done by php --ini$ php --ini Configuration File (php.ini) Path: /usr/local/etc/php/7.0 Loaded Configuration File: /usr/local/etc/php/7.0/php.ini Scan for additional .ini files in: /usr/local/etc/php/7.0/conf.d Additional .ini files parsed: (none)
  2. Insert the following line in the php.ini file; 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.Linux and Mac OSextension=couchbase.soWindowsextension=couchbase.dllThe Couchbase SDK Version 2.2.4 depends on both the JSON and PCS (PHP Code Service) extensions. Releases from 2.0.0 through 2.2.3 and from 2.3.0 forward depend only on the JSON extension. Make sure that the load order is correct. For example, if your distribution has just a single php.ini file, just insert the line after extension=json.so. If your distribution uses a conf.d-style, name the file with the Couchbase SDK ini so that it will be alphabetically ordered after the JSON extension.Because the extension depends on the C library (libcouchbase), the shared object libcouchbase.so or libcouchbase.dll has to be accessible by the PHP process when loading the extension. On UNIX-like systems no additional steps are necessary, because the libcouchbase package installs shared objects into a common system location. For Windows though, it must be copied into either into a location from the PATH for the PHP executable or into a directory with like executables (like apache2, IIS or php.exe). This is controlled by your PHP distribution’s setup, so see its documentation for further information.

Information on new features, fixes, known issues as well as information on how to install older release versions is in the release notes.

Hello Couchbase

The Hello Couchbase example consists of one PHP file, hello-couchbase.php. The code opens a connection to Couchbase Server, retrieves a document, modifies the document, and stores the updated document in the database. The hello-couchbase.php code is below. Note that to connect to a Couchbase bucket, you must use Couchbase Role-Based Access Control (RBAC). This is fully described in the section Authorization. A username and password for the current user must be specified. Following successful authentication, the bucket is opened.hello-couchbase.php

<?php
$bucketName = "bucket-name";

// Establish username and password for bucket-access
$authenticator = new \Couchbase\PasswordAuthenticator();
$authenticator->username('username')->password('password');

// Connect to Couchbase Server - using address of a KV (data) node
$cluster = new CouchbaseCluster("couchbase://127.0.0.1");

// Authenticate, then open bucket
$cluster->authenticate($authenticator);
$bucket = $cluster->openBucket($bucketName);

// Store a document
echo "Storing u:king_arthur\n";
$result = $bucket->upsert('u:king_arthur', array(
    "email" => "[email protected]",
    "interests" => array("African Swallows")
));

var_dump($result);

// Retrieve a document
echo "Getting back u:king_arthur\n";
$result = $bucket->get("u:king_arthur");
var_dump($result->value);

// Replace a document
echo "Replacing u:king_arthur\n";
$doc = $result->value;
array_push($doc->interests, 'PHP 7');
$bucket->replace("u:king_arthur", $doc);
var_dump($result);

echo "Creating primary index\n";
// Before issuing a N1QL Query, ensure that there is
// is actually a primary index.
try {
    // Do not override default name; fail if it already exists, and wait for completion
    $bucket->manager()->createN1qlPrimaryIndex('', false, false);
    echo "Primary index has been created\n";
} catch (CouchbaseException $e) {
    printf("Couldn't create index. Maybe it already exists? (code: %d)\n", $e->getCode());
}

// Query with parameters
$query = CouchbaseN1qlQuery::fromString("SELECT * FROM `$bucketName` WHERE \$p IN interests");
$query->namedParams(array("p" => "African Swallows"));
echo "Parameterized query:\n";
var_dump($query);
$rows = $bucket->query($query);
echo "Results:\n";
var_dump($rows);

The console output should look similar to this:

Storing u:king_arthur
object(CouchbaseMetaDoc)#4 (5) {
  ["error"]=>
  NULL
  ["value"]=>
  NULL
  ["flags"]=>
  NULL
  ["cas"]=>
  string(10) "eldhjkkzcw"
  ["token"]=>
  NULL
}
Getting back u:king_arthur
object(stdClass)#5 (2) {
  ["email"]=>
  string(24) "[email protected]"
  ["interests"]=>
  array(1) {
    [0]=>
    string(16) "African Swallows"
  }
}
Replacing u:king_arthur
object(CouchbaseMetaDoc)#6 (5) {
  ["error"]=>
  NULL
  ["value"]=>
  object(stdClass)#5 (2) {
    ["email"]=>
    string(24) "[email protected]"
    ["interests"]=>
    array(2) {
      [0]=>
      string(16) "African Swallows"
      [1]=>
      string(5) "PHP 7"
    }
  }
  ["flags"]=>
  int(33554438)
  ["cas"]=>
  string(10) "eldhjkkzcw"
  ["token"]=>
  NULL
}
Creating primary index
Primary index has been created
Parameterized query:
object(CouchbaseN1qlQuery)#8 (2) {
  ["options"]=>
  array(2) {
    ["statement"]=>
    string(45) "SELECT * FROM `bucket-name` WHERE $p IN interests"
    ["$p"]=>
    string(16) "African Swallows"
  }
  ["adhoc"]=>
  bool(true)
}
Results:
object(stdClass)#11 (3) {
  ["rows"]=>
  array(1) {
    [0]=>
    object(stdClass)#10 (1) {
      ["bucket-name"]=>
      object(stdClass)#9 (2) {
        ["email"]=>
        string(24) "[email protected]"
        ["interests"]=>
        array(2) {
          [0]=>
          string(16) "African Swallows"
          [1]=>
          string(5) "PHP 7"
        }
      }
    }
  }
  ["status"]=>
  string(7) "success"
  ["metrics"]=>
  array(4) {
    ["elapsedTime"]=>
    string(11) "11.623318ms"
    ["executionTime"]=>
    string(11) "11.605128ms"
    ["resultCount"]=>
    int(1)
    ["resultSize"]=>
    int(220)
  }
}

Comments are closed.