Neo4j::Driver
home :: https://github.com/neo4jrb/neo4j-ruby-driver
This repository contains 2 implementation of a neo4j driver for ruby:
neo4j-java-driverbased on official java implementation. It provides a thin wrapper over java driver (only in jruby).neo4j-ruby-driverbased 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. Please follow the instructions to install either from package or source.
Add SEABOLT_LIB environment variable with the location of the installed library.
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:
$ bin/setup
FFI based same as above but with SEABOLT_LIB variable set (e.g. on Mac OSX):
$ SEABOLT_LIB=~/seabolt/build/dist/lib/libseabolt17.dylib bin/setup
Please note that seabolt has to be installed separately: https://github.com/neo4j-drivers/seabolt
In order to run test by running rake spec you may have to set your own NEO4J_BOLT_URL URI or it will
fallback to bolt://localhost:7687.
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.