DBeaver integration with Databricks

Note

This article covers DBeaver, which is neither provided nor supported by Databricks. To contact the provider, see use the Issues page of the dbeaver/dbeaver repo on GitHub.

DBeaver is a local, multi-platform database tool for developers, database administrators, data analysts, data engineers, and others who need to work with databases. DBeaver supports Databricks as well as other popular databases.

This article describes how to use your local development machine to install, configure, and use the free, open source DBeaver Community Edition (CE) to work with databases in Databricks.

Note

This article was tested with macOS, Databricks JDBC Driver version 2.6.36, and DBeaver CE version 23.3.0.

Requirements

Before you install DBeaver, your local development machine must meet the following requirements:

  • A Linux 64-bit, macOS, or Windows 64-bit operating system. (Linux 32-bit is supported but not recommended.)

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

You must also have a Databricks cluster or SQL warehouse to connect with DBeaver.

Step 1: Install DBeaver

Download and install DBeaver CE as follows:

  • Linux: Download and run one of the Linux installers from the Download page on the DBeaver website. snap and flatpak installation options are provided on this page as well.

  • macOS: Use Homebrew to run brew install --cask dbeaver-community, or use MacPorts to run sudo port install dbeaver-community. A macOS installer is also available from the Download page on the DBeaver website.

  • Windows: Use Chocolatey to run choco install dbeaver. A Windows installer is also available from the Download page on the DBeaver website.

Step 2: Configure the Databricks JDBC Driver for DBeaver

Set up DBeaver with information about the Databricks JDBC Driver that you downloaded earlier.

  1. Start DBeaver.

  2. If you are prompted to create a new database, click No.

  3. If you are prompted to connect to or select a database, click Cancel.

  4. Click Database > Driver Manager.

  5. In the Driver Manager dialog box, click New.

  6. In the Create new driver dialog box, click the Libraries tab.

  7. Click Add File.

  8. Navigate to the folder to which you extracted the Databricks JDBC Driver.

  9. Navigate one level lower to find the .jar file.

  10. Highlight the .jar file and click Open.

  11. On the Settings tab, for Driver Name, enter Databricks.

  12. On the Settings tab, for Class Name, enter com.databricks.client.jdbc.Driver.

  13. Click OK.

  14. In the Driver Manager dialog box, click Close.

Step 3: Connect DBeaver to your Databricks databases

Use DBeaver to connect to the cluster or SQL warehouse to access the databases in your Databricks workspace.

  1. In DBeaver, click Database > New Database Connection.

  2. In the Connect to a database dialog box, on the All tab, click Databricks, and then click Next.

  3. Click the Main tab and enter a value in the JDBC URL field for your Databricks resource. For the JDBC URL field syntax, see Authentication settings for the Databricks JDBC Driver.

  4. Click Test Connection.

    Tip

    You should start your Databricks resource before testing your connection. Otherwise the test might take several minutes to complete while the resource starts.

  5. If the connection succeeds, in the Connection Test dialog box, click OK.

  6. In the Connect to a database dialog box, click Finish.

In the Database Navigator window, a Databricks entry is displayed. To change the connection’s name to make it easier to identify:

  1. Right-click Databricks, and then click Edit Connection.

  2. In the Connection configuration dialog box, click General.

  3. For Connection name, replace Databricks with a different name for the connection.

  4. Click OK.

Repeat the instructions in this step for each resource that you want DBeaver to access.

Step 4: Use DBeaver to browse data objects

Use DBeaver to access data objects in your Databricks workspace such as tables and table properties, views, indexes, data types, and other data object types.

  1. In DBeaver, in the Database Navigator window, right-click the connection that you want to use.

  2. If Connect is enabled, click it. (If Connect is disabled, you are already connected.)

    Tip

    You should start your resource before trying to connect to it. Otherwise the connection might take several minutes to complete while the resource starts.

  3. Expand the connection that you just connected to.

  4. Expand and browse available data objects. Double-click a data object to get more information about it.

Repeat the instructions in this step to access additional data objects.

Step 5: Use DBeaver to run SQL statements

Use DBeaver to load the sample trips table from the samples catalog’s nyctaxi schema.

  1. In DBeaver, in the Database Navigator window, right-click the connection that you want to use.

  2. If Connect is enabled, click it. (If Connect is disabled, you are already connected.)

    Tip

    You should start your resource before trying to connect to it. Otherwise the connection might take several minutes to complete while the resource starts.

  3. Click SQL Editor > New SQL Script.

  4. On the (connection-name) Script-1 tab, enter this SQL statement:

    SELECT * FROM samples.nyctaxi.trips;

  5. Click SQL Editor > Execute SQL script.

Next steps