Skip to content

Latest commit

 

History

History
59 lines (37 loc) · 2.92 KB

DBeaver.md

File metadata and controls

59 lines (37 loc) · 2.92 KB
Raw

DBeaver

Before proceeding, ensure you have configured your environment.

Download the latest version of DBeaver to use the Driver in DBeaver.

Adding the Amazon Neptune JDBC Driver to DBeaver

  1. Download the Neptune JDBC driver JAR file and note the directory it is saved/located in.

  2. Launch the DBeaver application.

  3. Navigate to Database > Driver Manager and click New to add a new Driver.

  4. Under the Libraries tab, click Add File and add the JAR file.

  5. Click Find Class to populate the Driver class in the dropdown menu.

    driver

  6. Fill out the fields on the right with a Driver Name, Class Name, and URL Template. Class Name should match the Driver class in the Libraries tab.

  7. The Default Port for Neptune is 8182, but this can be left blank if it is in the URL Template. Check No authentication and Allow Empty Password as desired.

Example for connecting to an instance without IAM authentication:

driver

Example for connecting to an instance with IAM authentication. Note that your AWS credentials must be configured.

driver

Connecting to Amazon Neptune using DBeaver - External SSH Tunnel

  1. If connecting from outside the Neptune cluster's VPC, ensure you have followed the configuration instructions.
  2. Navigate to Database > New Database Connection.
  3. Select the Neptune driver that was added in the previous steps.
  4. Click Finish to complete setup.

Connecting to Amazon Neptune using DBeaver - Internal SSH Tunnel

DBeaver has the ability to configure the SSH tunnel within the application.

  1. Navigate to Database > New Database Connection.

  2. Select the Neptune driver that was added in the previous steps.

  3. Navigate to the SSH tab and fill out the fields. Fill out the HOST/IP, User Name, and select Public Key as the Authentication Method. A Private key is required. The configuration instructions mentioned above can provide more context for why this is required. Under Advanced settings the Local host and Local port if following the above instructions should be your localhost and the port used for Neptune. The Remote host and Remote port should be the Neptune URL and port.

    driver

    1. Click Test tunnel configuration to validate the SSH tunnel, and then Finish to complete setup.