An active model wrapper for the Neo4j Graph Database for Ruby.
Switch branches/tags
Clone or download
Latest commit 95db4f8 Aug 4, 2018
Permalink
Failed to load latest commit information.
bin Fix binstub and rubocop. Aug 5, 2016
config Revert "Revert premature merge of metadata branch" Nov 21, 2014
docs Update RakeTasks.rst Aug 2, 2018
lib Refactor, using public_send in place of send Jul 11, 2018
spec Adding companion instance method with scope Jul 11, 2018
test Rubocop: Style/ExpandPathArguments May 22, 2018
.agignore Not there yet, but slowly slowly... Feb 5, 2016
.gitignore add: vagrant comment Sep 20, 2017
.overcommit.yml Fix rubocop in overcommit Jul 31, 2015
.pullreview.yml More alignment of PullReview with rubocop config Dec 29, 2014
.rspec Use `--require spec_helper` option Dec 9, 2015
.rubocop.yml Update rubocop. re--auto-get-config May 22, 2018
.rubocop_todo.yml Rubocop: Style/ExpandPathArguments May 22, 2018
.travis.yml Turn this back off for master May 22, 2018
.yardopts YARD custom templates to generate reStructuredText files for API docu… Mar 24, 2015
CHANGELOG.md Merge branch '9.2.x' May 22, 2018
CONTRIBUTING.md Add information about docker Sep 22, 2017
CONTRIBUTORS Update contributors list, use github history for constantly up to dat… Apr 21, 2015
Dockerfile Fix Dockerfile May 11, 2018
Gemfile ... May 21, 2018
Guardfile Moving SchemaMigration changes outside migration. Aug 4, 2016
ISSUE_TEMPLATE.md Spelling relevant correctly is a good start. Jan 19, 2017
LICENSE prepare for rubyforge release of gem. Added license file Oct 23, 2008
PULL_REQUEST_TEMPLATE.md Update PULL_REQUEST_TEMPLATE.md Nov 20, 2017
README.md No need for this warning anymore Apr 20, 2018
Rakefile I don't *think* that we need these... Aug 3, 2016
Vagrantfile Back to the other ports... Sep 24, 2017
code_of_conduct.md Update code_of_conduct.md Feb 1, 2016
mkdocs.yml Trying to configure mkdocs to see if that fixes RTD Feb 4, 2015
neo4j.gemspec Rubocop: Style/ExpandPathArguments May 22, 2018

README.md

Welcome to Neo4j.rb

Code Status

Actively Maintained Build Status Coverage Status Code Climate PullReview stats

Issues

Next Release In Progress In Master

Post an issue

Get Support

Documentation

All new documentation will be done via our readthedocs site, though some old documentation has yet to be moved from our wiki (also there is the neo4j-core wiki)

Contact Us

StackOverflow Gitter Twitter

Introduction

Neo4j.rb is an Active Model compliant Ruby/JRuby wrapper for the Neo4j graph database. It uses the neo4j-core and active_attr gems.

Neo4j is a transactional, open-source graph database. A graph database manages data in a connected data structure, capable of representing any kind of data in a very accessible way. Information is stored in nodes and relationships connecting them, both of which can have arbitrary properties. To learn more visit What is a Graph Database?

With this gem you not only do you get a convenient higher level wrapper around Neo4j, but you have access to a powerful high-level query building interface which lets you take advantage of the power of Neo4j like this:

# Break down the top countries where friends' favorite beers come from
person.friends.favorite_beers.country_of_origin(:country).
  order('count(country) DESC').
  pluck(:country, count: 'count(country)')

It can be installed in your Gemfile with a simple gem 'neo4j'

For a general overview see our website: http://neo4jrb.io/

Winner of a 2014 Graphie for "Best Community Contribution" at Neo4j's Graph Connect conference! 2014 Graphie

Neo4j.rb v4.1.0 was released in January of 2015. Its changes are outlined here and in the announcement message. It will take a little time before all documentation is updated to reflect the new release but unless otherwise noted, all 3.X documentation is totally valid for v4.

Neo4j version support

Neo4j Version v2.x v3.x >= v4.x >= 7.0.3
1.9.x Yes No No No
2.0.x No Yes No No
2.1.x No Yes Yes * Yes
2.2.x No No Yes Yes
2.3.x No No Yes Yes
>= 3.0.0 No No No Yes

* Neo4j.rb >= 4.x doesn't support Neo4j versions before 2.1.5. To use 2.1.x you should upgrade to a version >= 2.1.5

Neo4j feature support

Neo4j Feature v2.x v3.x >= v4.x >= 8.x
Bolt Protocol No No No Yes
Auth No No Yes Yes
Remote Cypher Yes Yes Yes Yes
Transactions Yes Yes Yes Yes
High Availability No Yes Yes Yes
Embedded JVM support Yes Yes Yes Yes

Documentation

  • Website (for an introduction)
  • readthedocs
  • Note: Our GitHub Wiki pages have outdated information. We are in the process of moving all documentation to readthedocs

Legacy (<= 2.x) Documentation

Developers

Original Author

Current Maintainers

Contributing

Always welcome! Please review the guidelines for contributing to this repository.

License

Notice: There are different licenses for the neo4j-community, neo4j-advanced, and neo4j-enterprise jar gems. Only the neo4j-community gem is required by default.