Couchbase PHP Client Library

h2. Installing

Ideally it is recommended you install everything from the binary releases featured at

h3. Stable

_libcouchbase: _http://www.couchbase.com/develop/c/current

_php-ext-couchbase:_ http://www.couchbase.com/develop/php/current

h3. Developer Preview

_libcouchbase_: http://www.couchbase.com/develop/c/next

_php-ext-couchbase:_ http://www.couchbase.com/develop/php/next
|| PHP Version\\ || Libcouchbase Version || Stable || Server Compatibility\\ || Supported Features\\ ||
| 1.0.x | 1.0.x | Yes | 2.0, 1.8 | * Key-Value operations |
| 1.1-dp5 | 2.0.0beta2 | Developer\\
Preview | 2.0, 1.8 | * Key-Value operations
* MapReduce View Queries
* Lock, Touch |
| master branch | 2.0.0beta2 (or current\\
libcouchbase master) | Volatile | 2.0, 1.8 | Same as 1.1-dp5, maybe some\\
other goodies |
| 1.0.x branch | 1.0.x | Yes (mostly) | 2.0, 1.8 | Same as 1.0.x release |

h4. Installing From Source

It is a common need to install for source (specifically, there is a lot of variation in the Zend API revisions)

*Recommended: *The first thing to do is install libcouchbase. If you are using a 1.8 server version OR are using a server of any version, but are not planning to employ views and MapReduce, you may use the *{_}stable{_}* version of libcouchbase (this is versioned as *{_}1.0.x{_}*).

*NOTE:* The stable php extension version is available in source form from the _1.0.x_ branch on github.

If you wish to use the new and shiny features of Couchbase Server 2.0\[-beta\], then you need to use the *{_}Developer Preview (DP)_* versions of both libcouchbase and the php extension

_It is not required to build both libcouchbase and the php extension from source. As long as you have any version of libcouchbase installed (and its development headers, i.e. libcouchbase-dev or libcouchbase-devel)_ _it is possible to compile and build the PHP extension_

Use the above version matrix to determine the version you need.

For php-ext-couchbase source installation, do the folllowing:

{code}
$ git clone git://github.com/couchbase/php-ext-couchbase.git
$ cd php-ext-couchbase


# If wishing to compile the stable branch of php-ext-couchbase, do the following
$ git checkout 1.0.x


$ phpize
$ ./configure
$ make
$ make install (or just copy modules/couchbase.so to your extension directory)
{code}
If libcouchbase is installed in a non-default path (for example, in your home directory) then you need to specify _\--with-couchbase=$dir_ to _./configure_, where $dir is the installation prefix; such that _$dir/include/libcouchbase/couchbase.h_ exists, and that _$dir/lib/libcouchbase.so_ (or _libcouchbase.dylib, for OS X_) exists

h2. Testing

TBD

h1.