Neo4j::Driver

home :: https://github.com/neo4jrb/neo4j-ruby-driver

This repository contains 2 implementation of a neo4j driver for ruby:

  • neo4j-java-driver based on official java implementation. It provides a thin wrapper over java driver (only in jruby).
  • neo4j-ruby-driver based on seabolt and ffi. Available on all rubies (including jruby) and all platforms supported by seabolt.

Installation

neo4j-java-driver

Add this line to your application's Gemfile:

gem 'neo4j-java-driver'

And then execute:

$ bundle

Or install it yourself as:

$ gem install neo4j-java-driver

neo4j-ruby-driver

As a prerequisite seabolt must be installed.

On macOS

$ brew install michael-simons/homebrew-seabolt/seabolt

On other systems please follow the instructions to install seabolt either from package or source. Make sure the libseabolt17 ends up in a system lib path e.g. /usr/local/lib

Add this line to your application's Gemfile:

gem 'neo4j-ruby-driver'

And then execute:

$ bundle

Or install it yourself as:

$ gem install neo4j-ruby-driver

Usage

Both drivers implement identical API and can be used interchangeably. The API is to highest possible degree consistent with the official java driver. At this moment The Neo4j Drivers Manual v1.7 along with the ruby version of the code fragments and the ruby specs provide the only documentation.

Neo4j Java Driver 1.7 API can be helpful as well..

Development

This gem includes 2 different implementations: java driver based and another one using seabolt via ffi

For java driver based:

$ driver=java bin/setup

FFI based same as above but with driver variable set:

$ bin/setup

Testing

To run the tests the following tools need to be installed:

$ brew install python
$ pip3 install --user git+https://github.com/klobuczek/[email protected]#egg=boltkit
$ neoctrl-install -e 4.0.2 servers
$ neoctrl-configure servers/neo4j-enterprise-4.0.2 dbms.directories.import= dbms.default_listen_address=::
$ neoctrl-set-initial-password pass servers/neo4j-enterprise-4.0.2
$ neoctrl-start servers/neo4j-enterprise-4.0.2

To run the test using ruby driver:

$ driver=ruby bin/setup
$ driver=ruby rspec spec

To run the test using java driver:

$ driver=java bin/setup
$ driver=java rspec spec

In case of heap space memory error (org.neo4j.driver.exceptions.DatabaseException: Java heap space), you should limit the dbms memory, for example:

$ neoctrl-configure servers/neo4j-enterprise-4.0.2 dbms.memory.pagecache.size=600m dbms.memory.heap.max_size=600m dbms.memory.heap.initial_size=600m dbms.directories.import= dbms.connectors.default_listen_address=::

Contributing

Suggestions, improvements, bug reports and pull requests are welcome on GitHub at https://github.com/neo4jrb/neo4j-ruby-driver.

License

The gem is available as open source under the terms of the MIT License.