Skip to content
andreasronge edited this page Apr 19, 2012 · 36 revisions

“Cypher” is a declarative graph query language that allows for expressive and efficient querying of the graph store without having to write traversals through the graph structure in code. Neo4j.rb provides two ways of using cypher: express queries as Strings or use the Neo4j.rb Cypher DSL.

Cypher

The cypher language is described here: Neo4j Cypher Docuementation

q = Neo4j._query("START n=node(42) RETURN n")
q.first(:n) #=> the @node
q.columns.first => :n

Cypher DSL

See Neo4j#query method.

Using start,match,where,ret

You can use start, match, where and ret method if you want think it improves the readability.

The following:

Neo4j.query do
 start node(3)
 where n[:name] == 'kalle'
 ret n 
end

Is the same as

Neo4j.query{ node(3); n[:name] == 'kalle'; n }
# same as START n=node(1) RETURN n

Notice the last value in the block is the return value.

Start Nodes

Every query describes a pattern, and in that pattern one can have multiple start points. A start point is a relationship or a node that form the starting points for a pattern match. You can either introduce start points by id, or by index lookups. Note that trying to use an index that doesn’t exist will throw an exception.

Node By Id

Binding a node as a start point is done with the node(*) function.

Neo4j.query{ node(3) }
# same as START n=node(1) RETURN n

The node above will be assigned a variable automatically. To get the variable name: use the columns method, example:

result = Neo4j.query{ node(3) }
result.columns # => [:n0]
result.first[:n0] #=> returns the node 3

Notice that the query result is a once forward Enumerable object. To read the result more then once use #to_a to create an array of the Enumerable.

The query method allows parameters for start nodes and relationships. Example:

Change variable binding

There is a #as method which will change the name of the columns. Example:

result = Neo4j.query{ node(3).as(:x }
result.columns # => [:x]
result.first[:x] #=> returns the node 3

Using existing nodes and relationship

Neo4j.query(node){|n| n }
# same as START n0=node(n.neo_id) RETURN n0

Multiple nodes by id

Selected by an array in the argument:

Neo4j.query([node1, node2]){|n| n }
# same as START n0=node(node1.neo_id, node2.neo_id) RETURN n0

Example 5.2. Basic Friend finding based on social neighborhood

See http://docs.neo4j.org/chunked/snapshot/cypher-cookbook-friend-finding.html Let say we want to express the following Cypher Query:

START joe=node(some node id)
MATCH joe-[:knows]->friend-[:knows]->friend_of_friend, joe-[r?:knows]->friend_of_friend
WHERE r IS NULL
RETURN friend_of_friend.name, COUNT(*)
ORDER BY COUNT(*) DESC, friend_of_friend.name

This can be done like this:

Neo4j.query(joe_node) do |joe|
  friends_of_friends = node(:friends_of_friends)
  joe > ':knows' > node(:friend) > ':knows' > friends_of_friends
  r = rel('r?:knows').as(:r)
  joe > r > friends_of_friends
  r.exist?
  ret(friends_of_friends[:name], count).desc(count).asc(friends_of_friends[:name])
end

Or like this using the outgoing instead of the > operator

Neo4j.query(joe_node) do |joe|
 friends_of_friends = joe.outgoing(:knows).outgoing(:knows)
 r = rel('r?:knows').as(:r)
 joe > r > friends_of_friends
 r.exist?
 ret(friends_of_friends[:name], count).desc(count).asc(friends_of_friends[:name])
end
Clone this wiki locally