A newer version of this documentation is available.

View Latest

Overview

The Couchbase Java SDK enables you to interact with a Couchbase Server cluster from a Java or Java virtual machine (JVM) application.

The Java SDK includes the following components:

  • The Java Client (source code)

  • Developer Guide & Reference Documentation

  • Sample applications

Compatibility

Compatibility between Couchbase Server and Couchbase Java SDK releases.

The SDKs aim at being as backward and forward compatible with versions of Couchbase Server as possible. The matrix below indicates which version of the SDK is recommended with each version of Couchbase. Order of preference is Recommended > Preferred > Compatible.

Table 1. Recommended SDK per Server Version Matrix
Under 1.4 SDK 1.4 SDK 2.0 SDK 2.1 SDK 2.2

SDK released for >

N/A (Archived)

Bugfixes only

N/A (Archived)

Bugfixes and minor features Backports

New Features, Active Development

Server 1.8

Compatible

Preferred

Recommended

Server 2.0

Compatible

Preferred

Recommended

Server 2.5

Compatible

Preferred

Recommended

Server 3.0

Compatible

Preferred

Recommended

Server 4.0

Compatible

Recommended

Server 4.1

Compatible

Recommended

To take advantage of all features offered by Couchbase Server, you need to know what version of the Java SDK provides compatibility for the features you want to use. The following matrix shows which versions of the Couchbase Java SDK support the major features of each version of Couchbase Server.

Table 2. Couchbase Server and SDK Supported Version Matrix
Server 1.8 Server 2.0 Server 2.5 Server 3.0 Server 4.0

Basic Features

CRUD Operations

Since 1.0

View Querying APIs

Since 1.1

Geospatial Views

Not Supported

1.1 - 1.4

Since 2.1

Advanced Features

Durability Requirements

Since 1.1

Carrier Publication Configuration

Not Supported

Since 1.4

SSL Connectivity

Not Supported

Since 2.0

Bulk Operations

Since 1.0

N1QL Querying

Since 2.0 (experimental)

Since 2.2

Multi-Dimensional Scaling

Not Supported

Since 2.2

Administrative Features

Administrative API

Since 1.0

Contributing

Couchbase welcomes community contributions to the Java SDK. The Java SDK source code is available on GitHub.