Install Databricks Connect for Scala

note

This article covers Databricks Connect for Databricks Runtime 13.3 LTS and above.

This article describes how to install the Databricks Connect for Scala client. See Databricks Connect for Scala.

Requirements

Before installing Databricks Connect, make sure your workspace and local environment meet the requirements. See Databricks Connect usage requirements.

Install the Databricks Connect client

This section describes how to install the Databricks Connect client with sbt, Maven, or Gradle.

note

If you already have the Databricks extension for Visual Studio Code installed, you can install Databricks Connect for Databricks Runtime 13.3 LTS and above using the extension. See Debug code using Databricks Connect for the Databricks extension for Visual Studio Code.

Add a reference to the Databricks Connect client

To set up the Databricks Connect client, first add a reference to the client. In your Scala project's build file such as build.sbt for sbt, pom.xml for Maven, or build.gradle for Gradle, add the following reference to the Databricks Connect client. Replace the version number with the version of the Databricks Connect library that matches the Databricks Runtime version on your cluster. You can find the Databricks Connect library version numbers in the Maven central repository.

Sbt

libraryDependencies += "com.databricks" % "databricks-connect" % "14.0.0"

Or for Databricks Connect 17.0 and above:

libraryDependencies += "com.databricks" %% "databricks-connect" % "17.0.0"

Maven

XML

<dependency>
  <groupId>com.databricks</groupId>
  <artifactId>databricks-connect</artifactId>
  <version>14.0.0</version>
</dependency>

Or for Databricks Connect 17.0 and above:

XML

<dependency>
  <groupId>com.databricks</groupId>
  <artifactId>databricks-connect_2.13</artifactId>
  <version>17.0.0</version>
</dependency>

Gradle

implementation 'com.databricks.databricks-connect:14.0.0'

Or for Databricks Connect 17.0 and above:

implementation 'com.databricks.databricks-connect_2.13:17.0.0'

Next steps

After you have installed Databricks Connect, you need to configure a connection to Databricks. See Compute configuration for Databricks Connect.