Databricks Connect usage requirements

This article provides usage requirements for Databricks Connect. For information about Databricks Connect, see What is Databricks Connect?.

Workspace requirements

To use Databricks Connect to connect to your workspace:

• Your Azure Databricks account and workspace must have Unity Catalog enabled. See Get started with Unity Catalog and Enable a workspace for Unity Catalog.

• The Databricks Runtime version of your compute must be greater than or equal to the Databricks Connect package version. Databricks recommends that you use the most recent Databricks Connect package that matches your Databricks Runtime version.

  To use features that are available in later versions of the Databricks Runtime, you must upgrade the Databricks Connect package. See the Databricks Connect release notes for a list of available Databricks Connect releases. For Databricks Runtime version release notes, see Databricks Runtime release notes versions and compatibility.

• If you are connecting to a cluster, your target cluster must use a cluster access mode of Assigned or Shared. See Access modes.

Local environment requirements

To install Databricks Connect, your local development environment must meet the following requirements:

Python

• Authentication to Databricks is configured. Depending on the Databricks authentication type there might be requirements:

  • For OAuth user-to-machine (U2M) authentication, you must use the Databricks CLI to authenticate before you run your code. See the Databricks Connect for Python tutorial.

  • OAuth user-to-machine (U2M) authentication and OAuth machine-to-machine (M2M) authentication are supported on Databricks SDK for Python 0.19.0 and above. To update your project's installed version of the Databricks SDK for Python, see Get started with the Databricks SDK for Python.

• Python 3 is installed, and the minor version of Python installed meets the version requirements in the version compatibility table below.

• If you are using user-defined functions (UDFs), the local minor version of Python matches the minor version of Python of the Databricks Runtime version of the cluster compute. To find the minor Python version of the Databricks Runtime version of your cluster, refer to the System environment section of the Databricks Runtime release notes for that version. See Databricks Runtime release notes versions and compatibility.

Scala

• Authentication to Databricks is configured. Depending on the Databricks authentication type there may be requirements:

  • For OAuth user-to-machine (U2M) authentication, you must use the Databricks CLI to authenticate before you run your code. See the Databricks Connect for Scala tutorial.

  • OAuth user-to-machine (U2M) authentication and OAuth machine-to-machine (M2M) authentication are supported on Databricks SDK for Java 0.18.0 and above. To update your project's installed version of the Databricks SDK for Java, see Get started with the Databricks SDK for Java.

  • For Databricks Connect for Databricks Runtime 13.3 LTS and above, for Scala, Databricks Connect includes the Databricks SDK for Java. This SDK implements the Databricks unified authentication standard.

• The Java Development Kit (JDK) is installed. Databricks recommends that the version of your JDK installation matches the JDK version on your Azure Databricks cluster. To find the JDK version of the Databricks Runtime on your cluster, refer to the System environment section of the Databricks Runtime release notes or the version compatibility table.

  Note

  Using a JDK version that doesn't match your cluster's JDK version might cause unexpected behavior or prevent your code from running.

• Scala is installed. Databricks recommends that the version of your Scala installation matches the Scala version on your Azure Databricks cluster. To find the Scala version of the Databricks Runtime version of your cluster, refer to the System environment section of the Databricks Runtime release notes or the version compatibility table.

• If you are using user-defined functions (UDFs), the local Scala and Java versions match the Scala and Java versions of the Databricks Runtime version of the cluster. To find the Scala and Java versions of the Databricks Runtime version of your cluster, refer to the System environment section of the Databricks Runtime release notes or the version compatibility table below.

• A Scala build tool, such as sbt, is installed.

Databricks Connect versions

The following table shows supported Databricks Connect and compatible language versions. Databricks Connect version numbers correspond to Databricks Runtime version numbers. See the Databricks Connect release notes for a list of available Databricks Connect releases. For Databricks Runtime version release notes, see Databricks Runtime release notes versions and compatibility.

Python

For UDF support, see Python base environment.

Scala

End-of-support versions

Databricks Connect follows the Databricks Runtime support lifecycles. The following versions have reached end-of-support. If you're using a version of Databricks Connect that has reached end-of-support, upgrade to a supported version.

Python

Scala