Rake TasksΒΆ
The neo4j-core
gem (automatically included with the neo4j
gem) includes some rake tasks which make it easy to install and manage a Neo4j server in the same directory as your Ruby project.
Note
If you are using zsh, you need to prefix any rake tasks with arguments with the noglob command, e.g. $ noglob bundle exec rake neo4j:install[community-latest]
.
- neo4j:install
Arguments:
version
andenvironment
(environment default is development)Example:
rake neo4j:install[community-latest,development]
Downloads and installs Neo4j into
$PROJECT_DIR/db/neo4j/<environment>/
For the
version
argument you can specify eithercommunity-latest
/enterprise-latest
to get the most up-to-date stable version or you can specify a specific version with the formatcommunity-x.x.x
/enterprise-x.x.x
- neo4j:config
Arguments:
environment
andport
Example:
rake neo4j:config[development,7100]
Configure the port which Neo4j runs on. This affects the HTTP REST interface and the web console address. This also sets the HTTPS port to the specified port minus one (so if you specify 7100 then the HTTP port will be 7099)
- neo4j:start
Arguments:
environment
Example:
rake neo4j:start[development]
Start the Neo4j server
Assuming everything is ok, point your browser to http://localhost:7474 and the Neo4j web console should load up.
- neo4j:start
Arguments:
environment
Example:
rake neo4j:shell[development]
Open a Neo4j shell console (REPL shell).
If Neo4j isn’t already started this task will first start the server and shut it down after the shell is exited.
- neo4j:start_no_wait
Arguments:
environment
Example:
rake neo4j:start_no_wait[development]
Start the Neo4j server with the
start-no-wait
command- neo4j:stop
Arguments:
environment
Example:
rake neo4j:stop[development]
Stop the Neo4j server
- neo4j:restart
Arguments:
environment
Example:
rake neo4j:restart[development]
Restart the Neo4j server