{"__v":0,"_id":"58a42bb923b12b0f00dc3632","category":{"__v":0,"_id":"58767da4d89ef20f003b6f1e","project":"566c97797831040d003eb3bc","version":"566c97797831040d003eb3bf","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2017-01-11T18:47:00.124Z","from_sync":false,"order":2,"slug":"connecting-to-your-database","title":"Connecting"},"parentDoc":null,"project":"566c97797831040d003eb3bc","user":"57167c775d90dc170060ef97","version":{"__v":10,"_id":"566c97797831040d003eb3bf","project":"566c97797831040d003eb3bc","createdAt":"2015-12-12T21:54:01.970Z","releaseDate":"2015-12-12T21:54:01.970Z","categories":["566c977a7831040d003eb3c0","5716338cb5af590e00a0ff1d","57163947893cbe0e002d75fc","57163f41b5af590e00a0ff35","57cd74d2873de50e00724a2f","57cd7de8baaee30e0093ecc3","57d6ada046dcc30e007dd15e","57fdc2b31646dc0e0010480a","57fdd8b86c9d141900d87bf1","58767da4d89ef20f003b6f1e"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-02-15T10:21:45.972Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"GrapheneDB supports the two endpoints available in Neo4j for connecting remotely to a database:\n\n* Using [Bolt binary protocol](/docs/connecting-to-your-database#section-connect-using-bolt-binary-protocol)\n* Using [HTTP REST API](http://docs.graphenedb.com/docs/connecting-to-your-database#section-connect-using-http-rest-api)\n\nIf 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. \n[block:callout]\n{\n  \"type\": \"warning\",\n  \"body\": \"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.\",\n  \"title\": \"Keep in mind:\"\n}\n[/block]\n## Retrieving your database connection settings\n\nAll the connection details can be found in the Connection tab within the database management UI:\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/8619c3e-connection.png\",\n        \"connection.png\",\n        939,\n        598,\n        \"#f4f4f4\"\n      ]\n    }\n  ]\n}\n[/block]\nConnect 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](/docs/connecting-to-your-database#section-connect-using-bolt-binary-protocol).\n\nConnect 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](http://docs.graphenedb.com/docs/connecting-to-your-database#section-connect-using-http-rest-api).\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Important\",\n  \"body\": \"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](/docs/graphenedb-database-users) to read more on how to manage users for your database.\"\n}\n[/block]\n## Developing your application\n\nIf 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. \n\nPlease take a look at our [Language center](/docs/language-center-overview)  to explore options to connect to GrapheneDB using a driver. \n\n## Connect using Bolt binary protocol\n\nBolt 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](http://neo4j.com/blog/neo4j-3-0-milestone-1-release/).\n\nAll the necessary parameters to connect to your database via Bolt can be found in the  Connection tab of your database management interface:\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/89410ab-bolt_url.png\",\n        \"bolt_url.png\",\n        923,\n        344,\n        \"#f7f6f6\"\n      ]\n    }\n  ]\n}\n[/block]\nUse 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](/docs/graphenedb-database-users).\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"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.\",\n  \"title\": \"Information\"\n}\n[/block]\n## Connect using HTTP REST API\n\nTo 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.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/daf4dee-http_url.png\",\n        \"http_url.png\",\n        975,\n        365,\n        \"#f7f6f6\"\n      ]\n    }\n  ]\n}\n[/block]\nMore on database users can be found [here](/docs/graphenedb-database-users).\n\nWhen 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](http://neo4j.com/docs/developer-manual/current/http-api/).","excerpt":"","slug":"connecting-to-your-database","type":"basic","title":"Connecting to your database"}

Connecting to your database


GrapheneDB supports the two endpoints available in Neo4j for connecting remotely to a database: * Using [Bolt binary protocol](/docs/connecting-to-your-database#section-connect-using-bolt-binary-protocol) * Using [HTTP REST API](http://docs.graphenedb.com/docs/connecting-to-your-database#section-connect-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. [block:callout] { "type": "warning", "body": "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.", "title": "Keep in mind:" } [/block] ## Retrieving your database connection settings All the connection details can be found in the Connection tab within the database management UI: [block:image] { "images": [ { "image": [ "https://files.readme.io/8619c3e-connection.png", "connection.png", 939, 598, "#f4f4f4" ] } ] } [/block] 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](/docs/connecting-to-your-database#section-connect-using-bolt-binary-protocol). 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](http://docs.graphenedb.com/docs/connecting-to-your-database#section-connect-using-http-rest-api). [block:callout] { "type": "warning", "title": "Important", "body": "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](/docs/graphenedb-database-users) to read more on how to manage users for your database." } [/block] ## 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](/docs/language-center-overview) 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](http://neo4j.com/blog/neo4j-3-0-milestone-1-release/). All the necessary parameters to connect to your database via Bolt can be found in the Connection tab of your database management interface: [block:image] { "images": [ { "image": [ "https://files.readme.io/89410ab-bolt_url.png", "bolt_url.png", 923, 344, "#f7f6f6" ] } ] } [/block] 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](/docs/graphenedb-database-users). [block:callout] { "type": "info", "body": "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.", "title": "Information" } [/block] ## 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. [block:image] { "images": [ { "image": [ "https://files.readme.io/daf4dee-http_url.png", "http_url.png", 975, 365, "#f7f6f6" ] } ] } [/block] More on database users can be found [here](/docs/graphenedb-database-users). 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](http://neo4j.com/docs/developer-manual/current/http-api/).