Connecting to your database

GrapheneDB supports the followingtwo endpoints available in Neo4j for connecting remotely to a database:

We recommend you use the Bolt protocol, as it’s being favoured by the Neo Technology team and it's supported by all official drivers.

Retrieving your database connection settings

All the connection details can be found in the Connection tab within the database management UI:

Connect using Bolt with the Bolt URI and the username and password of one of the database users that you can create via a Cypher command for example using Neo4j Browser. Read more on using Bolt.

Connect via HTTP using the HTTP URL and the username and password of one of the database users. Read more on using HTTP REST API.

🚧

Important

If you’ve just provisioned your database you will need to create a new database user to connect to your database. Please take a look at the Database users article to read more on how to manage users for your database.

Cluster connection

If you have deployed a cluster plan, your database Connection tab will show you the different ways you can access to your cluster:

Although we expose connection URLs for each cluster node, it’s highly recommended to use the routing driver connection to let the driver route the transactions to the available cluster members.

🚧

Important

From Neo4j 4.0 the neo4j:// scheme has replaced bolt+routing://. If you are using 4.0 or higher version with a 4 series driver, ensure you are using neo4j:// schema.

Developing your application

If you are developing an application it’s recommended to rely on a driver that handles the communication with the database. There is a wide range of drivers available for Bolt. We recommend you use a supported driver by Neo Technology.

Please take a look at our Language center to explore options to connect to GrapheneDB using a driver.

Connect using Bolt binary protocol

Bolt is a binary protocol for Neo4j, which is designed for high-performance throughputs, using a compact binary encoding over persistent TCP connections. You can find more information on Bolt in the official release notes.

All the necessary parameters to connect to your database via Bolt can be found in the Connection tab of your database management interface.

Use the BOLT URL from the Bolt Connection URI section and a valid username and password from a database user to connect. Please read more on database users here.

Schemes

Single dedicated

Scheme

Driver version

Supported Neo4j

neo4j+s

4.1, 4.0

4.1, 4.0

bolt

1.7

3.5, 3.4, 3.3

Clusters

If you're running a cluster plan (HAx) you will need a scheme that ensures routing, depending on the driver version you're using on your client you should use:

Scheme

Driver version

Supported Neo4j

neo4j+s

4.1, 4.0

4.1, 4.0

bolt+routing

1.7

3.5, 3.4, 3.3

Connect using HTTP transactional API

The Neo4j transactional HTTP endpoint allows you to execute a series of Cypher statements within the scope of a transaction.

To connect to the HTTP REST API directly or using a driver, use the HTTP URL and a database user.database user. You can find the root discovery endpoint URL in the Connection tab of the database management interface.

There is documentation on the HTTP API here.

Connect using Neo4j Browser

Neo4j databases come with a built-in, interactive UI that allows you to explore your database. To open the built-in Neo4j browser UI and connect to your database you can just use the URL that you will find in the "Connecting via Neo4j Browser" section on the Connection page.

📘

Databases in Private Networks with access mode Private

If you have configured the Private Network of your database to be private, you won't be able to connect via Neo4j Browser unless you add the IP you're connecting from to the Private Networks whitelist

Updated 5 days ago

Connecting to your database


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.