DBeaver

This article explains how to use DBeaver with Exasol.

DBeaver is a free universal SQL client and database administration tool. For more information, refer to the DBeaver website.

Exasol takes no responsibility for changes in functionality or terms of use for third-party tools. For more details about the compatibility and use of these tools with Exasol, refer to the respective software vendor’s website.

Environment

The following procedure uses the community edition of DBeaver on Windows.

Prerequisite

  • Your Exasol SaaS database must be running. For more information, see Database Management.

  • The IP address of the host where the tool is running must be in the allowed IP address list. For more information, see Network Security.

  • Exasol JDBC driver is installed
  • DBeaver is installed

Get JDBC Driver and Connection Details

To connect to your Exasol SaaS database from a tool you need a valid connection string. You must also allow network access to the database from the tool, and make sure that the latest Exasol JDBC driver is installed.

  1. On the Databases page in the web console, click on Connect via tools on the cluster that you want to connect to.

    connect via tools

  2. In the wizard, enter the IP address of the client or server that will connect to the database and click Add IP, then click Next. This will add the IP address to the list of IP addresses that are allowed network access to the cluster. The allow list is found on the Security page in the web console. For more information, see Network Security.

    If the IP address is already present in the allow list, just click Next.

    enter ip address

  3. If the latest JDBC driver for your operating system is not already installed, select the driver type and operating system and click on Download to download the latest driver to your local system. For more information about how to install the driver, see JDBC Driver.

    download driver

  4. Click on Next to view your connection details:

    connection details

  5. Copy the Connection string, Port, and User name values from the Connect details dialog. You will need to enter these details in the tool that should connect to the Exasol SaaS database.

  6. To generate a new Personal Access Token (PAT) to use for authentication in the client, click on the Password row, then click on Copy to copy the PAT to your clipboard. For more information, see Personal Access Token.

    generated pat

    The generated PAT is only shown once and cannot be retrieved after you have closed the wizard.

  7. Click on Done to close the wizard.

Update the Driver in DBeaver

The latest Exasol JDBC driver must be installed in DBeaver. To update the driver, do the following:

  1. Open DBeaver. If the Connect to database dialog is displayed, click Cancel.
  2. Click Database > Driver Manager.
  3. In the Name list, select Exasol and click Edit.

  4. To update the driver, in the Libraries tab, select com.exasol:exasol-jdbc:RELEASE and then click Download/Update.

  5. In Download driver files screen, click the Version column, select the latest version, and click Download. The version must be greater than 7.1.0.

  6. Once the download is complete, close the Download driver files.

Connect to your Database

  1. Click Database > New Database Connection.
  2. In the Select your database screen, click All, select Exasol, and then click Next.

    3. Select New Database Connection

  3. In the Exasol Connection Settings screen, enter the following connection details from the Get JDBC Driver and Connection Details procedure:
    • Host List: Enter the Enter the Host string that you copied from the web console.
    • Port: Enter the port number 8563.
    • User name: Enter the user name that you copied from the web console.
    • Password: Enter the Personal Access Token that you copied from web console.

    connection details saas

  4. To test the connection, click on Test Connection. If the connection test fails, check the connection string and authentication details.

The Exasol database is now listed in the Database Navigator section in DBeaver. 

Successful Connection

Execute SQL Statements

Before you continue to execute SQL statements, make sure that enhanced metadata usage is enabled.

  1. Click Window > Preferences > Connections > Metadata, and, if necessary, select the Open separate connection for metadata read check box. To save the changes, click Apply and Close.

    2. Metadata Settings

  2. To open an SQL editor, click SQL Editor > SQL Editor.

    Open SQL Editor

  3. Enter an SQL statement in the SQL editor and execute it. The result of the query is shown in the Result tab.

    Execute Queries

Known Issues

Problem: If a script contains multiple semicolons or newlines, DBeaver will not be able to identify where the script ends.

Solution: A simple workaround is to highlight the whole script and execute it as a single step.

Problem: R scripts on DBeaver are not executed.

Solution: This issue can occur when DBeaver is running on a platform that uses CRLF line endings. R scripts must be compiled with LF (Linux) line endings. To change the line endings to LF, click File > Convert Line Delimiters to > LF.