DataGrip integration with Databricks

Note

This article covers DataGrip, which is neither provided nor supported by Databricks. To contact the provider, see DataGrip Support.

DataGrip is an integrated development environment (IDE) for database developers that provides a query console, schema navigation, explain plans, smart code completion, real-time analysis and quick fixes, refactorings, version control integration, and other features.

This article describes how to use your local development machine to install, configure, and use DataGrip to work with databases in Databricks.

Note

This article was tested with macOS, Databricks JDBC Driver version 2.6.36, and DataGrip version 2023.3.1.

Requirements

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

  • A Linux, macOS, or Windows operating system.

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

  • A Databricks cluster or SQL warehouse to connect with DataGrip.

Step 1: Install DataGrip

Download and install DataGrip.

  • Linux: Download the .zip file, extract its contents, and then follow the instructions in the Install-Linux-tar.txt file.

  • macOS: Download and run the .dmg file.

  • Windows: Download and run the .exe file.

For more information, see Install DataGrip on the DataGrip website.

Step 2: Configure the Databricks JDBC Driver for DataGrip

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

  1. Start DataGrip.

  2. Click File > Data Sources.

  3. In the Data Sources and Drivers dialog box, click the Drivers tab.

  4. Click the + (Driver) button to add a driver.

  5. For Name, enter Databricks.

  6. On the General tab, in the Driver Files list, click the + (Add) button.

  7. Click Custom JARs.

  8. Browse to and select the DatabricksJDBC42.jar file that you extracted earlier, and then click Open.

  9. For Class, select com.databricks.client.jdbc.Driver.

  10. Click OK.

Step 3: Connect DataGrip to your Databricks databases

  1. In DataGrip, click File > Data Sources.

  2. On the Data Sources tab, click the + (Add) button.

  3. Select the Databricks driver that you added in the preceding step.

  4. On the General tab, for URL, enter the value of the JDBC URL field for your Databricks resource. For the JDBC URL field syntax, see Authentication settings for the Databricks JDBC Driver.

    Note

    The ConnCatalog driver capability setting must be specified on the JDBC URL, otherwise schemas cannot be identified.

  5. Click Test Connection.

    Tip

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

  6. If the connection succeeds, on the Schemas tab, check the boxes for the schemas that you want to be able to access, for example All schemas.

  7. Click OK.

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

Step 4: Use DataGrip to browse tables

Use DataGrip to access tables in your Databricks workspace.

  1. In DataGrip, in the Database window, expand your resource node, expand the schema you want to browse, and then expand tables.

  2. Double-click a table. The first set of rows from the table are displayed.

Repeat the instructions in this step to access additional tables.

To access tables in other schemas, in the Database window’s toolbar, click the Data Source Properties icon. In the Data Sources and Drivers dialog box, on the Schemas tab, check the box for each additional schema you want to access, and then click OK.

Step 5: Use DataGrip to run SQL statements

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

  1. In DataGrip, click File > New > SQL File.

  2. Enter a name for the file, for example select_trips.

  3. In the select_trips.sql file tab, enter the following SQL statement:

    SELECT * FROM samples.nyctaxi.trips;

  4. Select the SELECT statement.

  5. On the file tab’s toolbar, click the Execute icon.

Next steps