Connecting to your database

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

Using Bolt binary protocol
Using HTTP REST API

If you’re starting with Neo4j we recommend you to use the Bolt protocol, as it it’s being favoured by Neo Technology team and supported by all new official drivers.

🚧
Keep in mind:
Please note that Bolt is only available for databases running 3.0.0 or higher. The Neo4j version is displayed in the Overview tab of a database.

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 URL and the username and password of one the users in the Database users section. Read more on using Bolt.

Connect via HTTP REST using the HTTP REST URL and the username and password of one of the users in the Database users section. 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.

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 and HTTP REST. Some are officially provided by Neo Technology, while others are developed and maintained by the community.

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 Connection strings section and a valid username and password from the Database users section to connect. Please read more on database users here.

📘
Information
Please note that Bolt is only available for databases running 3.0.0 or higher. The Neo4j version is displayed in the Overview tab of a database.

Connect using HTTP REST API

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

More on database users can be found here.

When connecting directly instead of using a driver, the transactional HTTP endpoint should be used. It allows to run multiple queries within the scope of a transaction and it supersedes the deprecated HTTP Cypher endpoint. More information on the transactional HTTP endpoint can be found here.