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 =

DETACH DELETE clause

Returns:

%w[start match optional_match call using where create create_unique merge set on_create_set on_match_set remove unwind delete detach_delete with with_distinct return order skip limit]
BREAK_METHODS =

rubocop:disable Metrics/LineLength

%(with with_distinct call)
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.



70
71
72
73
74
75
76
77
 
# File 'lib/neo4j/core/query.rb', line 70

def initialize(options = {})
  @session = options[:session]

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

Class Attribute Details

.pretty_cypher ⇒ Object

Returns the value of attribute pretty_cypher.



67
68
69
 
# File 'lib/neo4j/core/query.rb', line 67

def pretty_cypher
  @pretty_cypher
end

Instance Attribute Details

#clauses ⇒ Object

Returns the value of attribute clauses.



21
22
23
 
# File 'lib/neo4j/core/query.rb', line 21

def clauses
  @clauses
end

Instance Method Details

#&(other) ⇒ Object 



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

def &(other)
  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')


213
214
215
 
# File 'lib/neo4j/core/query.rb', line 213

def break
  build_deeper_query(nil)
end

#clause?(method) ⇒ Boolean

Returns:

  • (Boolean) 


409
410
411
412
 
# File 'lib/neo4j/core/query.rb', line 409

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

#context ⇒ Object 



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

def context
  @options[:context]
end

#copy ⇒ Object 



400
401
402
403
404
405
406
407
 
# File 'lib/neo4j/core/query.rb', line 400

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

#count(var = nil) ⇒ Object 



271
272
273
274
 
# File 'lib/neo4j/core/query.rb', line 271

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 139

#create_unique(*args) ⇒ Query

CREATE UNIQUE clause

Returns:




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

#delete(*args) ⇒ Query

DELETE clause

Returns:




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

#detach_delete(*args) ⇒ Query

DETACH DELETE clause

Returns:



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

METHODS = %w[start match optional_match call using where create create_unique merge set on_create_set on_match_set remove unwind delete detach_delete with with_distinct return order skip limit]

#each ⇒ Object 



276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/neo4j/core/query.rb', line 276

def each
  response = self.response
  if defined?(Neo4j::Server::CypherResponse) && response.is_a?(Neo4j::Server::CypherResponse)
    response.unwrapped! if unwrapped?
    response.to_node_enumeration
  elsif defined?(Neo4j::Core::CypherSession::Result) && response.is_a?(Neo4j::Core::CypherSession::Result)
    response.to_a
  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:

  • (Neo4j::Server::CypherResponse::ResponseError) —

    Raises errors from neo4j server



297
298
299
300
301
 
# File 'lib/neo4j/core/query.rb', line 297

def exec
  response

  true
end

#inspect ⇒ Object 



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

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 115

#match(*args) ⇒ Query

MATCH clause

Returns:




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

#match_nodes(hash, optional_match = false) ⇒ Object 



256
257
258
259
260
261
262
263
 
# File 'lib/neo4j/core/query.rb', line 256

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 147

#on_create_set(*args) ⇒ Query

ON CREATE SET clause

Returns:




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

#on_match_set(*args) ⇒ Query

ON MATCH SET clause

Returns:




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

#optional_match(*args) ⇒ Query

OPTIONAL MATCH clause

Returns:




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

#optional_match_nodes(hash) ⇒ Object 



265
266
267
 
# File 'lib/neo4j/core/query.rb', line 265

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 111

#parameters ⇒ Object 



366
367
368
369
 
# File 'lib/neo4j/core/query.rb', line 366

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)


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

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

#partitioned_clauses ⇒ Object 



371
372
373
 
# File 'lib/neo4j/core/query.rb', line 371

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


312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/neo4j/core/query.rb', line 312

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

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

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

#pretty_cypher ⇒ Object 



358
359
360
 
# File 'lib/neo4j/core/query.rb', line 358

def pretty_cypher
  to_cypher(pretty: true)
end

#print_cypher ⇒ Object 



375
376
377
 
# File 'lib/neo4j/core/query.rb', line 375

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

#raise_if_cypher_error!(response) ⇒ Object 



252
253
254
 
# File 'lib/neo4j/core/query.rb', line 252

def raise_if_cypher_error!(response)
  response.raise_cypher_error if response.respond_to?(:error?) && response.error?
end

#remove(*args) ⇒ Query

REMOVE clause

Returns:




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

#reorder(*args) ⇒ Object

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



188
189
190
191
192
193
 
# File 'lib/neo4j/core/query.rb', line 188

def reorder(*args)
  query = copy

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

#response ⇒ Object 



241
242
243
244
245
246
247
248
249
250
 
# File 'lib/neo4j/core/query.rb', line 241

def response
  return @response if @response

  @response = if session_is_new_api?
                @session.query(self, transaction: Transaction.current_for(@session), wrap_level: (:core_entity if unwrapped?))
              else
                @session._query(to_cypher, merge_params,
                                context: @options[:context], pretty_cypher: (pretty_cypher if self.class.pretty_cypher)).tap(&method(:raise_if_cypher_error!))
              end
end

#return(*args) ⇒ Query

RETURN clause

Returns:




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

#return_query(columns) ⇒ Object 



326
327
328
329
330
331
 
# File 'lib/neo4j/core/query.rb', line 326

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

  query.return(*columns)
end

#session_is_new_api? ⇒ Boolean

Returns:

  • (Boolean) 


237
238
239
 
# File 'lib/neo4j/core/query.rb', line 237

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 123

#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})


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

def set_props(*args) # rubocop:disable Naming/AccessorMethodName
  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 119

#start(*args) ⇒ Query

START clause

Returns:




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

#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:

  • (Neo4j::Server::CypherResponse::ResponseError) —

    Raises errors from neo4j server




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

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



340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
 
# File 'lib/neo4j/core/query.rb', line 340

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



389
390
391
 
# File 'lib/neo4j/core/query.rb', line 389

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 131

#unwrapped ⇒ Object 



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

def unwrapped
  @_unwrapped_obj = true
  self
end

#unwrapped? ⇒ Boolean

Returns:

  • (Boolean) 


233
234
235
 
# File 'lib/neo4j/core/query.rb', line 233

def unwrapped?
  !!@_unwrapped_obj
end

#using(*args) ⇒ Query

USING clause

Returns:




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

#where(*args) ⇒ Query

WHERE clause

Returns:




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

#where_not(*args) ⇒ Object

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



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

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 103

#with_distinct(*args) ⇒ Query

WITH clause with DISTINCT specified

Returns:




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