This section describes how to install Neo4j on Windows.
Neo4j can be run as a console application or as a Windows service.
For development, Neo4j can also be installed using Neo4j Desktop.
Go to https://neo4j.com/download/ and follow the instructions to install Neo4j Desktop on your computer.
Download the latest release from https://neo4j.com/download/other-releases/#releases.
Select the appropriate ZIP distribution.
Change directory to the top-level extracted directory.
Ctrl-Cin the console.
Neo4j can also be run as a Windows service.
Install the service with
bin\neo4j install-service, and start it with
The available commands for
When Neo4j is installed as a service, Java options are stored in the service configuration.
Changes to these options after the service is installed will not take effect until the service configuration is updated.
For example, changing the setting
dbms.memory.heap.max_size in neo4j.conf will not take effect until the service is updated and restarted.
To update the service, run
Then restart the service to run it with the new configuration.
The same applies to the path to where Java is installed on the system.
If the path changes, for example when upgrading to a new version of Java, it is necessary to run the
update-service command and restart the service.
Then the new Java location will be used by the service.
Change memory configuration
echo dbms.memory.heap.initial_size=8g >> conf\neo4j.conf echo dbms.memory.heap.max_size=16g >> conf\neo4j.conf
The Neo4j PowerShell module allows administrators to:
The PowerShell module is installed as part of the ZIP file distributions of Neo4j.
On Windows, it is sometimes necessary to Unblock a downloaded ZIP file before you can import its contents as a module. If you right-click on the ZIP file and choose "Properties" you will get a dialog which includes an "Unblock" button, which will enable you to import the module.
Running scripts has to be enabled on the system. This can, for example, be achieved by executing the following from an elevated PowerShell prompt:
Set-ExecutionPolicy -ExecutionPolicy RemoteSigned
For more information, see About execution policies.
The PowerShell module will display a warning if it detects that you do not have administrative rights.
The module file is located in the bin directory of your Neo4j installation, i.e. where you unzipped the downloaded file. For example, if Neo4j was installed in C:\Neo4j then the module would be imported like this:
This will add the module to the current session.
Once the module has been imported you can start an interactive console version of a Neo4j Server like this:
To stop the server, issue
Ctrl-C in the console window that was created by the command.
Once the module is imported you can query the available commands like this:
Get-Command -Module Neo4j-Management
The output should be similar to the following:
CommandType Name Version Source ----------- ---- ------- ------ Function Invoke-Neo4j 3.4.0 Neo4j-Management Function Invoke-Neo4jAdmin 3.4.0 Neo4j-Management Function Invoke-Neo4jBackup 3.4.0 Neo4j-Management Function Invoke-Neo4jImport 3.4.0 Neo4j-Management Function Invoke-Neo4jShell 3.4.0 Neo4j-Management
The module also supports the standard PowerShell help commands.
Run the following to see examples of help commands:
Get-Help Invoke-Neo4j -examples
List of available commands:
Current status of the Neo4j service:
Install the service with verbose output:
Invoke-Neo4j install-service -Verbose
Available commands for administrative tasks:
The module commands support the common PowerShell parameter of