# DBeaver

The open-source tool [DBeaver Community](https://dbeaver.io/) is a powerful SQL editor and universal database tool. It is installed as a local application on your workstation. You can use DBeaver with the [JDBC driver](https://docs.e6data.com/product-documentation/~/revisions/W5MExJCuvHiG1ioEcgOy/connectors-and-drivers/jdbc-driver) to access e6data clusters.

## Requirements

* Users of the e6data cluster must use DBeaver 23.3.3 or newer.
* Install the latest [e6data jdbc driver](https://docs.e6data.com/product-documentation/~/revisions/W5MExJCuvHiG1ioEcgOy/connectors-and-drivers/jdbc-driver).

## Connection

Get the necessary [connection information](https://docs.e6data.com/product-documentation/~/revisions/W5MExJCuvHiG1ioEcgOy/connectors-and-drivers/broken-reference) for your cluster:

* JDBC URL
* Username&#x20;
* Password ([Personal Access Token](https://docs.e6data.com/product-documentation/~/revisions/W5MExJCuvHiG1ioEcgOy/connectors-and-drivers/broken-reference))

<details>

<summary>Connection string for Direct Connectivity Endpoint</summary>

Syntax of the JDBC URL required to establish a DBeaver connection with the e6data cluster when connecting using the earlier method:

{% code overflow="wrap" %}

```
jdbc:e6data://<host>:<port>/database=<database_name>&catalog=<catalog_name>
```

{% endcode %}

</details>

<details>

<summary>Connection string for TLS Connectivity Endpoint</summary>

Please refer to the syntax of the JDBC URL required to establish a DBeaver connection with the e6data cluster when connecting via endpoints:

{% code overflow="wrap" %}

```
jdbc:e6data://<host_name>:<port>/database=<database_name>&catalog=<catalog_name>&secure=true&cluster-uuid=<cluster_uuid>
```

{% endcode %}

</details>

Use the following steps to prepare DBeaver to access your cluster:

1. Obtain the necessary [connection information](https://docs.e6data.com/product-documentation/~/revisions/W5MExJCuvHiG1ioEcgOy/connectors-and-drivers/broken-reference) for your cluster.
2. Navigate to the database section and proceed to the driver manager.
3. Create a new driver by clicking the "New" button.
4. Provide a suitable driver name.
5. Go to the "Libraries" section and add the e6data JDBC driver by clicking "Add File."
6. Click on "Find class" to proceed.

<figure><img src="https://3484040590-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FeVBYKZm1xFKFFVzS0lRJ%2Fuploads%2FQT7WrNhZMPqUHeG8ZcvO%2FScreenshot%202024-02-08%20at%206.10.06%20PM.png?alt=media&#x26;token=294cd863-0b51-4f42-a178-fdef3df2909b" alt=""><figcaption></figcaption></figure>

7. Go back to settings to ensure the class name is available in the provided field and create the driver.&#x20;
8. Your newly created driver will be available in the database connection.&#x20;
9. Navigate to the Database section and select the new database connection.
10. Now search for the same driver in the new database connection.

<figure><img src="https://3484040590-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FeVBYKZm1xFKFFVzS0lRJ%2Fuploads%2FamoUhRw18fWt38wo60PQ%2FScreenshot%202024-02-08%20at%206.14.50%20PM.png?alt=media&#x26;token=3c2dffd1-dae6-4aa8-b3ae-a057d951afae" alt=""><figcaption></figcaption></figure>

11. Select that driver and proceed to the next step.
12. Add the JDBC URL, username, and password, and test the connection.

<figure><img src="https://3484040590-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FeVBYKZm1xFKFFVzS0lRJ%2Fuploads%2FafOHApHoqL3KoHlHrKuo%2FJDBC-connection%20test.png?alt=media&#x26;token=ebe3647f-b8f7-4cc9-a982-cf5532370617" alt=""><figcaption></figcaption></figure>

### JDBC Driver Class name <a href="#jdbc-driver-class-name" id="jdbc-driver-class-name"></a>

`io.e6.jdbc.driver.E6Driver`

## TLS/HTTPS

e6data utilizes globally trusted certificates, ensuring that the host and port provided by the connection dialogue are adequate. Any e6data cluster necessitating authentication must also employ TLS/HTTPS. If adhering to globally trusted certificate best practices, utilize the cluster’s HTTPS URL in the connection string as detailed in the aforementioned steps.
