Graph

Amazon Neptune with DBine

How to connect DBine to Amazon Neptune and what you can do once it's connected. This page is written from what the Amazon Neptune driver says about itself, so it matches the version of DBine you download.

Connect

  1. In DBine, open New connection.
  2. Pick Amazon Neptune in the list of engines.
  3. Fill in the fields below, press Test connection and then Save.

Default port: 8182.

General

FieldDescription
Server requiredThe cluster endpoint (or a full URL, e.g. a tunnel https://localhost:8182).
Example: my-cluster.cluster-xxxx.us-east-1.neptune.amazonaws.com
Port
IAM authentication (SigV4)Turn it on if the cluster has IAM authentication enabled: it signs each request with the credentials below.
On or off.
RegionIf left empty, the one from the profile or AWS_REGION is used.
Example: us-east-1
Only with IAM authentication (SigV4): true.
AuthenticationThe default chain uses environment variables, ~/.aws, SSO or the instance role.
Options: AWS default chain, ~/.aws profile, Access keys
Default: AWS default chain
Only with IAM authentication (SigV4): true.
ProfileExample: default
Only with Authentication: ~/.aws profile.
Access key IDOnly with Authentication: Access keys.
Secret access keyKept in the system keychain, never in DBine's files.
Only with Authentication: Access keys.
Session tokenTemporary credentials only.
Kept in the system keychain, never in DBine's files.
Only with Authentication: Access keys.
Read-onlyOn or off.

SSH tunnel. The connection can go through an SSH server, even through a chain of bastions, with a password, a private key or the SSH agent. The server's fingerprint is checked against known_hosts or confirmed the first time.

SSL/TLS

FieldDescription
Encrypt the connection (TLS)Neptune only accepts HTTPS.
On or off.
Trust the server certificateUseful with an SSH tunnel, where the certificate doesn't match localhost.
On or off.

What the explorer shows

The objects appear right under the connection:

Query editor

The editor uses Cypher, with completion for the connection's objects. Statements and commands run against the database selected in the tab.

What the editor accepts:

Cypher, with statements separated by «;»:
MATCH (p:Person)-[:KNOWS]->(q) WHERE p.age > 30 RETURN p, q LIMIT 25;
CREATE (:Person {name: 'Ana'}) · MERGE (c:City {name: 'Rosario'}) · MATCH (n) DETACH DELETE n
:param name => value   defines $name for the following queries (:params lists them).
:begin · :commit · :rollback   explicit transaction, which stays open between runs.
Nodes and relationships are shown as JSON (~id, ~labels, ~properties).
EXPLAIN / PROFILE in front of a query show its plan (or use the plan buttons).
:use db   changes the session's database (Neo4j, Memgraph Enterprise).

Ready-made templates for new objects:

Tools for Amazon Neptune

Available

  • Graphical execution plans
  • Live query profiler
  • Server monitor
  • Sessions and running queries
  • Cancel another session's query from the sessions list

Not available for Amazon Neptune

  • End a session
  • Locks: who blocks whom
  • Manual transactions (commit and rollback)
  • Index usage
  • Create databases
  • Drop databases
  • Database properties
  • Relations in the ER diagram
  • Visual designer for new objects
  • Rename objects
  • Compare and sync schemas
  • Clone tables
  • Native bulk load when migrating data
  • Users and permissions
  • Backups

Why a tool doesn't apply to an engine, and the details of each one, are in the engine support reference.

Generated from the Amazon Neptune driver 0.1.11, which DBine downloads the first time you connect to Amazon Neptune.

Download DBineAll engines