Skip to main content

DBeaver

You can run SQL from DBeaver to explore your data in your data lakes and relational databases through Dremio.

Supported Versions​

You can use any version of DBeaver for Linux, MacOS, or Windows, except for version 23.0.2.202304091457.

Supported Authentication Method​

Authenticate to Dremio by using a personal access token. To create one, see Create a PAT.

Prerequisites​

Connect to Dremio​

Step 1: Add the JDBC Driver​

You only need to add the Arrow Flight SQL JDBC driver once. You can skip this step if DBeaver already lists this driver in its Driver Manager dialog. To add the JDBC driver, follow these steps:

  1. In the menubar, select Database > Driver Manager.

  2. In the Driver Manager dialog, click New.

  3. In the Settings section, follow these steps:

    1. In the Name field, specify a name for the driver, such as "Arrow Flight SQL JDBC Driver".

    2. In the Driver Type field, ensure that Generic is the selected driver type.

    3. In the Class Name field, specify org.apache.arrow.driver.jdbc.ArrowFlightJdbcDriver.

    4. In the URL Template field, specify jdbc:arrow-flight-sql://data.dremio.cloud:443/ .

    5. In the Default Port field, specify 443.

  4. In the Libraries section, click Add File and select the .jar file for the Arrow Flight SQL JDBC driver.

  5. Click OK.

Step 2: Create a Connection​

Once you've added the Arrow Flight SQL JDBC driver, follow these steps to create a connection to Dremio:

  1. Select Database > New Connection from JDBC URL.

  2. In the dialog that follows, enter jdbc:arrow-flight-sql://data.dremio.cloud:443/. At this point, DBeaver lists the driver in the Drivers field. If the driver is not immediately suggested, type and then delete a character in the input field to refresh suggestions.

  3. Select the JDBC driver and click Next.

  4. In the Connect to a Database dialog, follow these steps:

    1. Select URL as the value for Connect By.

    2. In the JDBC URL field, append ?token=<encoded_pat> to the URL and replace <encoded_pat> with your URL-encoded personal access token.

      note

      If connecting to a non-default project, you must also append &catalog=<project_id> to the URL and replace <project_id> with your project ID.

    3. (Optional) Click Test Connection. If the connection works, the Connection Test dialog opens and indicates that DBeaver is able to connect to Dremio. The connection is not held open. Click OK.

  5. Click Finish.