Databases

The Databases tool is used to create connections to existing Neo4j databases. The tool will show a Database card for each database already configured.

Database cards

Each database card will show the following information:

  • Name: user-defined name of the database connection

  • Private/Public indicator: Private indicates that only authorized users can see it, Public indicates that everyone in your Organization can see it. Also, a shield icon will appear if the Neo4j database connection is secure.

  • Neo4j connection URL: bolt or neo4j URL

  • Neo4j database name: Neo4j database name, can be empty if connecting to the default database

  • User Icons: indicates which users have access to the Database card

  • Add User+ icon: click this to add additional users to the card

  • Edit icon: click this to edit the card

  • Test button: click this to test the connection

  • Delete button: click this to delete the card

New Database Card

To create a new database connection, use the File > New Connection menu. A dialog will be appear with the following fields:

  • Name: the name of the connection

  • Connection URL: the Neo4j connection URL

  • Database Name: the Neo4j database name

  • Public: turn on switch to make this card public

  • Encrypted switch: turn on switch to indicate that the connection to Neo4j should be encrypted

  • Proxy switch: turn on switch to proxy the connection through the App server

  • Username: the Neo4j username

  • Password: the Neo4j password

Username and Password are stored in encrypted in the web browser local storage. They are not stored in the server. For Public cards, each user will need to know the username/password and re-enter it by editing the card.

Click the Create button to create the card.

Edit Database Card

Click the Edit button to Edit the card. Here you can update all of the information that you entered in the New Database card. To update credentials, you will need to click the Update Credentials link.

Testing connections

Click the Test button to test the connection to the database. A green checkmark will appear once the connection is successfully tested and verified.

If your Neo4j database is not SSL-enabled, then you can try to proxy through the App server. To do so, turn on the Proxy switch in the database card. Web browser security prevents HTTPS sites from connecting directly to a non SSL-enabled connection, therefore the need to proxy. Note that your Neo4j database must be reachable from the same network the App server is on. If using Cypher Workbench over the internet, then this means your database must be available over the internet for the proxy to work. Some features may not be available through proxied connections.

Different types of connections

Cypher Workbench is accessed via HTTPS. The web browser will prevent Neo4j connections orginating through the web browser to connect to non SSL-enabled Neo4j installations, unless you are accessing Neo4j installations on your local machine, i.e. you are using neo4j://localhost:7687 or similar.

The following table describes the different types of Neo4j database installations and how to configure them within Cypher Workbench. Encrypted refers to the setting of the Encrypted switch in the database connection card, Proxied refers to the Proxy switch in the database connection card.

Table 1. Neo4j Database Types
Type Neo4j Protocol Encrypted Proxied Note

Local install

bolt:// or neo4j://

No

No

Connection established directly between web browser and Neo4j.

Non SSL-enabled server install

bolt:// or neo4j://

No

Yes

Some features may not be available. Since the Cypher Workbench server is being used to proxy the connection, Neo4j instances not available on the public internet cannot be reached.

SSL-enabled server install

bolt://, bolt+s://, bolt+ssc://, neo4j://, neo4j+s://, neo4j+ssc://

Yes if bolt:// or neo4j://, No if other types

No

Connection established directly between web browser and Neo4j.

Aura

neo4j://, neo4j+s://, neo4j+ssc://

Yes if neo4j://, No if other types

No

Connection established directly between web browser and Neo4j.

Note: To SSL enable Neo4j, following these instructions: https://neo4j.com/docs/operations-manual/current/security/ssl-framework/