README.md

Couchbase C++ Client

• Documentation and User Guides: https://docs.couchbase.com/cxx-sdk/current/hello-world/start-using-sdk.html
• API Reference: https://docs.couchbase.com/sdk-api/couchbase-cxx-client
• Issue Tracker: https://issues.couchbase.com/projects/CXXCBC/issues
• Server Documentation: https://docs.couchbase.com/home/server.html

Using with CPM.cmake

CPM.cmake makes it really easy to include library into your project. Use the following snippet to update your CMakeLists.txt:

CPMAddPackage(
  NAME
  couchbase_cxx_client
  GIT_TAG
  1.0.0
  VERSION
  1.0.0
  GITHUB_REPOSITORY
  "couchbase/couchbase-cxx-client"
  OPTIONS
  "COUCHBASE_CXX_CLIENT_STATIC_BORINGSSL ON")

Building with CMake

This repo is being built with CMake so everything should build easily once the basic dev dependencies are satisfied (C++17 compiler).

Building (command-line)

git clone https://github.com/couchbase/couchbase-cxx-client.git
cd couchbase-cxx-client
mkdir build
cmake -S . -B build -DCOUCHBASE_CXX_CLIENT_STATIC_BORINGSSL=ON
cmake --build build

Running Tests

The tests are located in the /test directory. More tests will be added and this directory will be organized more in the near future to differentiate between the common tests types that might be used for different types of testing (e.g., unit tests, integration tests, system tests).

Testing (command-line)

cd build
export TEST_CONNECTION_STRING=couchbase://127.0.0.1
export TEST_USERNAME=Administrator
export TEST_PASSWORD=password
export TEST_BUCKET=default
ctest