# DbVisualiser

DbVisualizer is a versatile SQL editor and universal database tool, available as an open-source application for local installation on your workstation. By leveraging the JDBC driver, DbVisualizer enables seamless access to e6data clusters, empowering users with efficient database management capabilities.

## Requirements

* Users of the e6data cluster must use DbVisualiser 23.2.4 or newer.
* Install the latest [e6data jdbc driver](https://docs.e6data.com/product-documentation/~/changes/0iCkDjvnPldS7yucryRX/connectors-and-drivers/jdbc-driver)

## Connection

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

* JDBC URL
* Username 
* Password ([Personal Access Token](https://docs.e6data.com/product-documentation/~/changes/0iCkDjvnPldS7yucryRX/connectors-and-drivers/broken-reference))

<details>

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

Syntax of the JDBC URL required to establish a DB Visualiser connection with the e6data cluster when connecting using the Direct type of connectivity in endpoints:&#x20;

{% 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 DB Visualiser connection with the e6data cluster when connecting via TLS type of connectivity in endpoints:

{% code overflow="wrap" %}

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

{% endcode %}

</details>

1. Click on "Create Database" to establish a new connection.
2. Search and select "Custom" from the connection list.

<figure><img src="https://3484040590-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FeVBYKZm1xFKFFVzS0lRJ%2Fuploads%2FHTvRDJPa8jLBJqpdyvcw%2FScreenshot%202024-02-08%20at%206.47.24%20PM.png?alt=media&#x26;token=a7246363-5d29-4a0b-838d-0e8f422ccd7e" alt=""><figcaption></figcaption></figure>

3. Give the appropriate name for the driver.
4. In the settings format, select the database URL.
5. Give the connection string in the database URL.

<figure><img src="https://3484040590-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FeVBYKZm1xFKFFVzS0lRJ%2Fuploads%2FNUj4rAJ89L3icQP0dSdq%2FScreenshot%202024-02-08%20at%206.49.44%20PM.png?alt=media&#x26;token=22d442fd-92df-41bb-bd00-4238c39fef29" alt=""><figcaption></figcaption></figure>

6. Click "Connect" to add the JDBC jar through the driver manager.
7. Now, open the Driver Manager, provide the name, and JDBC connection string, and add the driver here.

<figure><img src="https://3484040590-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FeVBYKZm1xFKFFVzS0lRJ%2Fuploads%2FlGL4GniD8woTrH6ATIYF%2Fdb%20visualiser%20jdbc%20driver.png?alt=media&#x26;token=4aceae0b-38c2-422f-8b46-4e867d3edca1" alt=""><figcaption></figcaption></figure>

8. Go to the database connection, add the database URL, database user ID, and password, and click on "Connect."

<figure><img src="https://3484040590-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FeVBYKZm1xFKFFVzS0lRJ%2Fuploads%2Foy1OYaGjsYrTCjsFfCS3%2Fdb%20connection%20in%20db%20visualiser.png?alt=media&#x26;token=b9051a85-e7f9-41e4-b8e3-5a67b1da1b56" alt=""><figcaption></figcaption></figure>

## TLS/HTTP

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. (Only required for TLS connectivity type of endpoints.)&#x20;