Connect to SQL Workbench/J

This article describes how to use SQL Workbench/J with Databricks.

Note

This article covers SQL Workbench/J, which is neither provided nor supported by Databricks. To contact the provider, see use the SQL Workbench/J support forum in Google Groups..

Requirements

• SQL Workbench/J.

• The Databricks JDBC Driver. Download the Databricks JDBC Driver onto your local development machine, extracting the DatabricksJDBC42.jar file from the downloaded DatabricksJDBC42-<version>.zip file.

  Note

  This article was tested with macOS, SQL Workbench/J Build 130, Zulu OpenJDK 21.0.1, and Databricks JDBC Driver 2.6.36.

  For Databricks authentication, if you are not using Databricks personal access token authentication, you can skip generating a personal access token later in these requirements. For more information about available Databricks authentication types, see Authentication settings for the Databricks JDBC Driver.

• A cluster or SQL warehouse in your Databricks workspace.

  • Compute configuration reference.

  • Create a SQL warehouse.

• The connection details for your cluster or SQL warehouse, specifically the Server Hostname, Port, and HTTP Path values.

  • Get connection details for a Databricks compute resource.

• A Databricks personal access token. To create a personal access token, follow the steps in Databricks personal access tokens for workspace users.

  Note

  As a security best practice when you authenticate with automated tools, systems, scripts, and apps, Databricks recommends that you use OAuth tokens.

  If you use personal access token authentication, Databricks recommends using personal access tokens belonging to service principals instead of workspace users. To create tokens for service principals, see Manage tokens for a service principal.

Steps to connect to Workbench/J

To connect to Workbench/J, do the following:

1. Launch SQL Workbench/J.

2. Select File > Connect window.

3. In the Select Connection Profile dialog, click Manage Drivers.

   1. In the Name field, type Databricks.

   2. In the Library field, click the Select the JAR file(s) icon. Browse to the directory where you extracted the DatabricksJDBC42.jar file from the downloaded DatabricksJDBC42-<version>.zip file, and select the JAR file. Then click Choose.

   3. Verify that the Classname field is populated with com.databricks.client.jdbc.Driver.

   4. Click OK.

4. Click the Create a new connection profile icon.

   1. Type a name for the profile.

   2. In the Driver field, select Databricks (com.databricks.client.jdbc.Driver).

   3. In the URL field, enter the JDBC URL for your Databricks resource. For the URL field syntax for JDBC URLs, see Authentication settings for the Databricks JDBC Driver.

   4. Click Test.

   5. Click OK twice.

Additional resources

• SQL Workbench/J

• Support