Couchbase Scala SDK Installation

Installation instructions for the Couchbase Scala Client.

This page gives full installation instructions for the Scala SDK. In most cases, the Quickstart Guide should be enough to get you up and running if you’re in a hurry.

Prerequisites

The Scala SDK is tested against LTS versions of Oracle JDK and OpenJDK — see our compatibility docs. The underlying OS normally makes no difference, but library incompatibilities in Alpine Linux makes a workaround necessary for this OS.

The Couchbase Scala SDK 3.9 Client supports Scala 2.12, 2.13, and 3.3 through 3.7 (inclusive).

Installing the SDK

The Couchbase Scala SDK is available on the Maven repository, packaged for Scala 2.12, 2.13, and 3.

With SBT Projects

It can be included in your SBT build like this:

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

This will automatically use the correct build for your Scala version.

With Gradle Projects

It can be included in your build.gradle like this for 2.12:

dependencies {
    compile group: 'com.couchbase.client', name: 'scala-client_2.12', version: '3.9.2'
}

or 2.13 or 3.3 through 3.7:

dependencies {
    compile group: 'com.couchbase.client', name: 'scala-client_3', version: '3.9.2'
}

There is a dedicated 2.13 build too, but from the 3.9.0 release we recommended 2.13 users use the 3.x build instead. If the 2.13 build is explicitly desired, it can be included like this:

dependencies {
    compile group: 'com.couchbase.client', name: 'scala-client_2.13', version: '3.9.2'
}

With Maven Projects

It can be included in your Maven pom.xml like this for 2.12:

<dependencies>
    <dependency>
        <groupId>com.couchbase.client</groupId>
        <artifactId>scala-client_2.12</artifactId>
        <version>3.9.2</version>
    </dependency>
</dependencies>

or 2.13 or 3.3 through 3.7:

<dependencies>
    <dependency>
        <groupId>com.couchbase.client</groupId>
        <artifactId>scala-client_3</artifactId>
        <version>3.9.2</version>
    </dependency>
</dependencies>

There is a dedicated 2.13 build too, but from the 3.9.0 release we recommended 2.13 users use the 3.x build instead. If the 2.13 build is explicitly desired, it can be included like this:

<dependencies>
    <dependency>
        <groupId>com.couchbase.client</groupId>
        <artifactId>scala-client_2.13</artifactId>
        <version>3.9.2</version>
    </dependency>
</dependencies>

Using a Snapshot Version

Couchbase publishes pre-release snapshot artifacts to the Central Portal Snapshots Repository. If you wish to use a snapshot version, you’ll need to tell your build tool about this repository.

Maven
Gradle (Groovy)

pom.xml

<repositories>
    <repository>
        <name>Central Portal Snapshots</name>
        <id>central-portal-snapshots</id>
        <url>https://central.sonatype.com/repository/maven-snapshots/</url>
        <releases>
            <enabled>false</enabled>
        </releases>
        <snapshots>
            <enabled>true</enabled>
        </snapshots>
    </repository>
</repositories>

build.gradle

repositories {
    mavenCentral()
    maven {
        url "https://central.sonatype.com/repository/maven-snapshots/"
        mavenContent { snapshotsOnly() }
    }
}