README.md in neoid-0.0.2 vs README.md in neoid-0.0.5.alpha
- old
+ new
@@ -1,7 +1,11 @@
# Neoid
+[](http://travis-ci.org/elado/neoid)
+
+
+
Make your ActiveRecords stored and searchable on Neo4j graph database, in order to make fast graph queries that MySQL would crawl while doing them.
Neoid to Neo4j is like Sunspot to Solr. You get the benefits of Neo4j speed while keeping your schema on your plain old RDBMS.
Neoid doesn't require JRuby. It's based on the great [Neography](https://github.com/maxdemarzi/neography) gem which uses Neo4j's REST API.
@@ -12,216 +16,285 @@
## Installation
Add to your Gemfile and run the `bundle` command to install it.
- gem 'neoid'
+```ruby
+gem 'neoid', git: 'git://github.com/elado/neoid.git'
+```
-
**Requires Ruby 1.9.2 or later.**
## Usage
-### First app configuration:
+### Rails app configuration:
In an initializer, such as `config/initializers/01_neo4j.rb`:
- ENV["NEO4J_URL"] ||= "http://localhost:7474"
+```ruby
+ENV["NEO4J_URL"] ||= "http://localhost:7474"
- uri = URI.parse(ENV["NEO4J_URL"])
+uri = URI.parse(ENV["NEO4J_URL"])
- $neo = Neography::Rest.new(neo4j_uri.to_s)
+$neo = Neography::Rest.new(uri.to_s)
- Neography::Config.tap do |c|
- c.server = uri.host
- c.port = uri.port
+Neography.configure do |c|
+ c.server = uri.host
+ c.port = uri.port
- if uri.user && uri.password
- c.authentication = 'basic'
- c.username = uri.user
- c.password = uri.password
- end
- end
+ if uri.user && uri.password
+ c.authentication = 'basic'
+ c.username = uri.user
+ c.password = uri.password
+ end
+end
- Neoid.db = $neo
+Neoid.db = $neo
+```
+`01_` in the file name is in order to get this file loaded first, before the models (initializers are loaded alphabetically).
-`01_` in the file name is in order to get this file loaded first, before the models (files are loaded alphabetically).
-
If you have a better idea (I bet you do!) please let me know.
### ActiveRecord configuration
#### Nodes
For nodes, first include the `Neoid::Node` module in your model:
- class User < ActiveRecord::Base
- include Neoid::Node
- end
+```ruby
+class User < ActiveRecord::Base
+ include Neoid::Node
+end
+```
-
This will help to create a corresponding node on Neo4j when a user is created, delete it when a user is destroyed, and update it if needed.
-Then, you can customize what fields will be saved on the node in Neo4j, by implementing `to_neo` method:
+Then, you can customize what fields will be saved on the node in Neo4j, inside neoidable configuration:
+```ruby
+class User < ActiveRecord::Base
+ include Neoid::Node
+
+ neoidable do |c|
+ c.field :slug
+ c.field :display_name
+ c.field :display_name_length do
+ self.display_name.length
+ end
+ end
+end
+```
- class User < ActiveRecord::Base
- include Neoid::Node
-
- def to_neo
- {
- slug: slug,
- display_name: display_name
- }
- end
- end
-You can use `neo_properties_to_hash`, a helper method to make things shorter:
+#### Relationships
+Let's assume that a `User` can `Like` `Movie`s:
- def to_neo
- neo_properties_to_hash(%w(slug display_name))
- end
+```ruby
+# user.rb
-#### Relationships
+class User < ActiveRecord::Base
+ include Neoid::Node
-Let's assume that a `User` can `Like` `Movie`s:
+ has_many :likes
+ has_many :movies, through: :likes
+ neoidable do |c|
+ c.field :slug
+ c.field :display_name
+ end
+end
- # user.rb
- class User < ActiveRecord::Base
- include Neoid::Node
-
- has_many :likes
- has_many :movies, through: :likes
-
- def to_neo
- neo_properties_to_hash(%w(slug display_name))
- end
- end
+# movie.rb
+class Movie < ActiveRecord::Base
+ include Neoid::Node
- # movie.rb
+ has_many :likes
+ has_many :users, through: :likes
- class Movie < ActiveRecord::Base
- include Neoid::Node
-
- has_many :likes
- has_many :users, through: :likes
-
- def to_neo
- neo_properties_to_hash(%w(slug name))
- end
- end
+ neoidable do |c|
+ c.field :slug
+ c.field :name
+ end
+end
- # like.rb
+# like.rb
- class Like < ActiveRecord::Base
- belongs_to :user
- belongs_to :movie
- end
+class Like < ActiveRecord::Base
+ belongs_to :user
+ belongs_to :movie
+end
+```
+Now let's make the `Like` model a Neoid, by including the `Neoid::Relationship` module, and define the relationship (start & end nodes and relationship type) options with `neoidable` config and `relationship` method:
-Now let's make the `Like` model a Neoid, by including the `Neoid::Relationship` module, and define the relationship (start & end nodes and relationship type) options with `neoidable` method:
+```ruby
+class Like < ActiveRecord::Base
+ belongs_to :user
+ belongs_to :movie
- class Like < ActiveRecord::Base
- belongs_to :user
- belongs_to :movie
+ include Neoid::Relationship
- include Neoid::Relationship
- neoidable start_node: :user, end_node: :movie, type: :likes
- end
+ neoidable do |c|
+ c.relationship start_node: :user, end_node: :movie, type: :likes
+ end
+end
+```
-
Neoid adds `neo_node` and `neo_relationships` to nodes and relationships, respectively.
So you could do:
- user = User.create!(display_name: "elado")
- user.movies << Movie.create("Memento")
- user.movies << Movie.create("Inception")
+```ruby
+user = User.create!(display_name: "elado")
+user.movies << Movie.create("Memento")
+user.movies << Movie.create("Inception")
- user.neo_node # => #<Neography::Node…>
- user.neo_node.display_name # => "elado"
+user.neo_node # => #<Neography::Node…>
+user.neo_node.display_name # => "elado"
- rel = user.likes.first.neo_relationship
- rel.start_node # user.neo_node
- rel.end_node # user.movies.first.neo_node
- rel.rel_type # 'likes'
+rel = user.likes.first.neo_relationship
+rel.start_node # user.neo_node
+rel.end_node # user.movies.first.neo_node
+rel.rel_type # 'likes'
+```
+## Index for Full-Text Search
+Using `search` block inside a `neoidable` block, you can store certain fields.
+
+```ruby
+# movie.rb
+
+class Movie < ActiveRecord::Base
+ include Neoid::Node
+
+ neoidable do |c|
+ c.field :slug
+ c.field :name
+
+ c.search do |s|
+ # full-text index fields
+ s.fulltext :name
+ s.fulltext :description
+
+ # just index for exact matches
+ s.index :year
+ end
+ end
+end
+```
+
+Records will be automatically indexed when inserted or updated.
+
## Querying
You can query with all [Neography](https://github.com/maxdemarzi/neography)'s API: `traverse`, `execute_query` for Cypher, and `execute_script` for Gremlin.
### Gremlin Example:
These examples query Neo4j using Gremlin for IDs of objects, and then fetches them from ActiveRecord with an `in` query.
-Of course, you can store using the `to_neo` all the data you need in Neo4j and avoid querying ActiveRecord.
+Of course, you can store using the `neoidable do |c| c.field ... end` all the data you need in Neo4j and avoid querying ActiveRecord.
**Most popular categories**
- gremlin_query = <<-GREMLIN
- m = [:]
+```ruby
+gremlin_query = <<-GREMLIN
+ m = [:]
- g.v(0)
- .out('movies_subref').out
- .inE('likes')
- .inV
- .groupCount(m).iterate()
+ g.v(0)
+ .out('movies_subref').out
+ .inE('likes')
+ .inV
+ .groupCount(m).iterate()
- m.sort{-it.value}.collect{it.key.ar_id}
- GREMLIN
+ m.sort{-it.value}.collect{it.key.ar_id}
+GREMLIN
- movie_ids = Neoid.db.execute_script(gremlin_query)
+movie_ids = Neoid.db.execute_script(gremlin_query)
- Movie.where(id: movie_ids)
+Movie.where(id: movie_ids)
+```
-
Assuming we have another `Friendship` model which is a relationship with start/end nodes of `user` and type of `friends`,
**Movies of user friends that the user doesn't have**
- user = User.find(1)
+```ruby
+user = User.find(1)
- gremlin_query = <<-GREMLIN
- u = g.idx('users_index')[[ar_id:'#{user.id}']][0].toList()[0]
- movies = []
+gremlin_query = <<-GREMLIN
+ u = g.idx('users_index')[[ar_id:user_id]].next()
+ movies = []
- u
- .out('likes').aggregate(movies).back(2)
- .out('friends').out('likes')
- .dedup
- .except(movies).collect{it.ar_id}
- GREMLIN
+ u
+ .out('likes').aggregate(movies).back(2)
+ .out('friends').out('likes')
+ .dedup
+ .except(movies).collect{it.ar_id}
+GREMLIN
- movie_ids = Neoid.db.execute_script(gremlin_query)
+movie_ids = Neoid.db.execute_script(gremlin_query, user_id: user.id)
- Movie.where(id: movie_ids)
+Movie.where(id: movie_ids)
+```
+`.next()` is in order to get a vertex object which we can actually query on.
-`[0].toList()[0]` is in order to get a pipeline object which we can actually query on.
+### Full Text Search
+```ruby
+# will match all movies with full-text match for name/description. returns ActiveRecord instanced
+Movie.neo_search("*hello*").results
+
+# same as above but returns hashes with the values that were indexed on Neo4j
+Movie.search("*hello*").hits
+
+# search in multiple types
+Neoid.neo_search([Movie, User], "hello")
+
+# search with exact matches (pass a hash of field/value)
+Movie.neo_search(year: 2013).results
+```
+
+## Inserting records of existing app
+
+If you have an existing database and just want to integrate Neoid, configure the `neoidable`s and run in a rake task or console
+
+```ruby
+[ Like.includes(:user).includes(:movie), OtherRelationshipModel ].each { |model| model.all.each(&:neo_update) }
+
+NodeModel.all.each(&:neo_update)
+```
+
+This will loop through all of your relationship records and generate the two edge nodes along with a relationship (eager loading for better performance).
+The second line is for nodes without relationships.
+
+For large data sets use pagination.
+Better interface for that in the future.
+
+
## Behind The Scenes
Whenever the `neo_node` on nodes or `neo_relationship` on relationships is called, Neoid checks if there's a corresponding node/relationship in Neo4j. If not, it does the following:
### For Nodes:
1. Ensures there's a sub reference node (read [here](http://docs.neo4j.org/chunked/stable/tutorials-java-embedded-index.html) about sub reference nodes)
-2. Creates a node based on the ActiveRecord, with the `id` attribute and all other attributes from `to_neo`
+2. Creates a node based on the ActiveRecord, with the `id` attribute and all other attributes from `neoidable`'s field list
3. Creates a relationship between the sub reference node and the newly created node
4. Adds the ActiveRecord `id` to a node index, pointing to the Neo4j node id, for fast lookup in the future
Then, when it needs to find it again, it just seeks the node index with that ActiveRecord id for its neo node id.
@@ -233,37 +306,59 @@
2. Then, it calls `neo_node` on both, in order to create the Neo4j nodes if they're not created yet, and creates the relationship with the type from the options.
3. Add the relationship to the relationship index.
## Testing
-Neoid tests run on a regular Neo4j database, on port 7574. You probably want to have it running on a different instance than your development one.
+In order to test your app or this gem, you need a running Neo4j database, dedicated to tests.
-In order to do that:
+I use port 7574 for this. To run another database locally:
-Copy the Neo4j folder to a different location,
+Copy the entire Neo4j database folder to a different location,
**or**
-symlink `bin`, `lib`, `plugins`, `system`, copy `conf` and create an empty `data` folder.
+symlink `bin`, `lib`, `plugins`, `system`, copy `conf` to a single folder, and create an empty `data` folder.
Then, edit `conf/neo4j-server.properties` and set the port (`org.neo4j.server.webserver.port`) from 7474 to 7574 and run the server with `bin/neo4j start`
+## Testing Your App with Neoid (RSpec)
-Download, install and configure [neo4j-clean-remote-db-addon](https://github.com/jexp/neo4j-clean-remote-db-addon). For the test database, leave the default `secret-key` key.
+In `environments/test.rb`, add:
+```ruby
+ENV["NEO4J_URL"] = 'http://localhost:7574'
+```
+In your `spec_helper.rb`, add the following configurations:
+
+```ruby
+config.before :all do
+ Neoid.clean_db(:yes_i_am_sure)
+end
+
+config.before :each do
+ Neoid.reset_cached_variables
+end
+```
+
+## Testing This Gem
+
+Just run `rake` from the gem folder.
+
## Contributing
Please create a [new issue](https://github.com/elado/neoid/issues) if you run into any bugs. Contribute patches via pull requests. Write tests and make sure all tests pass.
+## Heroku Support
+Unfortunately, as for now, Neo4j add-on on Heroku doesn't support Gremlin. Therefore, this gem won't work on Heroku's add on. You should self-host a Neo4j instance on an EC2 or any other server.
+
+
## To Do
-* `after_update` to update a node/relationship.
-* Allow to disable sub reference nodes through options
-* Execute queries/scripts from model and not Neography (e.g. `Movie.neo_gremlin(gremlin_query)` with query that outputs IDs, returns a list of `Movie`s)
-* Rake task to index all nodes and relatiohsips in Neo4j
+[To Do](https://github.com/elado/neoid/blob/master/TODO.md)
+
---
-Developed by [@elado](http://twitter.com/elado)
\ No newline at end of file
+Developed by [@elado](http://twitter.com/elado)