1 # This file is part of NIT ( http://www.nitlanguage.org ).
3 # Licensed under the Apache License, Version 2.0 (the "License");
4 # you may not use this file except in compliance with the License.
5 # You may obtain a copy of the License at
7 # http://www.apache.org/licenses/LICENSE-2.0
9 # Unless required by applicable law or agreed to in writing, software
10 # distributed under the License is distributed on an "AS IS" BASIS,
11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 # See the License for the specific language governing permissions and
13 # limitations under the License.
15 # Neo4j connector through its JSON REST API using curl.
17 # For ease of use and testing this module provide a wrapper to the `neo4j` command:
19 # # Start the Neo4j server
20 # var srv = new Neo4jServer
21 # assert srv.start_quiet
23 # In order to connect to Neo4j you need a connector:
25 # # Create new Neo4j client
26 # var client = new Neo4jClient("http://localhost:7474")
29 # The fundamental units that form a graph are nodes and relationships.
31 # Nodes are used to represent entities stored in base:
33 # # Create a disconnected node
34 # var andres = new NeoNode
35 # andres["name"] = "Andres"
36 # # Connect the node to Neo4j
37 # client.save_node(andres)
38 # assert andres.is_linked
40 # # Create a second node
41 # var kate = new NeoNode
42 # kate["name"] = "Kate"
43 # client.save_node(kate)
44 # assert kate.is_linked
46 # Relationships between nodes are a key part of a graph database.
47 # They allow for finding related data. Just like nodes, relationships can have properties.
49 # # Create a relationship
50 # var loves = new NeoEdge(andres, "LOVES", kate)
51 # client.save_edge(loves)
52 # assert loves.is_linked
54 # Nodes can also be loaded fron Neo4j:
56 # # Get a node from DB and explore edges
57 # var url = andres.url.to_s
58 # var from = client.load_node(url)
59 # assert from["name"].to_s == "Andres"
60 # var to = from.out_nodes("LOVES").first # follow the first LOVES relationship
61 # assert to["name"].to_s == "Kate"
63 # For more details, see http://docs.neo4j.org/chunked/milestone/rest-api.html
69 # Handles Neo4j server start and stop command
71 # `neo4j` binary must be in `PATH` in order to work
74 # Start the local Neo4j server instance
76 sys
.system
("neo4j start console")
80 # Like `start` but redirect the console output to `/dev/null`
81 fun start_quiet
: Bool do
82 sys
.system
("neo4j start console > /dev/null")
86 # Stop the local Neo4j server instance
88 sys
.system
("neo4j stop")
92 # Like `stop` but redirect the console output to `/dev/null`
93 fun stop_quiet
: Bool do
94 sys
.system
("neo4j stop > /dev/null")
99 # `Neo4jClient` is needed to communicate through the REST API
101 # var client = new Neo4jClient("http://localhost:7474")
102 # assert client.is_ok
105 # Neo4j REST services baseurl
107 # REST service to get node data
108 private var node_url
: String
109 # REST service to batch
110 private var batch_url
: String
111 # REST service to send cypher requests
112 private var cypher_url
: String
114 private var curl
= new Curl
116 init(base_url
: String) do
117 self.base_url
= base_url
118 var root
= service_root
119 assert root
isa JsonObject else
120 sys
.stderr
.write
"Neo4jClientError: cannot connect to server at <{base_url}>.\n"
122 self.node_url
= root
["node"].to_s
123 self.batch_url
= root
["batch"].to_s
124 self.cypher_url
= root
["cypher"].to_s
127 fun service_root
: Jsonable do return get
("{base_url}/db/data")
129 # Is the connection with the Neo4j server ok?
130 fun is_ok
: Bool do return service_root
isa JsonObject
134 cypher
(new CypherQuery.from_string
("MATCH (n) OPTIONAL MATCH n-[r]-() DELETE r, n"))
138 var errors
= new Array[String]
140 # Nodes view stored locally
141 private var local_nodes
= new HashMap[String, nullable NeoNode]
143 # Save the node in base
145 # var client = new Neo4jClient("http://localhost:7474")
148 # var andres = new NeoNode
149 # andres["name"] = "Andres"
150 # client.save_node(andres)
151 # assert andres.is_linked
153 # Once linked, nodes cannot be created twice:
155 # var oldurl = andres.url
156 # client.save_node(andres) # do nothing
157 # assert andres.url == oldurl
158 fun save_node
(node
: NeoNode): Bool do
159 if node
.is_linked
then return true
161 var batch
= new NeoBatch(self)
162 batch
.save_node
(node
)
163 # batch.create_edges(node.out_edges)
164 var errors
= batch
.execute
165 if not errors
.is_empty
then
166 errors
.add_all errors
169 local_nodes
[node
.url
.to_s
] = node
173 # Load a node from base
174 # Data, labels and edges will be loaded lazily.
175 fun load_node
(url
: String): NeoNode do
176 if local_nodes
.has_key
(url
) then
177 var node
= local_nodes
[url
]
178 if node
!= null then return node
180 var node
= new NeoNode.from_neo
(self, url
)
181 local_nodes
[url
] = node
185 # Remove the entity from base
186 fun delete_node
(node
: NeoNode): Bool do
187 if not node
.is_linked
then return false
188 var url
= node
.url
.to_s
190 local_nodes
[url
] = null
195 # Edges view stored locally
196 private var local_edges
= new HashMap[String, nullable NeoEdge]
198 # Save the edge in base
199 # From and to nodes will be created.
201 # var client = new Neo4jClient("http://localhost:7474")
203 # var andres = new NeoNode
204 # var kate = new NeoNode
205 # var edge = new NeoEdge(andres, "LOVES", kate)
206 # client.save_edge(edge)
207 # assert andres.is_linked
208 # assert kate.is_linked
209 # assert edge.is_linked
210 fun save_edge
(edge
: NeoEdge): Bool do
211 if edge
.is_linked
then return true
213 edge
.from
.out_edges
.add edge
214 edge
.to
.in_edges
.add edge
215 var batch
= new NeoBatch(self)
216 batch
.save_edge
(edge
)
217 var errors
= batch
.execute
218 if not errors
.is_empty
then
219 errors
.add_all errors
222 local_edges
[edge
.url
.to_s
] = edge
226 # Load a edge from base
227 # Data will be loaded lazily.
228 fun load_edge
(url
: String): NeoEdge do
229 if local_edges
.has_key
(url
) then
230 var node
= local_edges
[url
]
231 if node
!= null then return node
233 var edge
= new NeoEdge.from_neo
(self, url
)
234 local_edges
[url
] = edge
238 # Remove the edge from base
239 fun delete_edge
(edge
: NeoEdge): Bool do
240 if not edge
.is_linked
then return false
241 var url
= edge
.url
.to_s
243 local_edges
[url
] = null
248 # Retrieve all nodes with specified `lbl`
250 # var client = new Neo4jClient("http://localhost:7474")
252 # var andres = new NeoNode
253 # andres.labels.add_all(["Human", "Male"])
254 # client.save_node(andres)
255 # var kate = new NeoNode
256 # kate.labels.add_all(["Human", "Female"])
257 # client.save_node(kate)
259 # var nodes = client.nodes_with_label("Human")
260 # assert nodes.has(andres)
261 # assert nodes.has(kate)
262 fun nodes_with_label
(lbl
: String): Array[NeoNode] do
263 var res
= get
("{base_url}/db/data/label/{lbl}/nodes")
264 var nodes
= new Array[NeoNode]
265 for json
in res
.as(JsonArray) do
266 var obj
= json
.as(JsonObject)
267 var node
= load_node
(obj
["self"].to_s
)
268 node
.internal_properties
= obj
["data"].as(JsonObject)
274 # Retrieve nodes belonging to all the specified `labels`.
276 # var client = new Neo4jClient("http://localhost:7474")
278 # var andres = new NeoNode
279 # andres.labels.add_all(["Human", "Male"])
280 # client.save_node(andres)
281 # var kate = new NeoNode
282 # kate.labels.add_all(["Human", "Female"])
283 # client.save_node(kate)
285 # var nodes = client.nodes_with_labels(["Human", "Male"])
286 # assert nodes.has(andres)
287 # assert not nodes.has(kate)
288 fun nodes_with_labels
(labels
: Array[String]): Array[NeoNode] do
289 assert not labels
.is_empty
290 var res
= cypher
(new CypherQuery.from_string
("MATCH (n:{labels.join(":")}) RETURN n"))
291 var nodes
= new Array[NeoNode]
292 for json
in res
.as(JsonObject)["data"].as(JsonArray) do
293 var obj
= json
.as(JsonArray).first
.as(JsonObject)
294 var node
= load_node
(obj
["self"].to_s
)
295 node
.internal_properties
= obj
["data"].as(JsonObject)
301 # Perform a `CypherQuery`
303 fun cypher
(query
: CypherQuery): Jsonable do
304 return post
("{cypher_url}", query
.to_rest
)
307 # GET JSON data from `url`
308 fun get
(url
: String): Jsonable do
309 var request
= new JsonGET(url
, curl
)
310 var response
= request
.execute
311 return parse_response
(response
)
314 # POST `params` to `url`
315 fun post
(url
: String, params
: Jsonable): Jsonable do
316 var request
= new JsonPOST(url
, curl
)
317 request
.data
= params
318 var response
= request
.execute
319 return parse_response
(response
)
322 # PUT `params` at `url`
323 fun put
(url
: String, params
: Jsonable): Jsonable do
324 var request
= new JsonPUT(url
, curl
)
325 request
.data
= params
326 var response
= request
.execute
327 return parse_response
(response
)
331 fun delete
(url
: String): Jsonable do
332 var request
= new JsonDELETE(url
, curl
)
333 var response
= request
.execute
334 return parse_response
(response
)
337 # Parse the cURL `response` as a JSON string
338 private fun parse_response
(response
: CurlResponse): Jsonable do
339 if response
isa CurlResponseSuccess then
340 var str
= response
.body_str
341 if str
.is_empty
then return new JsonObject
342 var res
= str
.parse_json
343 if res
isa JsonParseError then
344 var e
= new NeoError(res
.to_s
, "JsonParseError")
349 # empty response wrap it in empty object
350 return new JsonObject
351 else if res
isa JsonObject and res
.has_key
("exception") then
352 var error
= "Neo4jError::{res["exception"] or else "null"}"
354 if res
.has_key
("message") then
355 msg
= res
["message"].to_s
357 return new NeoError(msg
, error
)
361 else if response
isa CurlResponseFailed then
362 return new NeoError("{response.error_msg} ({response.error_code})", "CurlError")
364 return new NeoError("Unexpected response \"{response}\
".", "CurlError")
369 # A Cypher query for Neo4j REST API
371 # The Neo4j REST API allows querying with Cypher.
372 # The results are returned as a list of string headers (columns), and a data part,
373 # consisting of a list of all rows, every row consisting of a list of REST representations
374 # of the field value - Node, Relationship, Path or any simple value like String.
378 # var client = new Neo4jClient("http://localhost:7474")
379 # var query = new CypherQuery
380 # query.nmatch("(n)-[r:LOVES]->(m)")
381 # query.nwhere("n.name=\"Andres\"")
382 # query.nreturn("m.name")
383 # var res = client.cypher(query).as(JsonObject)
384 # assert res["data"].as(JsonArray).first.as(JsonArray).first == "Kate"
386 # For more details, see: http://docs.neo4j.org/chunked/milestone/rest-api-cypher.html
388 # Query string to perform
389 private var query
: String = ""
391 # `params` to embed in the query like in prepared statements
392 var params
= new JsonObject
396 # init the query from a query string
397 init from_string
(query
: String) do
401 # init the query with parameters
402 init with_params
(params
: JsonObject) do
406 # Add a `CREATE` statement to the query
407 fun ncreate
(query
: String): CypherQuery do
408 self.query
= "{self.query}CREATE {query} "
412 # Add a `START` statement to the query
413 fun nstart
(query
: String): CypherQuery do
414 self.query
= "{self.query}START {query} "
418 # Add a `MATCH` statement to the query
419 fun nmatch
(query
: String): CypherQuery do
420 self.query
= "{self.query}MATCH {query} "
424 # Add a `WHERE` statement to the query
425 fun nwhere
(query
: String): CypherQuery do
426 self.query
= "{self.query}WHERE {query} "
430 # Add a `AND` statement to the query
431 fun nand
(query
: String): CypherQuery do
432 self.query
= "{self.query}AND {query} "
436 # Add a `RETURN` statement to the query
437 fun nreturn
(query
: String): CypherQuery do
438 self.query
= "{self.query}RETURN {query} "
442 # Translate the query to the body of a corresponding Neo4j REST request.
443 fun to_rest
: JsonObject do
444 var obj
= new JsonObject
446 if not params
.is_empty
then
447 obj
["params"] = params
452 redef fun to_s
do return to_rest
.to_s
455 # The fundamental units that form a graph are nodes and relationships.
457 # Entities can have two states:
459 # * linked: the NeoEntity references an existing node or edge in Neo4j
460 # * unlinked: the NeoEntity is not yet created in Neo4j
462 # If the entity is initialized unlinked from neo4j:
464 # # Create a disconnected node
465 # var andres = new NeoNode
466 # andres["name"] = "Andres"
467 # # At this point, the node is not linked
468 # assert not andres.is_linked
470 # Then we can link the entity to the base:
473 # var client = new Neo4jClient("http://localhost:7474")
474 # client.save_node(andres)
475 # # The node is now linked
476 # assert andres.is_linked
478 # Entities can also be loaded from Neo4j:
480 # # Get a node from Neo4j
481 # var url = andres.url.to_s
482 # var node = client.load_node(url)
483 # assert node.is_linked
485 # When working in connected mode, all reading operations are executed lazily on the base:
487 # # Get the node `name` property
488 # assert node["name"] == "Andres" # loaded lazily from base
489 abstract class NeoEntity
490 # Neo4j client connector
491 private var neo
: Neo4jClient is noinit
493 # Entity unique URL in Neo4j REST API
494 var url
: nullable String = null
496 # Temp id used in batch mode to update the entity
497 private var batch_id
: nullable Int = null
499 # Load the entity from base
500 private init from_neo
(neo
: Neo4jClient, url
: String) do
505 # Init entity from JSON representation
506 private init from_json
(neo
: Neo4jClient, obj
: JsonObject) do
508 self.url
= obj
["self"].to_s
509 self.internal_properties
= obj
["data"].as(JsonObject)
512 # Create a empty (and not-connected) entity
514 self.internal_properties
= new JsonObject
517 # Is the entity linked to a Neo4j database?
518 fun is_linked
: Bool do return url
!= null
520 # In Neo4j, both nodes and relationships can contain properties.
521 # Properties are key-value pairs where the key is a string.
522 # Property values are JSON formatted.
524 # Properties are loaded lazily
525 fun properties
: JsonObject do return internal_properties
or else load_properties
527 private var internal_properties
: nullable JsonObject = null
529 private fun load_properties
: JsonObject do
530 var obj
= neo
.get
("{url.to_s}/properties").as(JsonObject)
531 internal_properties
= obj
535 # Get the entity `id` if connected to base
536 fun id
: nullable Int do
537 if url
== null then return null
538 return url
.split
("/").last
.to_i
541 # Get the entity property at `key`
542 fun [](key
: String): nullable Jsonable do
543 if not properties
.has_key
(key
) then return null
544 return properties
[key
]
547 # Set the entity property `value` at `key`
548 fun []=(key
: String, value
: nullable Jsonable) do properties
[key
] = value
550 # Is the property `key` set?
551 fun has_key
(key
: String): Bool do return properties
.has_key
(key
)
554 # Nodes are used to represent entities stored in base.
555 # Apart from properties and relationships (edges),
556 # nodes can also be labeled with zero or more labels.
558 # A label is a `String` that is used to group nodes into sets.
559 # All nodes labeled with the same label belongs to the same set.
560 # A node may be labeled with any number of labels, including none,
561 # making labels an optional addition to the graph.
563 # Creating new nodes:
565 # var client = new Neo4jClient("http://localhost:7474")
567 # var andres = new NeoNode
568 # andres.labels.add "Person"
569 # andres["name"] = "Andres"
571 # client.save_node(andres)
572 # assert andres.is_linked
574 # Get nodes from Neo4j:
576 # var url = andres.url.to_s
577 # var node = client.load_node(url)
578 # assert node["name"] == "Andres"
579 # assert node["age"].to_s.to_i == 22
583 private var internal_labels
: nullable Array[String] = null
584 private var internal_in_edges
: nullable List[NeoEdge] = null
585 private var internal_out_edges
: nullable List[NeoEdge] = null
589 self.internal_labels
= new Array[String]
590 self.internal_in_edges
= new List[NeoEdge]
591 self.internal_out_edges
= new List[NeoEdge]
595 var tpl
= new FlatBuffer
597 tpl
.append
"labels: [{labels.join(", ")}],"
598 tpl
.append
"data: {properties.to_json}"
600 return tpl
.write_to_string
603 # A label is a `String` that is used to group nodes into sets.
604 # A node may be labeled with any number of labels, including none.
605 # All nodes labeled with the same label belongs to the same set.
607 # Many database queries can work with these sets instead of the whole graph,
608 # making queries easier to write and more efficient.
610 # Labels are loaded lazily
611 fun labels
: Array[String] do return internal_labels
or else load_labels
613 private fun load_labels
: Array[String] do
614 var labels
= new Array[String]
615 var res
= neo
.get
("{url.to_s}/labels")
616 if res
isa JsonArray then
617 for val
in res
do labels
.add val
.to_s
619 internal_labels
= labels
623 # Get the list of `NeoEdge` pointing to `self`
625 # Edges are loaded lazily
626 fun in_edges
: List[NeoEdge] do return internal_in_edges
or else load_in_edges
628 private fun load_in_edges
: List[NeoEdge] do
629 var edges
= new List[NeoEdge]
630 var res
= neo
.get
("{url.to_s}/relationships/in").as(JsonArray)
632 edges
.add
(new NeoEdge.from_json
(neo
, obj
.as(JsonObject)))
634 internal_in_edges
= edges
638 # Get the list of `NeoEdge` pointing from `self`
640 # Edges are loaded lazily
641 fun out_edges
: List[NeoEdge] do return internal_out_edges
or else load_out_edges
643 private fun load_out_edges
: List[NeoEdge] do
644 var edges
= new List[NeoEdge]
645 var res
= neo
.get
("{url.to_s}/relationships/out")
646 for obj
in res
.as(JsonArray) do
647 edges
.add
(new NeoEdge.from_json
(neo
, obj
.as(JsonObject)))
649 internal_out_edges
= edges
653 # Get nodes pointed by `self` following a `rel_type` edge
654 fun out_nodes
(rel_type
: String): Array[NeoNode] do
655 var res
= new Array[NeoNode]
656 for edge
in out_edges
do
657 if edge
.rel_type
== rel_type
then res
.add edge
.to
662 # Get nodes pointing to `self` following a `rel_type` edge
663 fun in_nodes
(rel_type
: String): Array[NeoNode] do
664 var res
= new Array[NeoNode]
665 for edge
in in_edges
do
666 if edge
.rel_type
== rel_type
then res
.add edge
.from
672 # A relationship between two nodes.
673 # Relationships between nodes are a key part of a graph database.
674 # They allow for finding related data. Just like nodes, relationships can have properties.
676 # Create a relationship:
678 # var client = new Neo4jClient("http://localhost:7474")
680 # var andres = new NeoNode
681 # andres["name"] = "Andres"
682 # var kate = new NeoNode
683 # kate["name"] = "Kate"
684 # # Create a relationship of type `LOVES`
685 # var loves = new NeoEdge(andres, "LOVES", kate)
686 # client.save_edge(loves)
687 # assert loves.is_linked
689 # Get an edge from DB:
691 # var url = loves.url.to_s
692 # var edge = client.load_edge(url)
693 # assert edge.from["name"].to_s == "Andres"
694 # assert edge.to["name"].to_s == "Kate"
698 private var internal_from
: nullable NeoNode
699 private var internal_to
: nullable NeoNode
700 private var internal_type
: nullable String
701 private var internal_from_url
: nullable String
702 private var internal_to_url
: nullable String
704 init(from
: NeoNode, rel_type
: String, to
: NeoNode) do
705 self.internal_from
= from
706 self.internal_to
= to
707 self.internal_type
= rel_type
710 redef init from_neo
(neo
, url
) do
712 var obj
= neo
.get
(url
).as(JsonObject)
713 self.internal_type
= obj
["type"].to_s
714 self.internal_from_url
= obj
["start"].to_s
715 self.internal_to_url
= obj
["end"].to_s
718 redef init from_json
(neo
, obj
) do
720 self.internal_type
= obj
["type"].to_s
721 self.internal_from_url
= obj
["start"].to_s
722 self.internal_to_url
= obj
["end"].to_s
726 fun from
: NeoNode do return internal_from
or else load_from
728 private fun load_from
: NeoNode do
729 var node
= neo
.load_node
(internal_from_url
.to_s
)
735 fun to
: NeoNode do return internal_to
or else load_to
737 private fun load_to
: NeoNode do
738 var node
= neo
.load_node
(internal_to_url
.to_s
)
744 fun rel_type
: nullable String do return internal_type
746 # Get the JSON body of a REST request that create the relationship.
747 private fun to_rest
: JsonObject do
748 var obj
= new JsonObject
752 obj
["to"] = "\{{to.batch_id.to_s}\}"
754 obj
["type"] = rel_type
755 obj
["data"] = properties
760 # Batches are used to perform multiple operations on the REST API in one cURL request.
761 # This can significantly improve performance for large insert and update operations.
763 # see: http://docs.neo4j.org/chunked/milestone/rest-api-batch-ops.html
765 # This service is transactional.
766 # If any of the operations performed fails (returns a non-2xx HTTP status code),
767 # the transaction will be rolled back and all changes will be undone.
771 # var client = new Neo4jClient("http://localhost:7474")
773 # var node1 = new NeoNode
774 # var node2 = new NeoNode
775 # var edge = new NeoEdge(node1, "TO", node2)
777 # var batch = new NeoBatch(client)
778 # batch.save_node(node1)
779 # batch.save_node(node2)
780 # batch.save_edge(edge)
783 # assert node1.is_linked
784 # assert node2.is_linked
785 # assert edge.is_linked
788 # Neo4j client connector
789 var client
: Neo4jClient
791 # Jobs to perform in this batch
793 # The batch service expects an array of job descriptions as input,
794 # each job description describing an action to be performed via the normal server API.
795 var jobs
= new HashMap[Int, NeoJob]
797 # Append a new job to the batch in JSON Format
799 fun new_job
(nentity
: NeoEntity): NeoJob do
801 var job
= new NeoJob(id
, nentity
)
806 # Load a node in batch mode also load labels, data and edges
807 fun load_node
(node
: NeoNode) do
808 var job
= new_job
(node
)
809 job
.action
= load_node_data_action
811 if node
.id
!= null then
812 job
.to
= "/node/{node.id.to_s}"
814 job
.to
= "\{{node.batch_id.to_s}\}"
817 job
.action
= load_node_labels_action
819 if node
.id
!= null then
820 job
.to
= "/node/{node.id.to_s}/labels"
822 job
.to
= "\{{node.batch_id.to_s}\}/labels"
826 # Load in and out edges into node
827 fun load_node_edges
(node
: NeoNode) do
828 var job
= new_job
(node
)
829 job
.action
= load_node_in_edges_action
831 if node
.id
!= null then
832 job
.to
= "/node/{node.id.to_s}/relationships/in"
834 job
.to
= "\{{node.batch_id.to_s}\}/relationships/in"
837 job
.action
= load_node_out_edges_action
839 if node
.id
!= null then
840 job
.to
= "/node/{node.id.to_s}/relationships/out"
842 job
.to
= "\{{node.batch_id.to_s}\}/relationships/out"
846 # Create a `NeoNode` or a `NeoEdge` in batch mode.
847 fun save_entity
(nentity
: NeoEntity) do
848 if nentity
isa NeoNode then
850 else if nentity
isa NeoEdge then
855 # Create a node in batch mode also create labels and edges
856 fun save_node
(node
: NeoNode) do
857 if node
.id
!= null or node
.batch_id
!= null then return
859 var job
= new_job
(node
)
860 node
.batch_id
= job
.id
861 job
.action
= create_node_action
864 job
.body
= node
.properties
868 job
.to
= "\{{node.batch_id.to_s}\}/labels"
869 job
.body
= new JsonArray.from
(node
.labels
)
871 #save_edges(node.out_edges)
874 # Create multiple nodes
875 # also create labels and edges
876 fun save_nodes
(nodes
: Collection[NeoNode]) do for node
in nodes
do save_node
(node
)
879 # nodes `edge.from` and `edge.to` will be created if not in base
880 fun save_edge
(edge
: NeoEdge) do
881 if edge
.id
!= null or edge
.batch_id
!= null then return
886 var job
= new_job
(edge
)
887 edge
.batch_id
= job
.id
888 job
.action
= create_edge_action
890 if edge
.from
.id
!= null then
891 job
.to
= "/node/{edge.from.id.to_s}/relationships"
893 job
.to
= "\{{edge.from.batch_id.to_s}\}/relationships"
895 job
.body
= edge
.to_rest
898 # Create multiple edges
899 fun save_edges
(edges
: Collection[NeoEdge]) do for edge
in edges
do save_edge
(edge
)
901 # Execute the batch and update local nodes
902 fun execute
: List[NeoError] do
903 var request
= new JsonPOST(client
.batch_url
, client
.curl
)
904 # request.headers["X-Stream"] = "true"
905 var json_jobs
= new JsonArray
906 for job
in jobs
.values
do json_jobs
.add job
.to_rest
907 request
.data
= json_jobs
908 var response
= request
.execute
909 var res
= client
.parse_response
(response
)
910 return finalize_batch
(res
)
913 # Associate data from response in original nodes and edges
914 private fun finalize_batch
(response
: Jsonable): List[NeoError] do
915 var errors
= new List[NeoError]
916 if not response
isa JsonArray then
917 errors
.add
(new NeoError("Unexpected batch response format.", "Neo4jError"))
920 # print " {res.length} jobs executed"
921 for res
in response
do
922 if not res
isa JsonObject then
923 errors
.add
(new NeoError("Unexpected job format in batch response.", "Neo4jError"))
926 var id
= res
["id"].as(Int)
928 if job
.action
== create_node_action
then
929 var node
= job
.entity
.as(NeoNode)
931 node
.url
= res
["location"].to_s
932 else if job
.action
== create_edge_action
then
933 var edge
= job
.entity
.as(NeoEdge)
935 edge
.url
= res
["location"].to_s
936 else if job
.action
== load_node_data_action
then
937 var node
= job
.entity
.as(NeoNode)
938 node
.internal_properties
= res
["body"].as(JsonObject)["data"].as(JsonObject)
939 else if job
.action
== load_node_labels_action
then
940 var node
= job
.entity
.as(NeoNode)
941 var labels
= new Array[String]
942 for l
in res
["body"].as(JsonArray) do labels
.add l
.to_s
943 node
.internal_labels
= labels
944 else if job
.action
== load_node_in_edges_action
then
945 var node
= job
.entity
.as(NeoNode)
946 var edges
= res
["body"].as(JsonArray)
947 node
.internal_in_edges
= new List[NeoEdge]
949 node
.internal_in_edges
.add client
.load_edge
(edge
.as(JsonObject)["self"].to_s
)
951 else if job
.action
== load_node_out_edges_action
then
952 var node
= job
.entity
.as(NeoNode)
953 var edges
= res
["body"].as(JsonArray)
954 node
.internal_out_edges
= new List[NeoEdge]
956 node
.internal_out_edges
.add client
.load_edge
(edge
.as(JsonObject)["self"].to_s
)
964 # TODO replace with enum
966 private fun create_node_action
: Int do return 1
967 private fun create_edge_action
: Int do return 2
968 private fun load_node_data_action
: Int do return 3
969 private fun load_node_labels_action
: Int do return 4
970 private fun load_node_in_edges_action
: Int do return 5
971 private fun load_node_out_edges_action
: Int do return 6
974 # A job that can be executed in a `NeoBatch`
975 # This is a representation of a neo job in JSON Format
977 # Each job description should contain a `to` attribute, with a value relative to the data API root
978 # (so http://localhost:7474/db/data/node becomes just /node), and a `method` attribute containing
981 # Optionally you may provide a `body` attribute, and an `id` attribute to help you keep track
982 # of responses, although responses are guaranteed to be returned in the same order the job
983 # descriptions are received.
987 # Entity targeted by the job
988 var entity
: NeoEntity
990 init(id
: Int, entity
: NeoEntity) do
995 # What kind of action do the job
996 # used to attach responses to original Neo objets
997 private var action
: nullable Int = null
999 # Job HTTP method: `GET`, `POST`, `PUT`, `DELETE`...
1001 # Job service target: `/node`, `/labels` etc...
1003 # Body to send with the job service request
1004 var body
: nullable Jsonable = null
1007 fun to_rest
: JsonObject do
1008 var job
= new JsonObject
1010 job
["method"] = method
1012 if not body
== null then