Programming language: Java
Tags: Database    
Latest version: v3.0.0-beta.2

Couchbase alternatives and similar packages

Based on the "Database" category

Do you think we are missing an alternative of Couchbase or a related project?

Add another 'Database' Package


Couchbase JVM Clients

This repository contains the third generation of the Couchbase SDKs on the JVM ("3.0").


This repository contains the following projects:

  • core-io: the core library for all language bindings
  • java-client: the Java language binding
  • scala-client: the Scala language binding

You'll also find utility libraries and integration components at the toplevel (i.e for tracing).

Documentation is now available for Java and Scala


Stable releases are pushed to maven central.

For Java:


For Scala:


or if you use sbt:

libraryDependencies += "com.couchbase.client" %% "scala-client" % "1.0.1"


You can always also just build it from source:

$ git clone https://github.com/couchbase/couchbase-jvm-clients.git
$ cd couchbase-jvm-clients
$ make

Yes, we need make because maven doesn't support the setup we need and neither does gradle. If you want to build for different Scala versions, after the first make you can do this through:

```shell script $ ./mvnw -Dscala.compat.version=2.13 -Dscala.compat.library.version=2.13.1 clean install $ ./mvnw -Dscala.compat.version=2.11 -Dscala.compat.library.version=2.11.12 clean install

+ The two `mvn` runs are to cross-compile the Scala SDK for Scala 2.11, and 2.13
+ Couchbase only officially provides, tests and supports a Scala 2.12 build.  
Our community kindly added the capability to create builds for Scala 2.11 and 2.13, and users are of course welcome to create such builds; but Couchbase cannot provide support for them.
+ When building for Scala 2.11, JDK 8 should be used. If JDK 11 is used then goal scala:doc-jar will fail
+ Default `scala.compat.`X properties are defined in file [.mvn/maven.config]
+ You can always go into one of the sub-directories like `core-io` to only build or test an 
individual project:
    ```shell script
    cd scala-client
    ../mvnw -DskipTests clean install
+ Use `-DskipTests` to skip testing.

### Testing 

You can test like this:

```shell script
$ ./mvnw clean test -fae

Branches & Release Trains

Since this monorepo houses different versions of different artifacts, release train names have been chosen to identify a collection of releases that belong to the same train.

These trains are named after historic computers for your delight.

Tags in each branch are named branchname-ga for the initial GA release, and then subsequently branchname-sr-n for each service release. See the tag information for specifics of what's in there.

Release Train Java-Client Scala-Client Core-Io Tracing-Opentelemetry Tracing-Opentracing
colossus 3.0.x 1.0.x 2.0.x 0.2.x 0.2.x

Testing Infos

To cover all tests, the suite needs to be run against the following topologies, but by default it runs against the mock. Recommended topologies:

  • 1 node, no replica
  • 2 nodes, 1 replica
  • 2 nodes, 2 replicas

IDE Configuration


Scala code is automatically formatted on compile with the tool scalafmt. To make IntelliJ use the same settings:

Editor -> Code Style -> Scala, change formatter to scalafmt and check Reformat on file save

(mvn validate can be used from command-line to force reformat)