apoc.paths.toJsonTree
|
Despite its name, this procedure do not output json. |
Syntax |
|
||
Description |
Creates a stream of nested documents representing the graph as a tree by traversing outgoing relationships. |
||
Input arguments |
Name |
Type |
Description |
|
|
A list of paths to convert into a tree. |
|
|
|
Whether or not to convert relationship types to lower case. The default is: |
|
|
|
|
|
Return arguments |
Name |
Type |
Description |
|
|
The resulting tree. |
|
Config parameters
The procedure support the following config parameters:
| Name | Type | Default | Description |
|---|---|---|---|
|
|
{} |
properties to include or exclude for each node label e.g. to include |
|
|
{} |
properties to include or exclude for each relationship type e.g. to include |
|
|
true |
to sort the result by path length. |
Usage examples
The examples in this section are based on the following sample graph:
CREATE (Keanu:Person {name:'Keanu Reeves', born:1964})
CREATE (TomH:Person {name:'Tom Hanks', born:1956})
CREATE (TomT:Person {name:'Tom Tykwer', born:1965})
CREATE (JamesThompson:Person {name:'James Thompson'})
CREATE (TheMatrix:Movie {title:'The Matrix', released:1999, tagline:'Welcome to the Real World'})
CREATE (TheMatrixReloaded:Movie {title:'The Matrix Reloaded', released:2003, tagline:'Free your mind'})
CREATE (TheMatrixRevolutions:Movie {title:'The Matrix Revolutions', released:2003, tagline:'Everything that has a beginning has an end'})
CREATE (SomethingsGottaGive:Movie {title:"Something's Gotta Give", released:2003})
CREATE (TheDevilsAdvocate:Movie {title:"The Devil's Advocate", released:1997, tagline:'Evil has its winning ways'})
CREATE (YouveGotMail:Movie {title:"You've Got Mail", released:1998, tagline:'At odds in life... in love on-line.'})
CREATE (SleeplessInSeattle:Movie {title:'Sleepless in Seattle', released:1993, tagline:'What if someone you never met, someone you never saw, someone you never knew was the only someone for you?'})
CREATE (ThatThingYouDo:Movie {title:'That Thing You Do', released:1996, tagline:'In every life there comes a time when that thing you dream becomes that thing you do'})
CREATE (CloudAtlas:Movie {title:'Cloud Atlas', released:2012, tagline:'Everything is connected'})
CREATE (Keanu)-[:ACTED_IN {roles:['Neo']}]->(TheMatrix)
CREATE (Keanu)-[:ACTED_IN {roles:['Neo']}]->(TheMatrixReloaded)
CREATE (Keanu)-[:ACTED_IN {roles:['Neo']}]->(TheMatrixRevolutions)
CREATE (Keanu)-[:ACTED_IN {roles:['Julian Mercer']}]->(SomethingsGottaGive)
CREATE (Keanu)-[:ACTED_IN {roles:['Kevin Lomax']}]->(TheDevilsAdvocate)
CREATE (TomH)-[:ACTED_IN {roles:['Joe Fox']}]->(YouveGotMail)
CREATE (TomH)-[:ACTED_IN {roles:['Sam Baldwin']}]->(SleeplessInSeattle)
CREATE (TomH)-[:ACTED_IN {roles:['Mr. White']}]->(ThatThingYouDo)
CREATE (TomH)-[:ACTED_IN {roles:['Zachry', 'Dr. Henry Goose', 'Isaac Sachs', 'Dermot Hoggins']}]->(CloudAtlas)
CREATE (TomT)-[:DIRECTED]->(CloudAtlas)
CREATE (JamesThompson)-[:REVIEWED {summary:'Enjoyed it!', rating:95}]->(TheMatrix)
CREATE (JamesThompson)-[:REVIEWED {summary:'It was alright.', rating:65}]->(TheMatrixReloaded)
CREATE (JamesThompson)-[:REVIEWED {summary:'The best of the three', rating:100}]->(TheMatrixRevolutions);The following converts a list of paths of Keanu Reeves movies into a nested map:
MATCH path = (p:Person {name: "Keanu Reeves"})-[:ACTED_IN]->(movie)
WITH collect(path) AS paths
CALL apoc.paths.toJsonTree(paths)
YIELD value
RETURN value;| value |
|---|
|
By default, relationship types are converted to lower case.
To keep the original case pass in false for the second parameter (lowerCaseRels):
MATCH path = (p:Person {name: "Keanu Reeves"})-[:ACTED_IN]->(movie)
WITH collect(path) AS paths
CALL apoc.paths.toJsonTree(paths, false)
YIELD value
RETURN value;| value |
|---|
|
By default, all properties are included for node labels and relationship types.
To limit the properties for nodes use the nodes config key.
For relationship types use the rels config key.
The following query demonstrates how to return only the title property for Movie nodes by setting the nodes config key:
MATCH path = (p:Person {name: "Keanu Reeves"})-[:ACTED_IN]->(movie)
WITH collect(path) AS paths
CALL apoc.paths.toJsonTree(paths, true, {
nodes: {Movie: ['title']}
})
YIELD value
RETURN value;| value |
|---|
|
The following query demonstrates returning only the REVIEWED rating and title of Movie nodes reviewed by James Thompson:
MATCH path = (p:Person {name:'James Thompson'})-[:REVIEWED]->(movie)
WITH collect(path) AS paths
CALL apoc.paths.toJsonTree(paths, true, {
nodes: {Movie: ['title']},
rels: {reviewed: ['rating']}
})
YIELD value
RETURN value;| value |
|---|
|
It is also possible to explicitly exclude certain properties by prepending them with a minus symbol (-).
The following query demonstrates how to exclude title properties on Movie nodes and rating properties on REVIEWED relationships.
MATCH path = (p:Person {name:'James Thompson'})-[:REVIEWED]->(movie)
WITH collect(path) AS paths
CALL apoc.paths.toJsonTree(paths, true, {
nodes: {Movie: ['-title']},
rels: {reviewed: ['-rating']}
})
YIELD value
RETURN value;| value |
|---|
|