Developer Guides Getting Started Getting Started What is a Graph Database? Intro to Graph DBs Video Series Concepts: RDBMS to Graph Concepts: NoSQL to Graph Getting Started Resources Neo4j Graph Platform Graph Platform Overview Neo4j Database Neo4j Desktop Intro Neo4j… Read more →
Neo4j Desktop User Interface Guide
This article demonstrates how to use Neo4j Desktop for managing instances of Neo4j locally for development.
It helps if you have read the section on graph databases.
If you haven’t already, download Neo4j. Instructions for setting up the application will be shown after you click the download.
Using the provided instructions, follow Step 1 to install and start the Neo4j Desktop application. Step 2 on the download page instructions shows you how to set up your first project and database and how to open the Neo4j in the browser, but we want to cover this step in more detail.
If you are opening Neo4j Desktop for the first time, it should ask you to register the software with an activation key. This activation key is generated when you first download Neo4j Desktop and will be displayed on the download confirmation page. While we can copy it to the clipboard and paste it into the provided input in Neo4j Desktop, we also recommend copying it to a safe place as a backup (local file, password vault, or another method).
Copy this activation key into the Software registration form and click Activate to continue.
As a new user to Neo4j Desktop, you will be greeted with a new sample database containing Movies and Actors.
Clicking the Browser Guide link for the Sample database will open up the Neo4j Browser with a Browser Guide that will guide you through your first queries on this Neo4j database.
The sample database is created using a randomly generated password, which is stored within Neo4j Desktop and used by Neo4j Browser to authenticate against the database. You can reset this password in the Administration tab on the Manage screen.
From the Projects icon on the left-side menu, choose (or create) a project. A panel will display on the right to show the databases in your project and the plugins available or installed.
To create a database, click in the dotted square that says
Then click the Create a Local Graph button.
Next, you will type in a name for your database set a password.
You can also choose a specific version of Neo4j (the default is latest version).
A small icon next to each version number in the dropdown menu will show which versions have been downloaded already.
Once the info is filled in, then click Create.
It may take a few minutes to download the version and actually create the database.
You have now created your own graph database! Now we will walk through some tools to interact with the database and data.
The Start button in the bottom right hand corner of each database card will Start the database. Once started, there will be a button in the bottom right hand corner to Stop the database.
To manage a database, click the three-dots icon in the top right hand of the card and click Manage.
At the top of the screen, you will see the database name and an icon to signify its status. Directly underneath are three buttons to Start, Stop, or Restart the database.
The Open Folder button will open up the root folder for this database. The arrow icon to the right of this button will allow you to open up additional folders related to this database, for example the Plugins or Logs folders.
The Open Terminal button will open up a new terminal window in the root folder of the database.
Below these buttons are several tabs for information and settings.
Details tab shows the description, version, and the status of your database along with some statistics for the database.
When the database is running, it will also show port numbers and addresses needed to interact with the database (screenshot below).
Logs tab will show all of the streaming log output from the database.
Settings tab displays the configuration values for the database.
These can be changed, if needed.
Once changes are made, you can apply them, and Desktop will offer to restart the database (necessary for changes to take effect).
Plugins tab, you can see what plugins are available (or you have installed) to use with Neo4j.
Currently, Neo4j Desktop has plugins for APOC, GraphQL, and Graph Algorithms.
Short descriptions of each are shown in the Neo4j Desktop pane.
To add these functionalities, simply click Install and Restart for the plugin.
Upgrade tab shows the list of all Neo4j versions, as well as the version this instance is currently running.
To change the version, choose one from the list and click Upgrade to this version in the right pane.
The last tab is
This tab just allows you to set a new password for your database.
If you have feedback or questions on how to use Neo4j Desktop, feel free to reach out to us. You can submit messages to us through the Neo4j Desktop category on the Neo4j Community website. If you have spot any bugs, please create an issue in the Neo4j Desktop Github Responsitory
Now that we covered the basics of Neo4j Desktop, you can start working with data using our query language, Cypher. You can also get a feel for interacting with Neo4j through Neo4j Browser. The Neo4j Sandbox walks you through demos of popular use cases in Neo4j and helps you get more familiar with the interfaces and Cypher. If you’re ready to dive in, feel free to check out how to import your data to Neo4j. Our Language Guides section shows you how to create an application in your preferred programming language to interact with data in Neo4j.