DBeaver Documentation

DOWNLOAD pdf

Database driver Neptune

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

Table of contents

Overview

This documentation outlines the process of configuring and using AWS Neptune with DBeaver.

To manage databases using AWS Neptune in DBeaver, establishing a connection is essential. This is done by selecting the Neptune option in the database connection settings of DBeaver. For those new to this process, our Creating a Connection article provides detailed guidance.

Tip: Users with Ultimate and Team editions of DBeaver can connect to their AWS Neptune databases using the Cloud Explorer.

Neptune specialty

AWS Neptune, as a graph database service, is specialized for use cases involving highly connected data, such as social networks, recommendation engines, fraud detection, and knowledge graphs. Unlike traditional relational databases, Neptune is optimized for storing and querying graph data models, including property graphs and RDF (Resource Description Framework) data. For more detailed information, refer to the AWS Neptune database documentation.

Important: In DBeaver, AWS Neptune is read-only.

For a detailed overview of the supported features and capabilities of AWS Neptune within DBeaver, please see the section on Powering Neptune with DBeaver.

Setting up

This section provides an overview of DBeaver's settings for establishing a direct connection and the configuration of secure connections using SSH, Proxies, AWS SSM and Kubernetes.

Neptune connection settings

In this subsection, we will outline the settings for establishing a direct connection to a Neptune database using DBeaver. Correctly configuring your connection ensures seamless interaction between DBeaver and your Neptune database.

The page of the connection settings requires you to fill in specific fields to establish the initial connection.

Field Description
Host name Enter the address of your AWS Neptune database here.
Port Enter the port number for your Neptune database. The default Neptune port is 8192.
Authentication Choose the type of authentication you want to use for the connection. For detailed guides on authentication types, please refer to the following articles:

- AWS Neptune IAM
- DBeaver Profile

You can also read about security in DBeaver PRO.
Connection Details Provide additional connection details if necessary.
Driver Name This field will be auto-filled based on your selected driver type.
Driver Settings If there are any specific driver settings, configure them here. For detailed guide on driver properties please refer to the official AWS Neptune documentation.

Connection details

The Connection Details section in DBeaver allows for further customization of your Neptune connection. This includes options for adjusting the Navigator View, setting up Security measures, applying Filters, configuring Connection Initialization settings, and setting up Shell Commands. Each of these settings can significantly impact your database operations and workflow. For detailed guides on these settings, please refer to the following articles:

Secure connection configurations

DBeaver supports secure connections to your Neptune database. Guidance on configuring such connections, specifically SSH, Proxy, Kubernetes and AWS SSM connections, can be found in various referenced articles. For a comprehensive understanding, please refer to these articles:

Powering Neptune with DBeaver

DBeaver provides a host of features designed for Neptune databases. This includes the ability to view schemas, along with numerous unique capabilities aimed at optimizing database operations.

Neptune database objects

DBeaver lets you view a range of Neptune database objects, such as:

  • Schemas

    • Tables
      • Columns

Neptune additional features in DBeaver

DBeaver provides additional features compatible with Neptune, but not exclusive to it:

Category Feature
Data Transfer Data Export
Schema Management Schema Compare