CloudBeaver Documentation

DOWNLOAD pdf

DBeaver Proxy driver

Note: This feature is available in Enterprise and Team editions only.

Table of contents

Overview

DBeaver Proxy Driver is a JDBC driver that allows third-party applications to connect to databases configured in CloudBeaver. Instead of setting up multiple database drivers and handling complex authentication mechanisms, you can connect to databases through a single proxy driver.

It is useful for:

  • Users of BI tools like Tableau, JasperReports, Metabase, or BIRT who need to access databases managed in CloudBeaver.
  • Developers who want to connect external applications to CloudBeaver-hosted databases without direct access to database credentials.

See the Tableau connection example.

Download

The DBeaver Proxy Driver repository is available on GitHub. You can download the latest version on the releases page.

Set up DBeaver Proxy Driver
  1. Download the driver.
  2. Add the driver to your tool. You can configure the Proxy Driver in any JDBC-compatible tool by adding the jar files to the tool’s driver settings.
  3. As an administrator, enable the Proxy Driver in Settings -> Administration -> Server Configuration -> DBeaver Proxy Driver.
  4. Generate an API access token. See Token generation for details.

Connecting to the database

To establish a connection, specify the following parameters:

JDBC URL

JDBC URLs for the DBeaver Proxy Driver follow this format:

jdbc:dbeaver-upd:<server-host>:<server-port>:<project>:<connection>

Where:

Placeholder Description
<server-host> The server hostname or IP address.
<server-port> The server port.
<project> The project name. In CloudBeaver, the only available project is Shared.
<connection> The connection ID or the name of the database connection in CloudBeaver.

To find the connection ID or name, right-click your database in Database Navigator, select Open, and view the ID and Name in the opened window.

Properties

API token authentication:

  • dbeaver.token: The Proxy Driver requires an Access token for authentication.

User/password authentication:

  • dbeaver.user: Specifies the username for authentication.
  • dbeaver.password: Specifies the password for authentication.

Note: Database-specific driver properties appear only after establishing a connection.

Driver class name

Use the following driver class name - com.dbeaver.jdbc.upd.driver.UPDDriver.

Limitations

Currently, the driver supports only basic queries and database operations. It does not yet support:

  • Opening more than five connections.
  • Editing date/time values.
  • Performing dump/restore operations.
  • Switching schemas.
  • Handling special data types (e.g., timestamp, arrays).
  • Executing complex queries (e.g., JOIN operations).