Couchbase C Client
This is the C client library for Couchbase It communicates with the cluster and speaks the relevant protocols necessary to connect to the cluster and execute data operations.
- Can function as either a synchronous or asynchronous library
- Callback Oriented
- Can integrate with most other asynchronous environments. You can write your code to integrate it into your environment. Currently support exists for
- Support for operation batching
- Cross Platform - Tested on Linux, OS X, and Windows.
Before you build from this repository, please check the installation page to see if there is a binary or release tarball available for your needs. Since the code here is not part of an official release it has therefore not gone through our release testing process.
By default the library depends on:
- libevent (or libev) for the primary I/O backend.
- openssl for SSL transport.
- CMake version 2.8.9 or greater (for building)
On Unix-like systems these dependencies are checked for by default while on Windows they are not checked by default.
On Unix, the build system will expect to have libevent or libev installed, unless building plugins is explicitly disabled (see further).
Building on Unix-like systems
Provided is a convenience script called
cmake/configure. It is a Perl
script and functions like a normal
$ git clone git://github.com/couchbase/libcouchbase.git $ cd libcouchbase && mkdir build && cd build $ ../cmake/configure $ make $ ctest
Building on Windows
git and Visual Studio 2010 are installed, from a
CMD shell, do:
C:\> git clone git://github.com/couchbase/libcouchbase.git C:\> mkdir lcb-build C:\> cd lcb-build C:\> cmake -G "Visual Studio 10" ..\libcouchbase C:\> cmake --build .
This will generate and build a Visual Studio
Windows builds are known to work on Visual Studio versions 2008, 2010 and 2012.
If you wish to link against OpenSSL, you should set the value of
OPENSSL_ROOT_DIR to the location of the installation path, as described
To run tests, you can use either ctest directly or generated build targets. For Unix-like:
cmake --build . --target alltests ctest -C debug
By default tests will use CouchbaseMock project to simulate the Couchbase Cluster. It allows to cover more different failure scenarios, although does not implement all kinds of APIs provided by real server.
If you need to test against real server, you have to provide comma-separated configuration in
environment variable. For example, the following command will run tests against local cluster and bucket
export LCB_TEST_CLUSTER_CONF=couchbase://localhost,default,Administrator,password make test
Note that specifying username will automatically switch to RBAC mode, which supported by Couchbase Server 5.0+. For old
servers the spec will look like
Also tests expecting
beer-sample bucket loaded. It comes with the server. Look at "Sample buckets" section of Admin
Bugs, Support, Issues
You may report issues in the library in our issue tracked at https://issues.couchbase.com. Sign up for an account and file an issue against the Couchbase C Client Library project.
The developers of the library hang out in IRC on
- Official client libraries using libcouchbase
- Community projects using libcouchbase
Documentation is available in guide format (introducing the basic concepts of Couchbase and the library). It is recommended for first-time users, and can be accessed at our Documentation Site.
API documentation is also available and is generated from the library's headers. It may contain references to more advanced features not found in the guide.
API documentation may be generated by running
doxygen within the source root
directory. When this is done, you should have a
doc/html/index.html page which
may be viewed.
Doxygen may be downloaded from the doxygen downloads page. Note however that most Linux distributions as well as Homebrew contain Doxygen in their repositories.
$ doxygen $ xdg-open doc/html/index.html # Linux $ open doc/html/index.html # OS X
You may also generate documentation using the
doc/Makefile which dynamically
inserts version information
$ make -f doc/Makefile public # for public documentation $ make -f doc/Makefile internal # for internal documentation
The generated documentation will be in the
doc/public/html directory for
public documentation, and in the
doc/internal/html directory for internal
The following people contributed to libcouchbase (in alphabetic order) (last updated Nov. 27 2014)
- Brett Lawson firstname.lastname@example.org
- Dave Rigby email@example.com
- Jan Lehnardt firstname.lastname@example.org
- Mark Nunberg email@example.com
- Matt Ingenthron firstname.lastname@example.org
- Patrick Varley email@example.com
- Paul Farag firstname.lastname@example.org
- Pierre Joye email@example.com
- Sebastian firstname.lastname@example.org
- Sergey Avseyev email@example.com
- Subhashni Balakrishnan firstname.lastname@example.org
- Sundar Sridharan email@example.com
- Trond Norbye firstname.lastname@example.org
- Volker Mische email@example.com
- William Bowers firstname.lastname@example.org
- Yura Sokolov email@example.com
- Yury Alioshinov firstname.lastname@example.org
libcouchbase is licensed under the Apache 2.0 License. See
LICENSE file for