Class: Neo4j::Core::Query

Inherits:
Object
  • Object
show all
Includes:
Enumerable, QueryClauses, QueryFindInBatches
Defined in:
lib/neo4j-core/query.rb

Overview

Allows for generation of cypher queries via ruby method calls (inspired by ActiveRecord / arel syntax)

Can be used to express cypher queries in ruby nicely, or to more easily generate queries programatically.

Also, queries can be passed around an application to progressively build a query across different concerns

See also the following link for full cypher language documentation: docs.neo4j.org/chunked/milestone/cypher-query-lang.html

Defined Under Namespace

Classes: Parameters, PartitionedClauses

Constant Summary collapse

DEFINED_CLAUSES = 
{}
METHODS =

DELETE clause

Returns:

%w(start match optional_match using where create create_unique merge set on_create_set on_match_set remove unwind delete with return order skip limit)
BREAK_METHODS = 
%(with)
CLAUSIFY_CLAUSE = 
proc { |method| const_get(method.to_s.split('_').map(&:capitalize).join + 'Clause') }
CLAUSES = 
METHODS.map(&CLAUSIFY_CLAUSE)
EMPTY =

Returns a CYPHER query string from the object query representation

Examples:

Query.new.match(p: :Person).where(p: {age: 30})  # => "MATCH (p:Person) WHERE p.age = 30

Returns:

  • (String) —

    Resulting cypher query string

' '
NEWLINE = 
"\n"

Class Attribute Summary collapse

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from QueryFindInBatches

#find_each, #find_in_batches

Constructor Details

#initialize(options = {}) ⇒ Query

Returns a new instance of Query.



68
69
70
71
72
73
74
75
 
# File 'lib/neo4j-core/query.rb', line 68

def initialize(options = {})
  @session = options.key?(:session) ? options[:session] : Neo4j::Session.current

  @options = options
  @clauses = []
  @_params = {}
  @params = Parameters.new
end

Class Attribute Details

.pretty_cypher ⇒ Object

Returns the value of attribute pretty_cypher.



65
66
67
 
# File 'lib/neo4j-core/query.rb', line 65

def pretty_cypher
  @pretty_cypher
end

Instance Attribute Details

#clauses ⇒ Object

Returns the value of attribute clauses.



19
20
21
 
# File 'lib/neo4j-core/query.rb', line 19

def clauses
  @clauses
end

Instance Method Details

#&(other) ⇒ Object 



383
384
385
386
387
388
389
390
 
# File 'lib/neo4j-core/query.rb', line 383

def &(other)
  fail "Sessions don't match!" if @session != other.session

  self.class.new(session: @session).tap do |new_query|
    new_query.options = options.merge(other.options)
    new_query.clauses = clauses + other.clauses
  end.params(other._params)
end

#break ⇒ Object

Allows what’s been built of the query so far to be frozen and the rest built anew. Can be called multiple times in a string of method calls

Examples:

# Creates a query representing the cypher: MATCH (q:Person), r:Car MATCH (p: Person)-->q
Query.new.match(q: Person).match('r:Car').break.match('(p: Person)-->q')


204
205
206
 
# File 'lib/neo4j-core/query.rb', line 204

def break
  build_deeper_query(nil)
end

#clause?(method) ⇒ Boolean

Returns:

  • (Boolean) 


401
402
403
404
 
# File 'lib/neo4j-core/query.rb', line 401

def clause?(method)
  clause_class = DEFINED_CLAUSES[method] || CLAUSIFY_CLAUSE.call(method)
  clauses.any? { |clause| clause.is_a?(clause_class) }
end

#context ⇒ Object 



352
353
354
 
# File 'lib/neo4j-core/query.rb', line 352

def context
  @options[:context]
end

#copy ⇒ Object 



392
393
394
395
396
397
398
399
 
# File 'lib/neo4j-core/query.rb', line 392

def copy
  dup.tap do |query|
    to_cypher
    query.instance_variable_set('@params', @params.copy)
    query.instance_variable_set('@partitioned_clauses', nil)
    query.instance_variable_set('@response', nil)
  end
end

#count(var = nil) ⇒ Object 



262
263
264
265
 
# File 'lib/neo4j-core/query.rb', line 262

def count(var = nil)
  v = var.nil? ? '*' : var
  pluck("count(#{v})").first
end

#create(*args) ⇒ Query

CREATE clause

Returns:




# File 'lib/neo4j-core/query.rb', line 133

#create_unique(*args) ⇒ Query

CREATE UNIQUE clause

Returns:




# File 'lib/neo4j-core/query.rb', line 137

#delete(*args) ⇒ Query

DELETE clause

Returns:



157
 
# File 'lib/neo4j-core/query.rb', line 157

METHODS = %w(start match optional_match using where create create_unique merge set on_create_set on_match_set remove unwind delete with return order skip limit)

#each ⇒ Object 



267
268
269
270
271
272
273
274
275
 
# File 'lib/neo4j-core/query.rb', line 267

def each
  response = self.response
  if response.is_a?(Neo4j::Server::CypherResponse)
    response.unwrapped! if unwrapped?
    response.to_node_enumeration
  else
    Neo4j::Embedded::ResultWrapper.new(response, to_cypher, unwrapped?)
  end.each { |object| yield object }
end

#exec ⇒ Boolean

Executes a query without returning the result

Returns:

  • (Boolean) —

    true if successful

Raises:



286
287
288
289
290
 
# File 'lib/neo4j-core/query.rb', line 286

def exec
  response

  true
end

#inspect ⇒ Object 



77
78
79
 
# File 'lib/neo4j-core/query.rb', line 77

def inspect
  "#<Query CYPHER: #{ANSI::YELLOW}#{to_cypher.inspect}#{ANSI::CLEAR}>"
end

#limit(*args) ⇒ Query

LIMIT clause

Returns:




# File 'lib/neo4j-core/query.rb', line 109

#match(*args) ⇒ Query

MATCH clause

Returns:




# File 'lib/neo4j-core/query.rb', line 85

#match_nodes(hash, optional_match = false) ⇒ Object 



247
248
249
250
251
252
253
254
 
# File 'lib/neo4j-core/query.rb', line 247

def match_nodes(hash, optional_match = false)
  hash.inject(self) do |query, (variable, node_object)|
    neo_id = (node_object.respond_to?(:neo_id) ? node_object.neo_id : node_object)

    match_method = optional_match ? :optional_match : :match
    query.send(match_method, variable).where(variable => {neo_id: neo_id})
  end
end

#merge(*args) ⇒ Query

MERGE clause

Returns:




# File 'lib/neo4j-core/query.rb', line 141

#on_create_set(*args) ⇒ Query

ON CREATE SET clause

Returns:




# File 'lib/neo4j-core/query.rb', line 145

#on_match_set(*args) ⇒ Query

ON MATCH SET clause

Returns:




# File 'lib/neo4j-core/query.rb', line 149

#optional_match(*args) ⇒ Query

OPTIONAL MATCH clause

Returns:




# File 'lib/neo4j-core/query.rb', line 89

#optional_match_nodes(hash) ⇒ Object 



256
257
258
 
# File 'lib/neo4j-core/query.rb', line 256

def optional_match_nodes(hash)
  match_nodes(hash, true)
end

#order(*args) ⇒ Query Also known as: order_by

ORDER BY clause

Returns:




# File 'lib/neo4j-core/query.rb', line 105

#parameters ⇒ Object 



356
357
358
359
 
# File 'lib/neo4j-core/query.rb', line 356

def parameters
  to_cypher
  merge_params
end

#params(args) ⇒ Object

Allows for the specification of values for params specified in query

Examples:

# Creates a query representing the cypher: MATCH (q: Person {id: {id}})
# Calls to params don't affect the cypher query generated, but the params will be
# Passed down when the query is made
Query.new.match('(q: Person {id: {id}})').params(id: 12)


215
216
217
 
# File 'lib/neo4j-core/query.rb', line 215

def params(args)
  copy.tap { |new_query| new_query.instance_variable_get('@params').add_params(args) }
end

#partitioned_clauses ⇒ Object 



361
362
363
 
# File 'lib/neo4j-core/query.rb', line 361

def partitioned_clauses
  @partitioned_clauses ||= PartitionedClauses.new(@clauses)
end

#pluck(*columns) ⇒ Object

Return the specified columns as an array. If one column is specified, a one-dimensional array is returned with the values of that column If two columns are specified, a n-dimensional array is returned with the values of those columns

Examples:

Query.new.match(n: :Person).return(p: :name}.pluck(p: :name) # => Array of names
Query.new.match(n: :Person).return(p: :name}.pluck('p, DISTINCT p.name') # => Array of [node, name] pairs


301
302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/neo4j-core/query.rb', line 301

def pluck(*columns)
  fail ArgumentError, 'No columns specified for Query#pluck' if columns.size.zero?

  query = return_query(columns)
  columns = query.response.columns

  case columns.size
  when 1
    column = columns[0]
    query.map { |row| row[column] }
  else
    query.map { |row| columns.map { |column| row[column] } }
  end
end

#pretty_cypher ⇒ Object 



348
349
350
 
# File 'lib/neo4j-core/query.rb', line 348

def pretty_cypher
  to_cypher(pretty: true)
end

#print_cypher ⇒ Object 



365
366
367
 
# File 'lib/neo4j-core/query.rb', line 365

def print_cypher
  puts to_cypher(pretty: true).gsub(/\e[^m]+m/, '')
end

#remove(*args) ⇒ Query

REMOVE clause

Returns:




# File 'lib/neo4j-core/query.rb', line 121

#reorder(*args) ⇒ Object

Clears out previous order clauses and allows only for those specified by args



179
180
181
182
183
184
 
# File 'lib/neo4j-core/query.rb', line 179

def reorder(*args)
  query = copy

  query.remove_clause_class(OrderClause)
  query.order(*args)
end

#response ⇒ Object 



232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/neo4j-core/query.rb', line 232

def response
  return @response if @response

  cypher = to_cypher
  pretty_cypher = to_cypher(pretty: true) if self.class.pretty_cypher

  @response = if session_is_new_api?
                @session.query(self)
              else
                @session._query(cypher, merge_params, context: @options[:context], pretty_cypher: pretty_cypher)
              end

  (!@response.respond_to?(:error?) || !response.error?) ? @response : @response.raise_cypher_error
end

#return(*args) ⇒ Query

RETURN clause

Returns:




# File 'lib/neo4j-core/query.rb', line 129

#return_query(columns) ⇒ Object 



316
317
318
319
320
321
 
# File 'lib/neo4j-core/query.rb', line 316

def return_query(columns)
  query = copy
  query.remove_clause_class(ReturnClause)

  query.return(*columns)
end

#session_is_new_api? ⇒ Boolean

Returns:

  • (Boolean) 


228
229
230
 
# File 'lib/neo4j-core/query.rb', line 228

def session_is_new_api?
  defined?(::Neo4j::Core::CypherSession) && @session.is_a?(::Neo4j::Core::CypherSession)
end

#set(*args) ⇒ Query

SET clause

Returns:




# File 'lib/neo4j-core/query.rb', line 117

#set_props(*args) ⇒ Object

Works the same as the #set method, but when given a nested array it will set properties rather than setting entire objects

Examples:

# Creates a query representing the cypher: MATCH (n:Person) SET n.age = 19
Query.new.match(n: :Person).set_props(n: {age: 19})


196
197
198
 
# File 'lib/neo4j-core/query.rb', line 196

def set_props(*args)
  build_deeper_query(SetClause, args, set_props: true)
end

#skip(*args) ⇒ Query Also known as: offset

SKIP clause

Returns:




# File 'lib/neo4j-core/query.rb', line 113

#start(*args) ⇒ Query

START clause

Returns:




# File 'lib/neo4j-core/query.rb', line 81

#to_a ⇒ Array

Class is Enumerable. Each yield is a Hash with the key matching the variable returned and the value being the value for that key from the response

Returns:

  • (Array)

Raises:




# File 'lib/neo4j-core/query.rb', line 277

#to_cypher(options = {}) ⇒ Object Also known as: cypher 



330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
 
# File 'lib/neo4j-core/query.rb', line 330

def to_cypher(options = {})
  join_string = options[:pretty] ? NEWLINE : EMPTY

  cypher_string = partitioned_clauses.map do |clauses|
    clauses_by_class = clauses.group_by(&:class)

    cypher_parts = CLAUSES.map do |clause_class|
      clause_class.to_cypher(clauses, options[:pretty]) if clauses = clauses_by_class[clause_class]
    end.compact

    cypher_parts.join(join_string).tap(&:strip!)
  end.join(join_string)

  cypher_string = "CYPHER #{@options[:parser]} #{cypher_string}" if @options[:parser]
  cypher_string.tap(&:strip!)
end

#union_cypher(other, options = {}) ⇒ String

Returns a CYPHER query specifying the union of the callee object’s query and the argument’s query

Examples:

# Generates cypher: MATCH (n:Person) UNION MATCH (o:Person) WHERE o.age = 10
q = Neo4j::Core::Query.new.match(o: :Person).where(o: {age: 10})
result = Neo4j::Core::Query.new.match(n: :Person).union_cypher(q)

Parameters:

  • other (Query) —

    Second half of UNION

  • options (Hash) (defaults to: {}) —

    Specify true to use UNION ALL

Returns:

  • (String) —

    Resulting UNION cypher query string



379
380
381
 
# File 'lib/neo4j-core/query.rb', line 379

def union_cypher(other, options = {})
  "#{to_cypher} UNION#{options[:all] ? ' ALL' : ''} #{other.to_cypher}"
end

#unwind(*args) ⇒ Query

UNWIND clause

Returns:




# File 'lib/neo4j-core/query.rb', line 125

#unwrapped ⇒ Object 



219
220
221
222
 
# File 'lib/neo4j-core/query.rb', line 219

def unwrapped
  @_unwrapped_obj = true
  self
end

#unwrapped? ⇒ Boolean

Returns:

  • (Boolean) 


224
225
226
 
# File 'lib/neo4j-core/query.rb', line 224

def unwrapped?
  !!@_unwrapped_obj
end

#using(*args) ⇒ Query

USING clause

Returns:




# File 'lib/neo4j-core/query.rb', line 93

#where(*args) ⇒ Query

WHERE clause

Returns:




# File 'lib/neo4j-core/query.rb', line 97

#where_not(*args) ⇒ Object

Works the same as the #where method, but the clause is surrounded by a Cypher NOT() function



188
189
190
 
# File 'lib/neo4j-core/query.rb', line 188

def where_not(*args)
  build_deeper_query(WhereClause, args, not: true)
end

#with(*args) ⇒ Query

WITH clause

Returns:




# File 'lib/neo4j-core/query.rb', line 101