Couchbase Java SDK 3.8

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

Quickstart Guide | SDK Release Notes | Java SDK API Reference | Java SDK 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 Java APIs to work with Capella, our managed solution, or self-managed options in your private Cloud or datacenter.

Data Ops (CRUD)
SQL++ Query (OLTP)
Vector Search

java
ViewCopy
collection.upsert("my-document", JsonObject.create().put("doc", true),
    upsertOptions().durability(DurabilityLevel.MAJORITY));

java
ViewCopy
QueryResult result = cluster.query(
    "select count(*) from `travel-sample`.inventory.airline where country = $country",
    queryOptions().parameters(JsonObject.create().put("country", "France")));

java
ViewCopy
SearchRequest request = SearchRequest
        .create(VectorSearch.create(VectorQuery.create("vector_field", vectorQuery)));

SearchResult result = scope.search("vector-index", request);

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.

Installing the SDK via Maven

xml
Copy
<dependencies>
    <dependency>
        <groupId>com.couchbase.client</groupId>
        <artifactId>java-client</artifactId>
        <version>3.8.0</version>
    </dependency>
</dependencies>

The Couchbase Java SDK integrates into the Java ecosystem through a number of extensions and connectors, including:

Exploring the Java SDK

The links in the sections 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 Java SDK docs are, necessarily, just a sub-set Java SDK API Reference — and a complete listing of all APIs can be found in the reference.
For a fuller orientation, there is a guide to the Java SDK docs

Using Your Database

How-to guides to help you start your development journey with Couchbase and the Java 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 Java SDK.

Reference

Deployment

Columnar SDKs

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