Welcome to Neo4j.rb’s documentation!¶
- Upgrade Guide
- Rake Tasks
- created_at, updated_at
- id property (primary key)
- When to Use?
- Relationship Creation
- Query and Loading existing relationships
- Accessing related nodes
- Advanced Usage
- Additional methods
- Regarding: from and to
- Unique IDs
- Query Examples
- The schema file
- Integrate Neo4j.rb with ActiveRecord migrations
- Migration Helpers
- Additional Resources
- Helper Gems
Neo4j.rb (the neo4j and neo4j-core gems) is a Ruby Object-Graph-Mapper (OGM) for the Neo4j graph database. It tries to follow API conventions established by ActiveRecord and familiar to most Ruby developers but with a Neo4j flavor.
- (software) A dynamic, open source programming language with a focus on simplicity and productivity. It has an elegant syntax that is natural to read and easy to write.
- Graph Database
- (computer science) A graph database stores data in a graph, the most generic of data structures, capable of elegantly representing any kind of data in a highly accessible way.
- (databases) The world’s leading graph database
If you’re already familiar with ActiveRecord, DataMapper, or Mongoid, you’ll find the Object Model features you’ve come to expect from an O*M:
- Indexes / Constraints
Because relationships are first-class citizens in Neo4j, models can be created for both nodes and relationships.
Additional features include¶
- A chainable arel-inspired query builder
- Migration framework
- Ruby 1.9.3+ (tested in MRI and JRuby)
- Neo4j 2.1.0 + (version 4.0+ of the gem is required to use neo4j 2.2+)