Couchbase C++ SDK 1.3

The Couchbase C++ SDK allows C++ applications to access a Couchbase cluster — Capella or self-managed.

Quickstart Guide | SDK Release Notes | C++ SDK API Reference | C++ SDK source code

What’s the point of a fast and scalable database if it’s not easy to develop for? Couchbase gives you the C++ APIs to work with Capella, our managed solution, or self-managed options in your private Cloud or datacenter.

  • Data Ops (CRUD)

  • SQL++ Query (OLTP)

auto collection = cluster.bucket(bucket_name).scope(scope_name).collection(collection_name);

const std::string document_id{ "minimal_example" };
const tao::json::value basic_doc{
        { "a", 1.0 },
        { "b", 2.0 },
};

auto [err, res] = collection.upsert(document_id, basic_doc, {}).get();
if (err) {
    fmt::println("Unable to perform upsert: {}", err);
} else {
    fmt::println("id: {}, CAS: {}", document_id, res.cas().value());
}
auto scope = cluster.bucket(bucket_name).scope(scope_name);

auto [err, resp] = scope.query("SELECT * FROM airline WHERE id = 10").get();
if (err) {
    fmt::println("Unable to perform query: {}", err);
}

for (const auto& row : resp.rows_as<couchbase::codec::tao_json_serializer>()) {
    fmt::println("row: {}", tao::json::to_string(row));
}
couchbase::search_request request(couchbase::vector_search(couchbase::vector_query("vector_field", vector_query)));

auto [err, res] = scope.search("vector-index", request).get();

if (err) {
    fmt::println("Got an error doing vector search: {}", err);
} else {
    for (const auto& row : res.rows()) {
        fmt::println("id: {}, score: {}", row.id(), row.score());
    }
}

Couchbase is a large platform — covering many services — and Couchbase SDKs are not thin wrappers generated around a REST API, but well thought out interfaces to the platform that make it easier to design and maintain your client code, and work with Couchbase in more natural ways for your platform. Install the SDK, and explore in the way that works best for you.

Building (command-line)
$ cd couchbase-cxx-client
$ mkdir build; cd build
$ cmake ..
$ cmake --build .

The links below will take you where you want to go — as will the navigation on the left-hand side of this page. But if you don’t know exactly where you need to go, try one of the following:

  • Our Quickstart Guide introduces the SDK with a quick install, and CRUD examples against the Data Service.

  • Couchbase’s familiar SQL-family query language and fuzzy search options (including vector search) are introduced on the Querying Your Data page.

  • The C++ SDK docs are, necessarily, just a sub-set C++ SDK API Reference — and a complete reference of all APIs can be found there.

  • For a fuller orientation, there is a guide to the C++ SDK docs


Using Your Database

How-to guides to help you start your development journey with Couchbase and the C++ SDK.

Easy to Connect & Get Started
Search, Query, Analyze
Lightning Fast Data Service
Observability & Error Handling


Resources

Useful resources to help support your development experience with Couchbase and the C++ SDK.

Reference
Deployment



Couchbase Operational Cluster Feature Compatibility

All of the SDKs have API compatibility with most of the features in Couchbase Operational Clusters — whether self-managed, or Capella. The following table covers possible exceptions, and gives the version of the C++ SDK and Couchbase Server with which some features were introduced.

Table 1. Couchbase Server and SDK Supported Version Matrix
Server 7.2 Server 7.6.x Server 8.0

KV Range Scan

N/A

From 1.0.0

Zone aware replica reads

N/A

From 1.0.0

Vector Search with Search Vector Index

N/A

From 1.0.0

Vector Query using Hyperscale Vector Index

N/A

From SDK 1.2.0 ①

Vector Query using Composite (GSI & vector) index

N/A

From SDK 1.2.0 ①

Distributed ACID Transactions

From 1.0.0

DNS SRV refresh for serverless environments (AWS Lambda, Azure Functions, and GCP Functions)

From 1.0.0

Circuit Breakers

Unsupported

OTel

From 1.3.0

Field Level Encryption

From 1.0.0

Cloud Native Gateway

Unsupported
1 As part of the standard SDK SQL++ API, it should be compatible with all earlier versions of the SDK — but it has not been tested.


Analytics SDKs

SDKs for Enterprise Analytics — Couchbase’s analytical database for real time apps and operational intelligence (RT-OLAP) — are available for the .NET, Go, Java, Node.js, and Python platforms. See the Enterprise Analytics SDK pages for more information.

Currently, different SDKs are needed to connect to Capella Analytics — as this service does not have Enterprise Analytics' load balancer, and uses a different connection protocol. Capella Analytics SDKs (also known as Columnar SDKs) are available for the Go, Java, Node.js, and Python platforms. See the Capella Analytics SDK pages for more information.