Class: Neo4j::Core::Query
- Inherits:
-
Object
- Object
- Neo4j::Core::Query
- 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
%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 return order skip limit)
- BREAK_METHODS =
rubocop:disable Metrics/LineLength
%(with 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
' '
- NEWLINE =
"\n"
Class Attribute Summary collapse
-
.pretty_cypher ⇒ Object
Returns the value of attribute pretty_cypher.
Instance Attribute Summary collapse
-
#clauses ⇒ Object
Returns the value of attribute clauses.
Instance Method Summary collapse
- #&(other) ⇒ Object
-
#break ⇒ Object
Allows what’s been built of the query so far to be frozen and the rest built anew.
- #clause?(method) ⇒ Boolean
- #context ⇒ Object
- #copy ⇒ Object
- #count(var = nil) ⇒ Object
-
#create(*args) ⇒ Query
CREATE clause.
-
#create_unique(*args) ⇒ Query
CREATE UNIQUE clause.
-
#delete(*args) ⇒ Query
DELETE clause.
-
#detach_delete(*args) ⇒ Query
DETACH DELETE clause.
- #each ⇒ Object
-
#exec ⇒ Boolean
Executes a query without returning the result.
-
#initialize(options = {}) ⇒ Query
constructor
A new instance of Query.
- #inspect ⇒ Object
-
#limit(*args) ⇒ Query
LIMIT clause.
-
#match(*args) ⇒ Query
MATCH clause.
- #match_nodes(hash, optional_match = false) ⇒ Object
-
#merge(*args) ⇒ Query
MERGE clause.
-
#on_create_set(*args) ⇒ Query
ON CREATE SET clause.
-
#on_match_set(*args) ⇒ Query
ON MATCH SET clause.
-
#optional_match(*args) ⇒ Query
OPTIONAL MATCH clause.
- #optional_match_nodes(hash) ⇒ Object
-
#order(*args) ⇒ Query
(also: #order_by)
ORDER BY clause.
- #parameters ⇒ Object
-
#params(args) ⇒ Object
Allows for the specification of values for params specified in query.
- #partitioned_clauses ⇒ Object
-
#pluck(*columns) ⇒ Object
Return the specified columns as an array.
- #pretty_cypher ⇒ Object
- #print_cypher ⇒ Object
- #raise_if_cypher_error!(response) ⇒ Object
-
#remove(*args) ⇒ Query
REMOVE clause.
-
#reorder(*args) ⇒ Object
Clears out previous order clauses and allows only for those specified by args.
- #response ⇒ Object
-
#return(*args) ⇒ Query
RETURN clause.
- #return_query(columns) ⇒ Object
- #session_is_new_api? ⇒ Boolean
-
#set(*args) ⇒ Query
SET clause.
-
#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.
-
#skip(*args) ⇒ Query
(also: #offset)
SKIP clause.
-
#start(*args) ⇒ Query
START clause.
-
#to_a ⇒ Array
Class is Enumerable.
- #to_cypher(options = {}) ⇒ Object (also: #cypher)
-
#union_cypher(other, options = {}) ⇒ String
Returns a CYPHER query specifying the union of the callee object’s query and the argument’s query.
-
#unwind(*args) ⇒ Query
UNWIND clause.
- #unwrapped ⇒ Object
- #unwrapped? ⇒ Boolean
-
#using(*args) ⇒ Query
USING clause.
-
#where(*args) ⇒ Query
WHERE clause.
-
#where_not(*args) ⇒ Object
Works the same as the #where method, but the clause is surrounded by a Cypher NOT() function.
-
#with(*args) ⇒ Query
WITH clause.
Methods included from QueryFindInBatches
Constructor Details
Class Attribute Details
.pretty_cypher ⇒ Object
Returns the value of attribute pretty_cypher.
66 67 68 |
# File 'lib/neo4j-core/query.rb', line 66 def pretty_cypher @pretty_cypher end |
Instance Attribute Details
#clauses ⇒ Object
Returns the value of attribute clauses.
20 21 22 |
# File 'lib/neo4j-core/query.rb', line 20 def clauses @clauses end |
Instance Method Details
#&(other) ⇒ Object
388 389 390 391 392 393 |
# File 'lib/neo4j-core/query.rb', line 388 def &(other) self.class.new(session: @session).tap do |new_query| new_query. = .merge(other.) 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
208 209 210 |
# File 'lib/neo4j-core/query.rb', line 208 def break build_deeper_query(nil) end |
#clause?(method) ⇒ Boolean
404 405 406 407 |
# File 'lib/neo4j-core/query.rb', line 404 def clause?(method) clause_class = DEFINED_CLAUSES[method] || CLAUSIFY_CLAUSE.call(method) clauses.any? { |clause| clause.is_a?(clause_class) } end |
#context ⇒ Object
357 358 359 |
# File 'lib/neo4j-core/query.rb', line 357 def context @options[:context] end |
#copy ⇒ Object
395 396 397 398 399 400 401 402 |
# File 'lib/neo4j-core/query.rb', line 395 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
266 267 268 269 |
# File 'lib/neo4j-core/query.rb', line 266 def count(var = nil) v = var.nil? ? '*' : var pluck("count(#{v})").first end |
#detach_delete(*args) ⇒ Query
DETACH DELETE clause
162 |
# File 'lib/neo4j-core/query.rb', line 162 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 return order skip limit) |
#each ⇒ Object
271 272 273 274 275 276 277 278 279 280 281 |
# File 'lib/neo4j-core/query.rb', line 271 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
292 293 294 295 296 |
# File 'lib/neo4j-core/query.rb', line 292 def exec response true end |
#inspect ⇒ Object
78 79 80 |
# File 'lib/neo4j-core/query.rb', line 78 def inspect "#<Query CYPHER: #{ANSI::YELLOW}#{to_cypher.inspect}#{ANSI::CLEAR}>" end |
#match_nodes(hash, optional_match = false) ⇒ Object
251 252 253 254 255 256 257 258 |
# File 'lib/neo4j-core/query.rb', line 251 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 |
#optional_match_nodes(hash) ⇒ Object
260 261 262 |
# File 'lib/neo4j-core/query.rb', line 260 def optional_match_nodes(hash) match_nodes(hash, true) end |
#order(*args) ⇒ Query Also known as: order_by
ORDER BY clause
|
# File 'lib/neo4j-core/query.rb', line 106
|
#parameters ⇒ Object
361 362 363 364 |
# File 'lib/neo4j-core/query.rb', line 361 def parameters to_cypher merge_params end |
#params(args) ⇒ Object
Allows for the specification of values for params specified in query
219 220 221 |
# File 'lib/neo4j-core/query.rb', line 219 def params(args) copy.tap { |new_query| new_query.instance_variable_get('@params'.freeze).add_params(args) } end |
#partitioned_clauses ⇒ Object
366 367 368 |
# File 'lib/neo4j-core/query.rb', line 366 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
307 308 309 310 311 312 313 314 315 316 317 318 319 |
# File 'lib/neo4j-core/query.rb', line 307 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
353 354 355 |
# File 'lib/neo4j-core/query.rb', line 353 def pretty_cypher to_cypher(pretty: true) end |
#print_cypher ⇒ Object
370 371 372 |
# File 'lib/neo4j-core/query.rb', line 370 def print_cypher puts to_cypher(pretty: true).gsub(/\e[^m]+m/, '') end |
#raise_if_cypher_error!(response) ⇒ Object
247 248 249 |
# File 'lib/neo4j-core/query.rb', line 247 def raise_if_cypher_error!(response) response.raise_cypher_error if response.respond_to?(:error?) && response.error? end |
#reorder(*args) ⇒ Object
Clears out previous order clauses and allows only for those specified by args
183 184 185 186 187 188 |
# File 'lib/neo4j-core/query.rb', line 183 def reorder(*args) query = copy query.remove_clause_class(OrderClause) query.order(*args) end |
#response ⇒ Object
236 237 238 239 240 241 242 243 244 245 |
# File 'lib/neo4j-core/query.rb', line 236 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_query(columns) ⇒ Object
321 322 323 324 325 326 |
# File 'lib/neo4j-core/query.rb', line 321 def return_query(columns) query = copy query.remove_clause_class(ReturnClause) query.return(*columns) end |
#session_is_new_api? ⇒ Boolean
232 233 234 |
# File 'lib/neo4j-core/query.rb', line 232 def session_is_new_api? defined?(::Neo4j::Core::CypherSession) && @session.is_a?(::Neo4j::Core::CypherSession) end |
#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
200 201 202 |
# File 'lib/neo4j-core/query.rb', line 200 def set_props(*args) build_deeper_query(SetClause, args, set_props: true) end |
#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
|
# File 'lib/neo4j-core/query.rb', line 283
|
#to_cypher(options = {}) ⇒ Object Also known as: cypher
335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 |
# File 'lib/neo4j-core/query.rb', line 335 def to_cypher( = {}) join_string = [: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, [: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
384 385 386 |
# File 'lib/neo4j-core/query.rb', line 384 def union_cypher(other, = {}) "#{to_cypher} UNION#{[:all] ? ' ALL' : ''} #{other.to_cypher}" end |
#unwrapped ⇒ Object
223 224 225 226 |
# File 'lib/neo4j-core/query.rb', line 223 def unwrapped @_unwrapped_obj = true self end |
#unwrapped? ⇒ Boolean
228 229 230 |
# File 'lib/neo4j-core/query.rb', line 228 def unwrapped? !!@_unwrapped_obj end |
#where_not(*args) ⇒ Object
Works the same as the #where method, but the clause is surrounded by a Cypher NOT() function
192 193 194 |
# File 'lib/neo4j-core/query.rb', line 192 def where_not(*args) build_deeper_query(WhereClause, args, not: true) end |