HTTP Interface for Traversals
Traversals
ArangoDB's graph traversals are executed on the server. Traversals can be initiated by clients by sending the traversal description for execution to the server.
Traversals in ArangoDB are used to walk over a graph stored in one edge collection. It can easily be described which edges of the graph should be followed and which actions should be performed on each visited vertex. Furthermore the ordering of visiting the nodes can be specified, for instance depth-first or breadth-first search are offered.
Executing Traversals via HTTP
executes a traversal
execute a server-side traversal
POST /_api/traversal
Starts a traversal starting from a given vertex and following. edges contained in a given edgeCollection. The request must contain the following attributes.
A JSON object with these properties is required:
- sort: body (JavaScript) code of a custom comparison function for the edges. The signature of this function is (l, r) -> integer (where l and r are edges) and must return -1 if l is smaller than, +1 if l is greater than, and 0 if l and r are equal. The reason for this is the following: The order of edges returned for a certain vertex is undefined. This is because there is no natural order of edges for a vertex with multiple connected edges. To explicitly define the order in which edges on the vertex are followed, you can specify an edge comparator function with this attribute. Note that the value here has to be a string to conform to the JSON standard, which in turn is parsed as function body on the server side. Furthermore note that this attribute is only used for the standard expanders. If you use your custom expander you have to do the sorting yourself within the expander code.
- direction: direction for traversal
- if set, must be either "outbound", "inbound", or "any"
- if not set, the expander attribute must be specified
- minDepth: ANDed with any existing filters): visits only nodes in at least the given depth
- startVertex: id of the startVertex, e.g. "users/foo".
- visitor: body (JavaScript) code of custom visitor function function signature: (config, result, vertex, path, connected) -> void The visitor function can do anything, but its return value is ignored. To populate a result, use the result variable by reference. Note that the connected argument is only populated when the order attribute is set to "preorder-expander".
- itemOrder: item iteration order can be "forward" or "backward"
- strategy: traversal strategy can be "depthfirst" or "breadthfirst"
- filter: default is to include all nodes:
body (JavaScript code) of custom filter function
function signature: (config, vertex, path) -> mixed
can return four different string values:
- "exclude" -> this vertex will not be visited.
- "prune" -> the edges of this vertex will not be followed.
- "" or undefined -> visit the vertex and follow it's edges.
- Array -> containing any combination of the above. If there is at least one "exclude" or "prune" respectivly is contained, it's effect will occur.
- init: body (JavaScript) code of custom result initialization function function signature: (config, result) -> void initialize any values in result with what is required
- maxIterations: Maximum number of iterations in each traversal. This number can be set to prevent endless loops in traversal of cyclic graphs. When a traversal performs as many iterations as the maxIterations value, the traversal will abort with an error. If maxIterations is not set, a server-defined value may be used.
- maxDepth: ANDed with any existing filters visits only nodes in at most the given depth
- uniqueness: specifies uniqueness for vertices and edges visited.
If set, must be an object like this:
"uniqueness": {"vertices": "none"|"global"|"path", "edges": "none"|"global"|"path"}
- order: traversal order can be "preorder", "postorder" or "preorder-expander"
- graphName: name of the graph that contains the edges. Either edgeCollection or graphName has to be given. In case both values are set the graphName is prefered.
- expander: body (JavaScript) code of custom expander function must be set if direction attribute is not set function signature: (config, vertex, path) -> array expander must return an array of the connections for vertex each connection is an object with the attributes edge and vertex
- edgeCollection: name of the collection that contains the edges.
If the Traversal is successfully executed HTTP 200 will be returned. Additionally the result object will be returned by the traversal.
For successful traversals, the returned JSON object has the following properties:
error: boolean flag to indicate if an error occurred (false in this case)
code: the HTTP status code
result: the return value of the traversal
If the traversal specification is either missing or malformed, the server will respond with HTTP 400.
The body of the response will then contain a JSON object with additional error details. The object has the following attributes:
error: boolean flag to indicate that an error occurred (true in this case)
code: the HTTP status code
errorNum: the server error number
errorMessage: a descriptive error message
Example:
In the following examples the underlying graph will contain five persons Alice, Bob, Charlie, Dave and Eve. We will have the following directed relations:
- Alice knows Bob
- Bob knows Charlie
- Bob knows Dave
- Eve knows Alice
- Eve knows Bob
The starting vertex will always be Alice.
Follow only outbound edges
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF
{
"startVertex" : "persons/alice",
"graphName" : "knows_graph",
"direction" : "outbound"
}
EOF
HTTP/1.1 200 OK
content-type: application/json; charset=utf-8
x-content-type-options: nosniff
{
"result" : {
"visited" : {
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY8V2--_",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY8V2--A",
"name" : "Bob"
},
{
"_key" : "charlie",
"_id" : "persons/charlie",
"_rev" : "_VwZY8V2--B",
"name" : "Charlie"
},
{
"_key" : "dave",
"_id" : "persons/dave",
"_rev" : "_VwZY8V2--C",
"name" : "Dave"
}
],
"paths" : [
{
"edges" : [ ],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY8V2--_",
"name" : "Alice"
}
]
},
{
"edges" : [
{
"_key" : "13603",
"_id" : "knows/13603",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_VwZY8V6--_",
"vertex" : "alice"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY8V2--_",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY8V2--A",
"name" : "Bob"
}
]
},
{
"edges" : [
{
"_key" : "13603",
"_id" : "knows/13603",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_VwZY8V6--_",
"vertex" : "alice"
},
{
"_key" : "13607",
"_id" : "knows/13607",
"_from" : "persons/bob",
"_to" : "persons/charlie",
"_rev" : "_VwZY8V6--A",
"vertex" : "bob"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY8V2--_",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY8V2--A",
"name" : "Bob"
},
{
"_key" : "charlie",
"_id" : "persons/charlie",
"_rev" : "_VwZY8V2--B",
"name" : "Charlie"
}
]
},
{
"edges" : [
{
"_key" : "13603",
"_id" : "knows/13603",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_VwZY8V6--_",
"vertex" : "alice"
},
{
"_key" : "13610",
"_id" : "knows/13610",
"_from" : "persons/bob",
"_to" : "persons/dave",
"_rev" : "_VwZY8V6--B",
"vertex" : "bob"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY8V2--_",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY8V2--A",
"name" : "Bob"
},
{
"_key" : "dave",
"_id" : "persons/dave",
"_rev" : "_VwZY8V2--C",
"name" : "Dave"
}
]
}
]
}
},
"error" : false,
"code" : 200
}
Example:
Follow only inbound edges
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF
{
"startVertex" : "persons/alice",
"graphName" : "knows_graph",
"direction" : "inbound"
}
EOF
HTTP/1.1 200 OK
content-type: application/json; charset=utf-8
x-content-type-options: nosniff
{
"result" : {
"visited" : {
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY8Am---",
"name" : "Alice"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_VwZY8Am--C",
"name" : "Eve"
}
],
"paths" : [
{
"edges" : [ ],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY8Am---",
"name" : "Alice"
}
]
},
{
"edges" : [
{
"_key" : "13282",
"_id" : "knows/13282",
"_from" : "persons/eve",
"_to" : "persons/alice",
"_rev" : "_VwZY8Am--G",
"vertex" : "eve"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY8Am---",
"name" : "Alice"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_VwZY8Am--C",
"name" : "Eve"
}
]
}
]
}
},
"error" : false,
"code" : 200
}
Example:
Follow any direction of edges
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF
{
"startVertex" : "persons/alice",
"graphName" : "knows_graph",
"direction" : "any",
"uniqueness" : {
"vertices" : "none",
"edges" : "global"
}
}
EOF
HTTP/1.1 200 OK
content-type: application/json; charset=utf-8
x-content-type-options: nosniff
{
"result" : {
"visited" : {
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7kq--_",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY7kq--A",
"name" : "Bob"
},
{
"_key" : "charlie",
"_id" : "persons/charlie",
"_rev" : "_VwZY7ku---",
"name" : "Charlie"
},
{
"_key" : "dave",
"_id" : "persons/dave",
"_rev" : "_VwZY7ku--_",
"name" : "Dave"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_VwZY7ku--A",
"name" : "Eve"
},
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7kq--_",
"name" : "Alice"
}
],
"paths" : [
{
"edges" : [ ],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7kq--_",
"name" : "Alice"
}
]
},
{
"edges" : [
{
"_key" : "12735",
"_id" : "knows/12735",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_VwZY7ku--B",
"vertex" : "alice"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7kq--_",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY7kq--A",
"name" : "Bob"
}
]
},
{
"edges" : [
{
"_key" : "12735",
"_id" : "knows/12735",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_VwZY7ku--B",
"vertex" : "alice"
},
{
"_key" : "12739",
"_id" : "knows/12739",
"_from" : "persons/bob",
"_to" : "persons/charlie",
"_rev" : "_VwZY7ku--C",
"vertex" : "bob"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7kq--_",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY7kq--A",
"name" : "Bob"
},
{
"_key" : "charlie",
"_id" : "persons/charlie",
"_rev" : "_VwZY7ku---",
"name" : "Charlie"
}
]
},
{
"edges" : [
{
"_key" : "12735",
"_id" : "knows/12735",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_VwZY7ku--B",
"vertex" : "alice"
},
{
"_key" : "12742",
"_id" : "knows/12742",
"_from" : "persons/bob",
"_to" : "persons/dave",
"_rev" : "_VwZY7ku--D",
"vertex" : "bob"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7kq--_",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY7kq--A",
"name" : "Bob"
},
{
"_key" : "dave",
"_id" : "persons/dave",
"_rev" : "_VwZY7ku--_",
"name" : "Dave"
}
]
},
{
"edges" : [
{
"_key" : "12735",
"_id" : "knows/12735",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_VwZY7ku--B",
"vertex" : "alice"
},
{
"_key" : "12748",
"_id" : "knows/12748",
"_from" : "persons/eve",
"_to" : "persons/bob",
"_rev" : "_VwZY7ky--_",
"vertex" : "eve"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7kq--_",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY7kq--A",
"name" : "Bob"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_VwZY7ku--A",
"name" : "Eve"
}
]
},
{
"edges" : [
{
"_key" : "12735",
"_id" : "knows/12735",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_VwZY7ku--B",
"vertex" : "alice"
},
{
"_key" : "12748",
"_id" : "knows/12748",
"_from" : "persons/eve",
"_to" : "persons/bob",
"_rev" : "_VwZY7ky--_",
"vertex" : "eve"
},
{
"_key" : "12745",
"_id" : "knows/12745",
"_from" : "persons/eve",
"_to" : "persons/alice",
"_rev" : "_VwZY7ky---",
"vertex" : "eve"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7kq--_",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY7kq--A",
"name" : "Bob"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_VwZY7ku--A",
"name" : "Eve"
},
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7kq--_",
"name" : "Alice"
}
]
}
]
}
},
"error" : false,
"code" : 200
}
Example:
Excluding Charlie and Bob
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF
{
"startVertex" : "persons/alice",
"graphName" : "knows_graph",
"direction" : "outbound",
"filter" : "if (vertex.name === \"Bob\" || vertex.name === \"Charlie\") { return \"exclude\";}return;"
}
EOF
HTTP/1.1 200 OK
content-type: application/json; charset=utf-8
x-content-type-options: nosniff
{
"result" : {
"visited" : {
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY73C--_",
"name" : "Alice"
},
{
"_key" : "dave",
"_id" : "persons/dave",
"_rev" : "_VwZY73C--C",
"name" : "Dave"
}
],
"paths" : [
{
"edges" : [ ],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY73C--_",
"name" : "Alice"
}
]
},
{
"edges" : [
{
"_key" : "13121",
"_id" : "knows/13121",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_VwZY73G--_",
"vertex" : "alice"
},
{
"_key" : "13128",
"_id" : "knows/13128",
"_from" : "persons/bob",
"_to" : "persons/dave",
"_rev" : "_VwZY73G--B",
"vertex" : "bob"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY73C--_",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY73C--A",
"name" : "Bob"
},
{
"_key" : "dave",
"_id" : "persons/dave",
"_rev" : "_VwZY73C--C",
"name" : "Dave"
}
]
}
]
}
},
"error" : false,
"code" : 200
}
Example:
Do not follow edges from Bob
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF
{
"startVertex" : "persons/alice",
"graphName" : "knows_graph",
"direction" : "outbound",
"filter" : "if (vertex.name === \"Bob\") {return \"prune\";}return;"
}
EOF
HTTP/1.1 200 OK
content-type: application/json; charset=utf-8
x-content-type-options: nosniff
{
"result" : {
"visited" : {
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY78a---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY78a--_",
"name" : "Bob"
}
],
"paths" : [
{
"edges" : [ ],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY78a---",
"name" : "Alice"
}
]
},
{
"edges" : [
{
"_key" : "13199",
"_id" : "knows/13199",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_VwZY78a--D",
"vertex" : "alice"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY78a---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY78a--_",
"name" : "Bob"
}
]
}
]
}
},
"error" : false,
"code" : 200
}
Example:
Visit only nodes in a depth of at least 2
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF
{
"startVertex" : "persons/alice",
"graphName" : "knows_graph",
"direction" : "outbound",
"minDepth" : 2
}
EOF
HTTP/1.1 200 OK
content-type: application/json; charset=utf-8
x-content-type-options: nosniff
{
"result" : {
"visited" : {
"vertices" : [
{
"_key" : "charlie",
"_id" : "persons/charlie",
"_rev" : "_VwZY8Rm---",
"name" : "Charlie"
},
{
"_key" : "dave",
"_id" : "persons/dave",
"_rev" : "_VwZY8Rm--_",
"name" : "Dave"
}
],
"paths" : [
{
"edges" : [
{
"_key" : "13525",
"_id" : "knows/13525",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_VwZY8Rm--B",
"vertex" : "alice"
},
{
"_key" : "13529",
"_id" : "knows/13529",
"_from" : "persons/bob",
"_to" : "persons/charlie",
"_rev" : "_VwZY8Rm--C",
"vertex" : "bob"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY8Ri--_",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY8Ri--A",
"name" : "Bob"
},
{
"_key" : "charlie",
"_id" : "persons/charlie",
"_rev" : "_VwZY8Rm---",
"name" : "Charlie"
}
]
},
{
"edges" : [
{
"_key" : "13525",
"_id" : "knows/13525",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_VwZY8Rm--B",
"vertex" : "alice"
},
{
"_key" : "13532",
"_id" : "knows/13532",
"_from" : "persons/bob",
"_to" : "persons/dave",
"_rev" : "_VwZY8Rm--D",
"vertex" : "bob"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY8Ri--_",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY8Ri--A",
"name" : "Bob"
},
{
"_key" : "dave",
"_id" : "persons/dave",
"_rev" : "_VwZY8Rm--_",
"name" : "Dave"
}
]
}
]
}
},
"error" : false,
"code" : 200
}
Example:
Visit only nodes in a depth of at most 1
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF
{
"startVertex" : "persons/alice",
"graphName" : "knows_graph",
"direction" : "outbound",
"maxDepth" : 1
}
EOF
HTTP/1.1 200 OK
content-type: application/json; charset=utf-8
x-content-type-options: nosniff
{
"result" : {
"visited" : {
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY8H---_",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY8H---A",
"name" : "Bob"
}
],
"paths" : [
{
"edges" : [ ],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY8H---_",
"name" : "Alice"
}
]
},
{
"edges" : [
{
"_key" : "13346",
"_id" : "knows/13346",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_VwZY8HC--A",
"vertex" : "alice"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY8H---_",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY8H---A",
"name" : "Bob"
}
]
}
]
}
},
"error" : false,
"code" : 200
}
Example:
Using a visitor function to return vertex ids only
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF
{
"startVertex" : "persons/alice",
"graphName" : "knows_graph",
"direction" : "outbound",
"visitor" : "result.visited.vertices.push(vertex._id);"
}
EOF
HTTP/1.1 200 OK
content-type: application/json; charset=utf-8
x-content-type-options: nosniff
{
"result" : {
"visited" : {
"vertices" : [
"persons/alice",
"persons/bob",
"persons/charlie",
"persons/dave"
],
"paths" : [ ]
}
},
"error" : false,
"code" : 200
}
Example:
Count all visited nodes and return a list of nodes only
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF
{
"startVertex" : "persons/alice",
"graphName" : "knows_graph",
"direction" : "outbound",
"init" : "result.visited = 0; result.myVertices = [ ];",
"visitor" : "result.visited++; result.myVertices.push(vertex);"
}
EOF
HTTP/1.1 200 OK
content-type: application/json; charset=utf-8
x-content-type-options: nosniff
{
"result" : {
"visited" : 4,
"myVertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY8ge---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY8ge--_",
"name" : "Bob"
},
{
"_key" : "charlie",
"_id" : "persons/charlie",
"_rev" : "_VwZY8ge--A",
"name" : "Charlie"
},
{
"_key" : "dave",
"_id" : "persons/dave",
"_rev" : "_VwZY8ge--B",
"name" : "Dave"
}
]
},
"error" : false,
"code" : 200
}
Example:
Expand only inbound edges of Alice and outbound edges of Eve
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF
{
"startVertex" : "persons/alice",
"graphName" : "knows_graph",
"expander" : "var connections = [ ];if (vertex.name === \"Alice\") {config.datasource.getInEdges(vertex).forEach(function (e) {connections.push({ vertex: require(\"internal\").db._document(e._from), edge: e});});}if (vertex.name === \"Eve\") {config.datasource.getOutEdges(vertex).forEach(function (e) {connections.push({vertex: require(\"internal\").db._document(e._to), edge: e});});}return connections;"
}
EOF
HTTP/1.1 200 OK
content-type: application/json; charset=utf-8
x-content-type-options: nosniff
{
"result" : {
"visited" : {
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY8ka---",
"name" : "Alice"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_VwZY8ka--C",
"name" : "Eve"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY8ka--_",
"name" : "Bob"
}
],
"paths" : [
{
"edges" : [ ],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY8ka---",
"name" : "Alice"
}
]
},
{
"edges" : [
{
"_key" : "13873",
"_id" : "knows/13873",
"_from" : "persons/eve",
"_to" : "persons/alice",
"_rev" : "_VwZY8ke--_",
"vertex" : "eve"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY8ka---",
"name" : "Alice"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_VwZY8ka--C",
"name" : "Eve"
}
]
},
{
"edges" : [
{
"_key" : "13873",
"_id" : "knows/13873",
"_from" : "persons/eve",
"_to" : "persons/alice",
"_rev" : "_VwZY8ke--_",
"vertex" : "eve"
},
{
"_key" : "13876",
"_id" : "knows/13876",
"_from" : "persons/eve",
"_to" : "persons/bob",
"_rev" : "_VwZY8ke--A",
"vertex" : "eve"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY8ka---",
"name" : "Alice"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_VwZY8ka--C",
"name" : "Eve"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY8ka--_",
"name" : "Bob"
}
]
}
]
}
},
"error" : false,
"code" : 200
}
Example:
Follow the depthfirst strategy
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF
{
"startVertex" : "persons/alice",
"graphName" : "knows_graph",
"direction" : "any",
"strategy" : "depthfirst"
}
EOF
HTTP/1.1 200 OK
content-type: application/json; charset=utf-8
x-content-type-options: nosniff
{
"result" : {
"visited" : {
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7u---_",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY7uC---",
"name" : "Bob"
},
{
"_key" : "charlie",
"_id" : "persons/charlie",
"_rev" : "_VwZY7uC--_",
"name" : "Charlie"
},
{
"_key" : "dave",
"_id" : "persons/dave",
"_rev" : "_VwZY7uC--A",
"name" : "Dave"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_VwZY7uC--B",
"name" : "Eve"
},
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7u---_",
"name" : "Alice"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_VwZY7uC--B",
"name" : "Eve"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY7uC---",
"name" : "Bob"
},
{
"_key" : "charlie",
"_id" : "persons/charlie",
"_rev" : "_VwZY7uC--_",
"name" : "Charlie"
},
{
"_key" : "dave",
"_id" : "persons/dave",
"_rev" : "_VwZY7uC--A",
"name" : "Dave"
},
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7u---_",
"name" : "Alice"
}
],
"paths" : [
{
"edges" : [ ],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7u---_",
"name" : "Alice"
}
]
},
{
"edges" : [
{
"_key" : "12928",
"_id" : "knows/12928",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_VwZY7uC--C",
"vertex" : "alice"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7u---_",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY7uC---",
"name" : "Bob"
}
]
},
{
"edges" : [
{
"_key" : "12928",
"_id" : "knows/12928",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_VwZY7uC--C",
"vertex" : "alice"
},
{
"_key" : "12932",
"_id" : "knows/12932",
"_from" : "persons/bob",
"_to" : "persons/charlie",
"_rev" : "_VwZY7uC--D",
"vertex" : "bob"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7u---_",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY7uC---",
"name" : "Bob"
},
{
"_key" : "charlie",
"_id" : "persons/charlie",
"_rev" : "_VwZY7uC--_",
"name" : "Charlie"
}
]
},
{
"edges" : [
{
"_key" : "12928",
"_id" : "knows/12928",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_VwZY7uC--C",
"vertex" : "alice"
},
{
"_key" : "12935",
"_id" : "knows/12935",
"_from" : "persons/bob",
"_to" : "persons/dave",
"_rev" : "_VwZY7uC--E",
"vertex" : "bob"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7u---_",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY7uC---",
"name" : "Bob"
},
{
"_key" : "dave",
"_id" : "persons/dave",
"_rev" : "_VwZY7uC--A",
"name" : "Dave"
}
]
},
{
"edges" : [
{
"_key" : "12928",
"_id" : "knows/12928",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_VwZY7uC--C",
"vertex" : "alice"
},
{
"_key" : "12941",
"_id" : "knows/12941",
"_from" : "persons/eve",
"_to" : "persons/bob",
"_rev" : "_VwZY7uG--_",
"vertex" : "eve"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7u---_",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY7uC---",
"name" : "Bob"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_VwZY7uC--B",
"name" : "Eve"
}
]
},
{
"edges" : [
{
"_key" : "12928",
"_id" : "knows/12928",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_VwZY7uC--C",
"vertex" : "alice"
},
{
"_key" : "12941",
"_id" : "knows/12941",
"_from" : "persons/eve",
"_to" : "persons/bob",
"_rev" : "_VwZY7uG--_",
"vertex" : "eve"
},
{
"_key" : "12938",
"_id" : "knows/12938",
"_from" : "persons/eve",
"_to" : "persons/alice",
"_rev" : "_VwZY7uG---",
"vertex" : "eve"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7u---_",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY7uC---",
"name" : "Bob"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_VwZY7uC--B",
"name" : "Eve"
},
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7u---_",
"name" : "Alice"
}
]
},
{
"edges" : [
{
"_key" : "12938",
"_id" : "knows/12938",
"_from" : "persons/eve",
"_to" : "persons/alice",
"_rev" : "_VwZY7uG---",
"vertex" : "eve"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7u---_",
"name" : "Alice"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_VwZY7uC--B",
"name" : "Eve"
}
]
},
{
"edges" : [
{
"_key" : "12938",
"_id" : "knows/12938",
"_from" : "persons/eve",
"_to" : "persons/alice",
"_rev" : "_VwZY7uG---",
"vertex" : "eve"
},
{
"_key" : "12941",
"_id" : "knows/12941",
"_from" : "persons/eve",
"_to" : "persons/bob",
"_rev" : "_VwZY7uG--_",
"vertex" : "eve"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7u---_",
"name" : "Alice"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_VwZY7uC--B",
"name" : "Eve"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY7uC---",
"name" : "Bob"
}
]
},
{
"edges" : [
{
"_key" : "12938",
"_id" : "knows/12938",
"_from" : "persons/eve",
"_to" : "persons/alice",
"_rev" : "_VwZY7uG---",
"vertex" : "eve"
},
{
"_key" : "12941",
"_id" : "knows/12941",
"_from" : "persons/eve",
"_to" : "persons/bob",
"_rev" : "_VwZY7uG--_",
"vertex" : "eve"
},
{
"_key" : "12932",
"_id" : "knows/12932",
"_from" : "persons/bob",
"_to" : "persons/charlie",
"_rev" : "_VwZY7uC--D",
"vertex" : "bob"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7u---_",
"name" : "Alice"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_VwZY7uC--B",
"name" : "Eve"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY7uC---",
"name" : "Bob"
},
{
"_key" : "charlie",
"_id" : "persons/charlie",
"_rev" : "_VwZY7uC--_",
"name" : "Charlie"
}
]
},
{
"edges" : [
{
"_key" : "12938",
"_id" : "knows/12938",
"_from" : "persons/eve",
"_to" : "persons/alice",
"_rev" : "_VwZY7uG---",
"vertex" : "eve"
},
{
"_key" : "12941",
"_id" : "knows/12941",
"_from" : "persons/eve",
"_to" : "persons/bob",
"_rev" : "_VwZY7uG--_",
"vertex" : "eve"
},
{
"_key" : "12935",
"_id" : "knows/12935",
"_from" : "persons/bob",
"_to" : "persons/dave",
"_rev" : "_VwZY7uC--E",
"vertex" : "bob"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7u---_",
"name" : "Alice"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_VwZY7uC--B",
"name" : "Eve"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY7uC---",
"name" : "Bob"
},
{
"_key" : "dave",
"_id" : "persons/dave",
"_rev" : "_VwZY7uC--A",
"name" : "Dave"
}
]
},
{
"edges" : [
{
"_key" : "12938",
"_id" : "knows/12938",
"_from" : "persons/eve",
"_to" : "persons/alice",
"_rev" : "_VwZY7uG---",
"vertex" : "eve"
},
{
"_key" : "12941",
"_id" : "knows/12941",
"_from" : "persons/eve",
"_to" : "persons/bob",
"_rev" : "_VwZY7uG--_",
"vertex" : "eve"
},
{
"_key" : "12928",
"_id" : "knows/12928",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_VwZY7uC--C",
"vertex" : "alice"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7u---_",
"name" : "Alice"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_VwZY7uC--B",
"name" : "Eve"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY7uC---",
"name" : "Bob"
},
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7u---_",
"name" : "Alice"
}
]
}
]
}
},
"error" : false,
"code" : 200
}
Example:
Using postorder ordering
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF
{
"startVertex" : "persons/alice",
"graphName" : "knows_graph",
"direction" : "any",
"order" : "postorder"
}
EOF
HTTP/1.1 200 OK
content-type: application/json; charset=utf-8
x-content-type-options: nosniff
{
"result" : {
"visited" : {
"vertices" : [
{
"_key" : "charlie",
"_id" : "persons/charlie",
"_rev" : "_VwZY8au--A",
"name" : "Charlie"
},
{
"_key" : "dave",
"_id" : "persons/dave",
"_rev" : "_VwZY8au--B",
"name" : "Dave"
},
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY8au---",
"name" : "Alice"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_VwZY8au--C",
"name" : "Eve"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY8au--_",
"name" : "Bob"
},
{
"_key" : "charlie",
"_id" : "persons/charlie",
"_rev" : "_VwZY8au--A",
"name" : "Charlie"
},
{
"_key" : "dave",
"_id" : "persons/dave",
"_rev" : "_VwZY8au--B",
"name" : "Dave"
},
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY8au---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY8au--_",
"name" : "Bob"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_VwZY8au--C",
"name" : "Eve"
},
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY8au---",
"name" : "Alice"
}
],
"paths" : [
{
"edges" : [
{
"_key" : "13681",
"_id" : "knows/13681",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_VwZY8au--D",
"vertex" : "alice"
},
{
"_key" : "13685",
"_id" : "knows/13685",
"_from" : "persons/bob",
"_to" : "persons/charlie",
"_rev" : "_VwZY8au--E",
"vertex" : "bob"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY8au---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY8au--_",
"name" : "Bob"
},
{
"_key" : "charlie",
"_id" : "persons/charlie",
"_rev" : "_VwZY8au--A",
"name" : "Charlie"
}
]
},
{
"edges" : [
{
"_key" : "13681",
"_id" : "knows/13681",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_VwZY8au--D",
"vertex" : "alice"
},
{
"_key" : "13688",
"_id" : "knows/13688",
"_from" : "persons/bob",
"_to" : "persons/dave",
"_rev" : "_VwZY8au--F",
"vertex" : "bob"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY8au---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY8au--_",
"name" : "Bob"
},
{
"_key" : "dave",
"_id" : "persons/dave",
"_rev" : "_VwZY8au--B",
"name" : "Dave"
}
]
},
{
"edges" : [
{
"_key" : "13681",
"_id" : "knows/13681",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_VwZY8au--D",
"vertex" : "alice"
},
{
"_key" : "13694",
"_id" : "knows/13694",
"_from" : "persons/eve",
"_to" : "persons/bob",
"_rev" : "_VwZY8au--H",
"vertex" : "eve"
},
{
"_key" : "13691",
"_id" : "knows/13691",
"_from" : "persons/eve",
"_to" : "persons/alice",
"_rev" : "_VwZY8au--G",
"vertex" : "eve"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY8au---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY8au--_",
"name" : "Bob"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_VwZY8au--C",
"name" : "Eve"
},
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY8au---",
"name" : "Alice"
}
]
},
{
"edges" : [
{
"_key" : "13681",
"_id" : "knows/13681",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_VwZY8au--D",
"vertex" : "alice"
},
{
"_key" : "13694",
"_id" : "knows/13694",
"_from" : "persons/eve",
"_to" : "persons/bob",
"_rev" : "_VwZY8au--H",
"vertex" : "eve"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY8au---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY8au--_",
"name" : "Bob"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_VwZY8au--C",
"name" : "Eve"
}
]
},
{
"edges" : [
{
"_key" : "13681",
"_id" : "knows/13681",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_VwZY8au--D",
"vertex" : "alice"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY8au---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY8au--_",
"name" : "Bob"
}
]
},
{
"edges" : [
{
"_key" : "13691",
"_id" : "knows/13691",
"_from" : "persons/eve",
"_to" : "persons/alice",
"_rev" : "_VwZY8au--G",
"vertex" : "eve"
},
{
"_key" : "13694",
"_id" : "knows/13694",
"_from" : "persons/eve",
"_to" : "persons/bob",
"_rev" : "_VwZY8au--H",
"vertex" : "eve"
},
{
"_key" : "13685",
"_id" : "knows/13685",
"_from" : "persons/bob",
"_to" : "persons/charlie",
"_rev" : "_VwZY8au--E",
"vertex" : "bob"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY8au---",
"name" : "Alice"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_VwZY8au--C",
"name" : "Eve"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY8au--_",
"name" : "Bob"
},
{
"_key" : "charlie",
"_id" : "persons/charlie",
"_rev" : "_VwZY8au--A",
"name" : "Charlie"
}
]
},
{
"edges" : [
{
"_key" : "13691",
"_id" : "knows/13691",
"_from" : "persons/eve",
"_to" : "persons/alice",
"_rev" : "_VwZY8au--G",
"vertex" : "eve"
},
{
"_key" : "13694",
"_id" : "knows/13694",
"_from" : "persons/eve",
"_to" : "persons/bob",
"_rev" : "_VwZY8au--H",
"vertex" : "eve"
},
{
"_key" : "13688",
"_id" : "knows/13688",
"_from" : "persons/bob",
"_to" : "persons/dave",
"_rev" : "_VwZY8au--F",
"vertex" : "bob"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY8au---",
"name" : "Alice"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_VwZY8au--C",
"name" : "Eve"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY8au--_",
"name" : "Bob"
},
{
"_key" : "dave",
"_id" : "persons/dave",
"_rev" : "_VwZY8au--B",
"name" : "Dave"
}
]
},
{
"edges" : [
{
"_key" : "13691",
"_id" : "knows/13691",
"_from" : "persons/eve",
"_to" : "persons/alice",
"_rev" : "_VwZY8au--G",
"vertex" : "eve"
},
{
"_key" : "13694",
"_id" : "knows/13694",
"_from" : "persons/eve",
"_to" : "persons/bob",
"_rev" : "_VwZY8au--H",
"vertex" : "eve"
},
{
"_key" : "13681",
"_id" : "knows/13681",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_VwZY8au--D",
"vertex" : "alice"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY8au---",
"name" : "Alice"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_VwZY8au--C",
"name" : "Eve"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY8au--_",
"name" : "Bob"
},
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY8au---",
"name" : "Alice"
}
]
},
{
"edges" : [
{
"_key" : "13691",
"_id" : "knows/13691",
"_from" : "persons/eve",
"_to" : "persons/alice",
"_rev" : "_VwZY8au--G",
"vertex" : "eve"
},
{
"_key" : "13694",
"_id" : "knows/13694",
"_from" : "persons/eve",
"_to" : "persons/bob",
"_rev" : "_VwZY8au--H",
"vertex" : "eve"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY8au---",
"name" : "Alice"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_VwZY8au--C",
"name" : "Eve"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY8au--_",
"name" : "Bob"
}
]
},
{
"edges" : [
{
"_key" : "13691",
"_id" : "knows/13691",
"_from" : "persons/eve",
"_to" : "persons/alice",
"_rev" : "_VwZY8au--G",
"vertex" : "eve"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY8au---",
"name" : "Alice"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_VwZY8au--C",
"name" : "Eve"
}
]
},
{
"edges" : [ ],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY8au---",
"name" : "Alice"
}
]
}
]
}
},
"error" : false,
"code" : 200
}
Example:
Using backward item-ordering:
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF
{
"startVertex" : "persons/alice",
"graphName" : "knows_graph",
"direction" : "any",
"itemOrder" : "backward"
}
EOF
HTTP/1.1 200 OK
content-type: application/json; charset=utf-8
x-content-type-options: nosniff
{
"result" : {
"visited" : {
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7ou--_",
"name" : "Alice"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_VwZY7oy--_",
"name" : "Eve"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY7ou--A",
"name" : "Bob"
},
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7ou--_",
"name" : "Alice"
},
{
"_key" : "dave",
"_id" : "persons/dave",
"_rev" : "_VwZY7oy---",
"name" : "Dave"
},
{
"_key" : "charlie",
"_id" : "persons/charlie",
"_rev" : "_VwZY7ou--B",
"name" : "Charlie"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY7ou--A",
"name" : "Bob"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_VwZY7oy--_",
"name" : "Eve"
},
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7ou--_",
"name" : "Alice"
},
{
"_key" : "dave",
"_id" : "persons/dave",
"_rev" : "_VwZY7oy---",
"name" : "Dave"
},
{
"_key" : "charlie",
"_id" : "persons/charlie",
"_rev" : "_VwZY7ou--B",
"name" : "Charlie"
}
],
"paths" : [
{
"edges" : [ ],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7ou--_",
"name" : "Alice"
}
]
},
{
"edges" : [
{
"_key" : "12834",
"_id" : "knows/12834",
"_from" : "persons/eve",
"_to" : "persons/alice",
"_rev" : "_VwZY7oy--D",
"vertex" : "eve"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7ou--_",
"name" : "Alice"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_VwZY7oy--_",
"name" : "Eve"
}
]
},
{
"edges" : [
{
"_key" : "12834",
"_id" : "knows/12834",
"_from" : "persons/eve",
"_to" : "persons/alice",
"_rev" : "_VwZY7oy--D",
"vertex" : "eve"
},
{
"_key" : "12837",
"_id" : "knows/12837",
"_from" : "persons/eve",
"_to" : "persons/bob",
"_rev" : "_VwZY7oy--E",
"vertex" : "eve"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7ou--_",
"name" : "Alice"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_VwZY7oy--_",
"name" : "Eve"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY7ou--A",
"name" : "Bob"
}
]
},
{
"edges" : [
{
"_key" : "12834",
"_id" : "knows/12834",
"_from" : "persons/eve",
"_to" : "persons/alice",
"_rev" : "_VwZY7oy--D",
"vertex" : "eve"
},
{
"_key" : "12837",
"_id" : "knows/12837",
"_from" : "persons/eve",
"_to" : "persons/bob",
"_rev" : "_VwZY7oy--E",
"vertex" : "eve"
},
{
"_key" : "12824",
"_id" : "knows/12824",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_VwZY7oy--A",
"vertex" : "alice"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7ou--_",
"name" : "Alice"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_VwZY7oy--_",
"name" : "Eve"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY7ou--A",
"name" : "Bob"
},
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7ou--_",
"name" : "Alice"
}
]
},
{
"edges" : [
{
"_key" : "12834",
"_id" : "knows/12834",
"_from" : "persons/eve",
"_to" : "persons/alice",
"_rev" : "_VwZY7oy--D",
"vertex" : "eve"
},
{
"_key" : "12837",
"_id" : "knows/12837",
"_from" : "persons/eve",
"_to" : "persons/bob",
"_rev" : "_VwZY7oy--E",
"vertex" : "eve"
},
{
"_key" : "12831",
"_id" : "knows/12831",
"_from" : "persons/bob",
"_to" : "persons/dave",
"_rev" : "_VwZY7oy--C",
"vertex" : "bob"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7ou--_",
"name" : "Alice"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_VwZY7oy--_",
"name" : "Eve"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY7ou--A",
"name" : "Bob"
},
{
"_key" : "dave",
"_id" : "persons/dave",
"_rev" : "_VwZY7oy---",
"name" : "Dave"
}
]
},
{
"edges" : [
{
"_key" : "12834",
"_id" : "knows/12834",
"_from" : "persons/eve",
"_to" : "persons/alice",
"_rev" : "_VwZY7oy--D",
"vertex" : "eve"
},
{
"_key" : "12837",
"_id" : "knows/12837",
"_from" : "persons/eve",
"_to" : "persons/bob",
"_rev" : "_VwZY7oy--E",
"vertex" : "eve"
},
{
"_key" : "12828",
"_id" : "knows/12828",
"_from" : "persons/bob",
"_to" : "persons/charlie",
"_rev" : "_VwZY7oy--B",
"vertex" : "bob"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7ou--_",
"name" : "Alice"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_VwZY7oy--_",
"name" : "Eve"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY7ou--A",
"name" : "Bob"
},
{
"_key" : "charlie",
"_id" : "persons/charlie",
"_rev" : "_VwZY7ou--B",
"name" : "Charlie"
}
]
},
{
"edges" : [
{
"_key" : "12824",
"_id" : "knows/12824",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_VwZY7oy--A",
"vertex" : "alice"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7ou--_",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY7ou--A",
"name" : "Bob"
}
]
},
{
"edges" : [
{
"_key" : "12824",
"_id" : "knows/12824",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_VwZY7oy--A",
"vertex" : "alice"
},
{
"_key" : "12837",
"_id" : "knows/12837",
"_from" : "persons/eve",
"_to" : "persons/bob",
"_rev" : "_VwZY7oy--E",
"vertex" : "eve"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7ou--_",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY7ou--A",
"name" : "Bob"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_VwZY7oy--_",
"name" : "Eve"
}
]
},
{
"edges" : [
{
"_key" : "12824",
"_id" : "knows/12824",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_VwZY7oy--A",
"vertex" : "alice"
},
{
"_key" : "12837",
"_id" : "knows/12837",
"_from" : "persons/eve",
"_to" : "persons/bob",
"_rev" : "_VwZY7oy--E",
"vertex" : "eve"
},
{
"_key" : "12834",
"_id" : "knows/12834",
"_from" : "persons/eve",
"_to" : "persons/alice",
"_rev" : "_VwZY7oy--D",
"vertex" : "eve"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7ou--_",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY7ou--A",
"name" : "Bob"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_VwZY7oy--_",
"name" : "Eve"
},
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7ou--_",
"name" : "Alice"
}
]
},
{
"edges" : [
{
"_key" : "12824",
"_id" : "knows/12824",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_VwZY7oy--A",
"vertex" : "alice"
},
{
"_key" : "12831",
"_id" : "knows/12831",
"_from" : "persons/bob",
"_to" : "persons/dave",
"_rev" : "_VwZY7oy--C",
"vertex" : "bob"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7ou--_",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY7ou--A",
"name" : "Bob"
},
{
"_key" : "dave",
"_id" : "persons/dave",
"_rev" : "_VwZY7oy---",
"name" : "Dave"
}
]
},
{
"edges" : [
{
"_key" : "12824",
"_id" : "knows/12824",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_VwZY7oy--A",
"vertex" : "alice"
},
{
"_key" : "12828",
"_id" : "knows/12828",
"_from" : "persons/bob",
"_to" : "persons/charlie",
"_rev" : "_VwZY7oy--B",
"vertex" : "bob"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7ou--_",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY7ou--A",
"name" : "Bob"
},
{
"_key" : "charlie",
"_id" : "persons/charlie",
"_rev" : "_VwZY7ou--B",
"name" : "Charlie"
}
]
}
]
}
},
"error" : false,
"code" : 200
}
Example:
Edges should only be included once globally, but nodes are included every time they are visited
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF
{
"startVertex" : "persons/alice",
"graphName" : "knows_graph",
"direction" : "any",
"uniqueness" : {
"vertices" : "none",
"edges" : "global"
}
}
EOF
HTTP/1.1 200 OK
content-type: application/json; charset=utf-8
x-content-type-options: nosniff
{
"result" : {
"visited" : {
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7yu---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY7yu--_",
"name" : "Bob"
},
{
"_key" : "charlie",
"_id" : "persons/charlie",
"_rev" : "_VwZY7yu--A",
"name" : "Charlie"
},
{
"_key" : "dave",
"_id" : "persons/dave",
"_rev" : "_VwZY7yu--B",
"name" : "Dave"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_VwZY7yu--C",
"name" : "Eve"
},
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7yu---",
"name" : "Alice"
}
],
"paths" : [
{
"edges" : [ ],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7yu---",
"name" : "Alice"
}
]
},
{
"edges" : [
{
"_key" : "13032",
"_id" : "knows/13032",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_VwZY7yu--D",
"vertex" : "alice"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7yu---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY7yu--_",
"name" : "Bob"
}
]
},
{
"edges" : [
{
"_key" : "13032",
"_id" : "knows/13032",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_VwZY7yu--D",
"vertex" : "alice"
},
{
"_key" : "13036",
"_id" : "knows/13036",
"_from" : "persons/bob",
"_to" : "persons/charlie",
"_rev" : "_VwZY7yu--E",
"vertex" : "bob"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7yu---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY7yu--_",
"name" : "Bob"
},
{
"_key" : "charlie",
"_id" : "persons/charlie",
"_rev" : "_VwZY7yu--A",
"name" : "Charlie"
}
]
},
{
"edges" : [
{
"_key" : "13032",
"_id" : "knows/13032",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_VwZY7yu--D",
"vertex" : "alice"
},
{
"_key" : "13039",
"_id" : "knows/13039",
"_from" : "persons/bob",
"_to" : "persons/dave",
"_rev" : "_VwZY7yu--F",
"vertex" : "bob"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7yu---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY7yu--_",
"name" : "Bob"
},
{
"_key" : "dave",
"_id" : "persons/dave",
"_rev" : "_VwZY7yu--B",
"name" : "Dave"
}
]
},
{
"edges" : [
{
"_key" : "13032",
"_id" : "knows/13032",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_VwZY7yu--D",
"vertex" : "alice"
},
{
"_key" : "13045",
"_id" : "knows/13045",
"_from" : "persons/eve",
"_to" : "persons/bob",
"_rev" : "_VwZY7yy--_",
"vertex" : "eve"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7yu---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY7yu--_",
"name" : "Bob"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_VwZY7yu--C",
"name" : "Eve"
}
]
},
{
"edges" : [
{
"_key" : "13032",
"_id" : "knows/13032",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_VwZY7yu--D",
"vertex" : "alice"
},
{
"_key" : "13045",
"_id" : "knows/13045",
"_from" : "persons/eve",
"_to" : "persons/bob",
"_rev" : "_VwZY7yy--_",
"vertex" : "eve"
},
{
"_key" : "13042",
"_id" : "knows/13042",
"_from" : "persons/eve",
"_to" : "persons/alice",
"_rev" : "_VwZY7yy---",
"vertex" : "eve"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7yu---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY7yu--_",
"name" : "Bob"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_VwZY7yu--C",
"name" : "Eve"
},
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7yu---",
"name" : "Alice"
}
]
}
]
}
},
"error" : false,
"code" : 200
}
Example:
If the underlying graph is cyclic, maxIterations should be set
The underlying graph has two vertices Alice and Bob. With the directed edges:
- Alice knows Bob
- Bob knows Alice
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF
{
"startVertex" : "persons/alice",
"graphName" : "knows_graph",
"direction" : "any",
"uniqueness" : {
"vertices" : "none",
"edges" : "none"
},
"maxIterations" : 5
}
EOF
HTTP/1.1 500 Internal Server Error
content-type: application/json; charset=utf-8
x-content-type-options: nosniff
{
"error" : true,
"code" : 500,
"errorNum" : 1909,
"errorMessage" : "too many iterations - try increasing the value of 'maxIterations'"
}
Return Codes
- 200: If the traversal is fully executed HTTP 200 will be returned.
- 400: If the traversal specification is either missing or malformed, the server will respond with HTTP 400.
- 404: The server will responded with HTTP 404 if the specified edge collection does not exist, or the specified start vertex cannot be found.
- 500: The server will responded with HTTP 500 when an error occurs inside the traversal or if a traversal performs more than maxIterations iterations.
Examples
In the following examples the underlying graph will contain five persons Alice, Bob, Charlie, Dave and Eve. We will have the following directed relations:
- Alice knows Bob
- Bob knows Charlie
- Bob knows Dave
- Eve knows Alice
- Eve knows Bob The starting vertex will always be Alice. Follow only outbound edges
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF
{
"startVertex" : "persons/alice",
"graphName" : "knows_graph",
"direction" : "outbound"
}
EOF
HTTP/1.1 200 OK
content-type: application/json; charset=utf-8
x-content-type-options: nosniff
{
"result" : {
"visited" : {
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY8V2--_",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY8V2--A",
"name" : "Bob"
},
{
"_key" : "charlie",
"_id" : "persons/charlie",
"_rev" : "_VwZY8V2--B",
"name" : "Charlie"
},
{
"_key" : "dave",
"_id" : "persons/dave",
"_rev" : "_VwZY8V2--C",
"name" : "Dave"
}
],
"paths" : [
{
"edges" : [ ],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY8V2--_",
"name" : "Alice"
}
]
},
{
"edges" : [
{
"_key" : "13603",
"_id" : "knows/13603",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_VwZY8V6--_",
"vertex" : "alice"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY8V2--_",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY8V2--A",
"name" : "Bob"
}
]
},
{
"edges" : [
{
"_key" : "13603",
"_id" : "knows/13603",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_VwZY8V6--_",
"vertex" : "alice"
},
{
"_key" : "13607",
"_id" : "knows/13607",
"_from" : "persons/bob",
"_to" : "persons/charlie",
"_rev" : "_VwZY8V6--A",
"vertex" : "bob"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY8V2--_",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY8V2--A",
"name" : "Bob"
},
{
"_key" : "charlie",
"_id" : "persons/charlie",
"_rev" : "_VwZY8V2--B",
"name" : "Charlie"
}
]
},
{
"edges" : [
{
"_key" : "13603",
"_id" : "knows/13603",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_VwZY8V6--_",
"vertex" : "alice"
},
{
"_key" : "13610",
"_id" : "knows/13610",
"_from" : "persons/bob",
"_to" : "persons/dave",
"_rev" : "_VwZY8V6--B",
"vertex" : "bob"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY8V2--_",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY8V2--A",
"name" : "Bob"
},
{
"_key" : "dave",
"_id" : "persons/dave",
"_rev" : "_VwZY8V2--C",
"name" : "Dave"
}
]
}
]
}
},
"error" : false,
"code" : 200
}
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF
{
"startVertex" : "persons/alice",
"graphName" : "knows_graph",
"direction" : "outbound"
}
EOF
HTTP/1.1 200 OK
content-type: application/json; charset=utf-8
x-content-type-options: nosniff
Follow only inbound edges
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF
{
"startVertex" : "persons/alice",
"graphName" : "knows_graph",
"direction" : "inbound"
}
EOF
HTTP/1.1 200 OK
content-type: application/json; charset=utf-8
x-content-type-options: nosniff
{
"result" : {
"visited" : {
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY8Am---",
"name" : "Alice"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_VwZY8Am--C",
"name" : "Eve"
}
],
"paths" : [
{
"edges" : [ ],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY8Am---",
"name" : "Alice"
}
]
},
{
"edges" : [
{
"_key" : "13282",
"_id" : "knows/13282",
"_from" : "persons/eve",
"_to" : "persons/alice",
"_rev" : "_VwZY8Am--G",
"vertex" : "eve"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY8Am---",
"name" : "Alice"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_VwZY8Am--C",
"name" : "Eve"
}
]
}
]
}
},
"error" : false,
"code" : 200
}
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF
{
"startVertex" : "persons/alice",
"graphName" : "knows_graph",
"direction" : "inbound"
}
EOF
HTTP/1.1 200 OK
content-type: application/json; charset=utf-8
x-content-type-options: nosniff
Follow any direction of edges
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF
{
"startVertex" : "persons/alice",
"graphName" : "knows_graph",
"direction" : "any",
"uniqueness" : {
"vertices" : "none",
"edges" : "global"
}
}
EOF
HTTP/1.1 200 OK
content-type: application/json; charset=utf-8
x-content-type-options: nosniff
{
"result" : {
"visited" : {
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7kq--_",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY7kq--A",
"name" : "Bob"
},
{
"_key" : "charlie",
"_id" : "persons/charlie",
"_rev" : "_VwZY7ku---",
"name" : "Charlie"
},
{
"_key" : "dave",
"_id" : "persons/dave",
"_rev" : "_VwZY7ku--_",
"name" : "Dave"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_VwZY7ku--A",
"name" : "Eve"
},
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7kq--_",
"name" : "Alice"
}
],
"paths" : [
{
"edges" : [ ],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7kq--_",
"name" : "Alice"
}
]
},
{
"edges" : [
{
"_key" : "12735",
"_id" : "knows/12735",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_VwZY7ku--B",
"vertex" : "alice"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7kq--_",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY7kq--A",
"name" : "Bob"
}
]
},
{
"edges" : [
{
"_key" : "12735",
"_id" : "knows/12735",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_VwZY7ku--B",
"vertex" : "alice"
},
{
"_key" : "12739",
"_id" : "knows/12739",
"_from" : "persons/bob",
"_to" : "persons/charlie",
"_rev" : "_VwZY7ku--C",
"vertex" : "bob"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7kq--_",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY7kq--A",
"name" : "Bob"
},
{
"_key" : "charlie",
"_id" : "persons/charlie",
"_rev" : "_VwZY7ku---",
"name" : "Charlie"
}
]
},
{
"edges" : [
{
"_key" : "12735",
"_id" : "knows/12735",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_VwZY7ku--B",
"vertex" : "alice"
},
{
"_key" : "12742",
"_id" : "knows/12742",
"_from" : "persons/bob",
"_to" : "persons/dave",
"_rev" : "_VwZY7ku--D",
"vertex" : "bob"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7kq--_",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY7kq--A",
"name" : "Bob"
},
{
"_key" : "dave",
"_id" : "persons/dave",
"_rev" : "_VwZY7ku--_",
"name" : "Dave"
}
]
},
{
"edges" : [
{
"_key" : "12735",
"_id" : "knows/12735",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_VwZY7ku--B",
"vertex" : "alice"
},
{
"_key" : "12748",
"_id" : "knows/12748",
"_from" : "persons/eve",
"_to" : "persons/bob",
"_rev" : "_VwZY7ky--_",
"vertex" : "eve"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7kq--_",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY7kq--A",
"name" : "Bob"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_VwZY7ku--A",
"name" : "Eve"
}
]
},
{
"edges" : [
{
"_key" : "12735",
"_id" : "knows/12735",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_VwZY7ku--B",
"vertex" : "alice"
},
{
"_key" : "12748",
"_id" : "knows/12748",
"_from" : "persons/eve",
"_to" : "persons/bob",
"_rev" : "_VwZY7ky--_",
"vertex" : "eve"
},
{
"_key" : "12745",
"_id" : "knows/12745",
"_from" : "persons/eve",
"_to" : "persons/alice",
"_rev" : "_VwZY7ky---",
"vertex" : "eve"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7kq--_",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY7kq--A",
"name" : "Bob"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_VwZY7ku--A",
"name" : "Eve"
},
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7kq--_",
"name" : "Alice"
}
]
}
]
}
},
"error" : false,
"code" : 200
}
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF
{
"startVertex" : "persons/alice",
"graphName" : "knows_graph",
"direction" : "any",
"uniqueness" : {
"vertices" : "none",
"edges" : "global"
}
}
EOF
HTTP/1.1 200 OK
content-type: application/json; charset=utf-8
x-content-type-options: nosniff
Excluding Charlie and Bob
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF
{
"startVertex" : "persons/alice",
"graphName" : "knows_graph",
"direction" : "outbound",
"filter" : "if (vertex.name === \"Bob\" || vertex.name === \"Charlie\") { return \"exclude\";}return;"
}
EOF
HTTP/1.1 200 OK
content-type: application/json; charset=utf-8
x-content-type-options: nosniff
{
"result" : {
"visited" : {
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY73C--_",
"name" : "Alice"
},
{
"_key" : "dave",
"_id" : "persons/dave",
"_rev" : "_VwZY73C--C",
"name" : "Dave"
}
],
"paths" : [
{
"edges" : [ ],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY73C--_",
"name" : "Alice"
}
]
},
{
"edges" : [
{
"_key" : "13121",
"_id" : "knows/13121",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_VwZY73G--_",
"vertex" : "alice"
},
{
"_key" : "13128",
"_id" : "knows/13128",
"_from" : "persons/bob",
"_to" : "persons/dave",
"_rev" : "_VwZY73G--B",
"vertex" : "bob"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY73C--_",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY73C--A",
"name" : "Bob"
},
{
"_key" : "dave",
"_id" : "persons/dave",
"_rev" : "_VwZY73C--C",
"name" : "Dave"
}
]
}
]
}
},
"error" : false,
"code" : 200
}
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF
{
"startVertex" : "persons/alice",
"graphName" : "knows_graph",
"direction" : "outbound",
"filter" : "if (vertex.name === \"Bob\" || vertex.name === \"Charlie\") { return \"exclude\";}return;"
}
EOF
HTTP/1.1 200 OK
content-type: application/json; charset=utf-8
x-content-type-options: nosniff
Do not follow edges from Bob
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF
{
"startVertex" : "persons/alice",
"graphName" : "knows_graph",
"direction" : "outbound",
"filter" : "if (vertex.name === \"Bob\") {return \"prune\";}return;"
}
EOF
HTTP/1.1 200 OK
content-type: application/json; charset=utf-8
x-content-type-options: nosniff
{
"result" : {
"visited" : {
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY78a---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY78a--_",
"name" : "Bob"
}
],
"paths" : [
{
"edges" : [ ],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY78a---",
"name" : "Alice"
}
]
},
{
"edges" : [
{
"_key" : "13199",
"_id" : "knows/13199",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_VwZY78a--D",
"vertex" : "alice"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY78a---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY78a--_",
"name" : "Bob"
}
]
}
]
}
},
"error" : false,
"code" : 200
}
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF
{
"startVertex" : "persons/alice",
"graphName" : "knows_graph",
"direction" : "outbound",
"filter" : "if (vertex.name === \"Bob\") {return \"prune\";}return;"
}
EOF
HTTP/1.1 200 OK
content-type: application/json; charset=utf-8
x-content-type-options: nosniff
Visit only nodes in a depth of at least 2
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF
{
"startVertex" : "persons/alice",
"graphName" : "knows_graph",
"direction" : "outbound",
"minDepth" : 2
}
EOF
HTTP/1.1 200 OK
content-type: application/json; charset=utf-8
x-content-type-options: nosniff
{
"result" : {
"visited" : {
"vertices" : [
{
"_key" : "charlie",
"_id" : "persons/charlie",
"_rev" : "_VwZY8Rm---",
"name" : "Charlie"
},
{
"_key" : "dave",
"_id" : "persons/dave",
"_rev" : "_VwZY8Rm--_",
"name" : "Dave"
}
],
"paths" : [
{
"edges" : [
{
"_key" : "13525",
"_id" : "knows/13525",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_VwZY8Rm--B",
"vertex" : "alice"
},
{
"_key" : "13529",
"_id" : "knows/13529",
"_from" : "persons/bob",
"_to" : "persons/charlie",
"_rev" : "_VwZY8Rm--C",
"vertex" : "bob"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY8Ri--_",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY8Ri--A",
"name" : "Bob"
},
{
"_key" : "charlie",
"_id" : "persons/charlie",
"_rev" : "_VwZY8Rm---",
"name" : "Charlie"
}
]
},
{
"edges" : [
{
"_key" : "13525",
"_id" : "knows/13525",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_VwZY8Rm--B",
"vertex" : "alice"
},
{
"_key" : "13532",
"_id" : "knows/13532",
"_from" : "persons/bob",
"_to" : "persons/dave",
"_rev" : "_VwZY8Rm--D",
"vertex" : "bob"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY8Ri--_",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY8Ri--A",
"name" : "Bob"
},
{
"_key" : "dave",
"_id" : "persons/dave",
"_rev" : "_VwZY8Rm--_",
"name" : "Dave"
}
]
}
]
}
},
"error" : false,
"code" : 200
}
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF
{
"startVertex" : "persons/alice",
"graphName" : "knows_graph",
"direction" : "outbound",
"minDepth" : 2
}
EOF
HTTP/1.1 200 OK
content-type: application/json; charset=utf-8
x-content-type-options: nosniff
Visit only nodes in a depth of at most 1
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF
{
"startVertex" : "persons/alice",
"graphName" : "knows_graph",
"direction" : "outbound",
"maxDepth" : 1
}
EOF
HTTP/1.1 200 OK
content-type: application/json; charset=utf-8
x-content-type-options: nosniff
{
"result" : {
"visited" : {
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY8H---_",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY8H---A",
"name" : "Bob"
}
],
"paths" : [
{
"edges" : [ ],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY8H---_",
"name" : "Alice"
}
]
},
{
"edges" : [
{
"_key" : "13346",
"_id" : "knows/13346",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_VwZY8HC--A",
"vertex" : "alice"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY8H---_",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY8H---A",
"name" : "Bob"
}
]
}
]
}
},
"error" : false,
"code" : 200
}
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF
{
"startVertex" : "persons/alice",
"graphName" : "knows_graph",
"direction" : "outbound",
"maxDepth" : 1
}
EOF
HTTP/1.1 200 OK
content-type: application/json; charset=utf-8
x-content-type-options: nosniff
Using a visitor function to return vertex ids only
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF
{
"startVertex" : "persons/alice",
"graphName" : "knows_graph",
"direction" : "outbound",
"visitor" : "result.visited.vertices.push(vertex._id);"
}
EOF
HTTP/1.1 200 OK
content-type: application/json; charset=utf-8
x-content-type-options: nosniff
{
"result" : {
"visited" : {
"vertices" : [
"persons/alice",
"persons/bob",
"persons/charlie",
"persons/dave"
],
"paths" : [ ]
}
},
"error" : false,
"code" : 200
}
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF
{
"startVertex" : "persons/alice",
"graphName" : "knows_graph",
"direction" : "outbound",
"visitor" : "result.visited.vertices.push(vertex._id);"
}
EOF
HTTP/1.1 200 OK
content-type: application/json; charset=utf-8
x-content-type-options: nosniff
Count all visited nodes and return a list of nodes only
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF
{
"startVertex" : "persons/alice",
"graphName" : "knows_graph",
"direction" : "outbound",
"init" : "result.visited = 0; result.myVertices = [ ];",
"visitor" : "result.visited++; result.myVertices.push(vertex);"
}
EOF
HTTP/1.1 200 OK
content-type: application/json; charset=utf-8
x-content-type-options: nosniff
{
"result" : {
"visited" : 4,
"myVertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY8ge---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY8ge--_",
"name" : "Bob"
},
{
"_key" : "charlie",
"_id" : "persons/charlie",
"_rev" : "_VwZY8ge--A",
"name" : "Charlie"
},
{
"_key" : "dave",
"_id" : "persons/dave",
"_rev" : "_VwZY8ge--B",
"name" : "Dave"
}
]
},
"error" : false,
"code" : 200
}
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF
{
"startVertex" : "persons/alice",
"graphName" : "knows_graph",
"direction" : "outbound",
"init" : "result.visited = 0; result.myVertices = [ ];",
"visitor" : "result.visited++; result.myVertices.push(vertex);"
}
EOF
HTTP/1.1 200 OK
content-type: application/json; charset=utf-8
x-content-type-options: nosniff
Expand only inbound edges of Alice and outbound edges of Eve
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF
{
"startVertex" : "persons/alice",
"graphName" : "knows_graph",
"expander" : "var connections = [ ];if (vertex.name === \"Alice\") {config.datasource.getInEdges(vertex).forEach(function (e) {connections.push({ vertex: require(\"internal\").db._document(e._from), edge: e});});}if (vertex.name === \"Eve\") {config.datasource.getOutEdges(vertex).forEach(function (e) {connections.push({vertex: require(\"internal\").db._document(e._to), edge: e});});}return connections;"
}
EOF
HTTP/1.1 200 OK
content-type: application/json; charset=utf-8
x-content-type-options: nosniff
{
"result" : {
"visited" : {
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY8ka---",
"name" : "Alice"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_VwZY8ka--C",
"name" : "Eve"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY8ka--_",
"name" : "Bob"
}
],
"paths" : [
{
"edges" : [ ],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY8ka---",
"name" : "Alice"
}
]
},
{
"edges" : [
{
"_key" : "13873",
"_id" : "knows/13873",
"_from" : "persons/eve",
"_to" : "persons/alice",
"_rev" : "_VwZY8ke--_",
"vertex" : "eve"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY8ka---",
"name" : "Alice"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_VwZY8ka--C",
"name" : "Eve"
}
]
},
{
"edges" : [
{
"_key" : "13873",
"_id" : "knows/13873",
"_from" : "persons/eve",
"_to" : "persons/alice",
"_rev" : "_VwZY8ke--_",
"vertex" : "eve"
},
{
"_key" : "13876",
"_id" : "knows/13876",
"_from" : "persons/eve",
"_to" : "persons/bob",
"_rev" : "_VwZY8ke--A",
"vertex" : "eve"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY8ka---",
"name" : "Alice"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_VwZY8ka--C",
"name" : "Eve"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY8ka--_",
"name" : "Bob"
}
]
}
]
}
},
"error" : false,
"code" : 200
}
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF
{
"startVertex" : "persons/alice",
"graphName" : "knows_graph",
"expander" : "var connections = [ ];if (vertex.name === \"Alice\") {config.datasource.getInEdges(vertex).forEach(function (e) {connections.push({ vertex: require(\"internal\").db._document(e._from), edge: e});});}if (vertex.name === \"Eve\") {config.datasource.getOutEdges(vertex).forEach(function (e) {connections.push({vertex: require(\"internal\").db._document(e._to), edge: e});});}return connections;"
}
EOF
HTTP/1.1 200 OK
content-type: application/json; charset=utf-8
x-content-type-options: nosniff
Follow the depthfirst strategy
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF
{
"startVertex" : "persons/alice",
"graphName" : "knows_graph",
"direction" : "any",
"strategy" : "depthfirst"
}
EOF
HTTP/1.1 200 OK
content-type: application/json; charset=utf-8
x-content-type-options: nosniff
{
"result" : {
"visited" : {
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7u---_",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY7uC---",
"name" : "Bob"
},
{
"_key" : "charlie",
"_id" : "persons/charlie",
"_rev" : "_VwZY7uC--_",
"name" : "Charlie"
},
{
"_key" : "dave",
"_id" : "persons/dave",
"_rev" : "_VwZY7uC--A",
"name" : "Dave"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_VwZY7uC--B",
"name" : "Eve"
},
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7u---_",
"name" : "Alice"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_VwZY7uC--B",
"name" : "Eve"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY7uC---",
"name" : "Bob"
},
{
"_key" : "charlie",
"_id" : "persons/charlie",
"_rev" : "_VwZY7uC--_",
"name" : "Charlie"
},
{
"_key" : "dave",
"_id" : "persons/dave",
"_rev" : "_VwZY7uC--A",
"name" : "Dave"
},
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7u---_",
"name" : "Alice"
}
],
"paths" : [
{
"edges" : [ ],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7u---_",
"name" : "Alice"
}
]
},
{
"edges" : [
{
"_key" : "12928",
"_id" : "knows/12928",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_VwZY7uC--C",
"vertex" : "alice"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7u---_",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY7uC---",
"name" : "Bob"
}
]
},
{
"edges" : [
{
"_key" : "12928",
"_id" : "knows/12928",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_VwZY7uC--C",
"vertex" : "alice"
},
{
"_key" : "12932",
"_id" : "knows/12932",
"_from" : "persons/bob",
"_to" : "persons/charlie",
"_rev" : "_VwZY7uC--D",
"vertex" : "bob"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7u---_",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY7uC---",
"name" : "Bob"
},
{
"_key" : "charlie",
"_id" : "persons/charlie",
"_rev" : "_VwZY7uC--_",
"name" : "Charlie"
}
]
},
{
"edges" : [
{
"_key" : "12928",
"_id" : "knows/12928",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_VwZY7uC--C",
"vertex" : "alice"
},
{
"_key" : "12935",
"_id" : "knows/12935",
"_from" : "persons/bob",
"_to" : "persons/dave",
"_rev" : "_VwZY7uC--E",
"vertex" : "bob"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7u---_",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY7uC---",
"name" : "Bob"
},
{
"_key" : "dave",
"_id" : "persons/dave",
"_rev" : "_VwZY7uC--A",
"name" : "Dave"
}
]
},
{
"edges" : [
{
"_key" : "12928",
"_id" : "knows/12928",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_VwZY7uC--C",
"vertex" : "alice"
},
{
"_key" : "12941",
"_id" : "knows/12941",
"_from" : "persons/eve",
"_to" : "persons/bob",
"_rev" : "_VwZY7uG--_",
"vertex" : "eve"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7u---_",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY7uC---",
"name" : "Bob"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_VwZY7uC--B",
"name" : "Eve"
}
]
},
{
"edges" : [
{
"_key" : "12928",
"_id" : "knows/12928",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_VwZY7uC--C",
"vertex" : "alice"
},
{
"_key" : "12941",
"_id" : "knows/12941",
"_from" : "persons/eve",
"_to" : "persons/bob",
"_rev" : "_VwZY7uG--_",
"vertex" : "eve"
},
{
"_key" : "12938",
"_id" : "knows/12938",
"_from" : "persons/eve",
"_to" : "persons/alice",
"_rev" : "_VwZY7uG---",
"vertex" : "eve"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7u---_",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY7uC---",
"name" : "Bob"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_VwZY7uC--B",
"name" : "Eve"
},
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7u---_",
"name" : "Alice"
}
]
},
{
"edges" : [
{
"_key" : "12938",
"_id" : "knows/12938",
"_from" : "persons/eve",
"_to" : "persons/alice",
"_rev" : "_VwZY7uG---",
"vertex" : "eve"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7u---_",
"name" : "Alice"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_VwZY7uC--B",
"name" : "Eve"
}
]
},
{
"edges" : [
{
"_key" : "12938",
"_id" : "knows/12938",
"_from" : "persons/eve",
"_to" : "persons/alice",
"_rev" : "_VwZY7uG---",
"vertex" : "eve"
},
{
"_key" : "12941",
"_id" : "knows/12941",
"_from" : "persons/eve",
"_to" : "persons/bob",
"_rev" : "_VwZY7uG--_",
"vertex" : "eve"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7u---_",
"name" : "Alice"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_VwZY7uC--B",
"name" : "Eve"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY7uC---",
"name" : "Bob"
}
]
},
{
"edges" : [
{
"_key" : "12938",
"_id" : "knows/12938",
"_from" : "persons/eve",
"_to" : "persons/alice",
"_rev" : "_VwZY7uG---",
"vertex" : "eve"
},
{
"_key" : "12941",
"_id" : "knows/12941",
"_from" : "persons/eve",
"_to" : "persons/bob",
"_rev" : "_VwZY7uG--_",
"vertex" : "eve"
},
{
"_key" : "12932",
"_id" : "knows/12932",
"_from" : "persons/bob",
"_to" : "persons/charlie",
"_rev" : "_VwZY7uC--D",
"vertex" : "bob"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7u---_",
"name" : "Alice"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_VwZY7uC--B",
"name" : "Eve"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY7uC---",
"name" : "Bob"
},
{
"_key" : "charlie",
"_id" : "persons/charlie",
"_rev" : "_VwZY7uC--_",
"name" : "Charlie"
}
]
},
{
"edges" : [
{
"_key" : "12938",
"_id" : "knows/12938",
"_from" : "persons/eve",
"_to" : "persons/alice",
"_rev" : "_VwZY7uG---",
"vertex" : "eve"
},
{
"_key" : "12941",
"_id" : "knows/12941",
"_from" : "persons/eve",
"_to" : "persons/bob",
"_rev" : "_VwZY7uG--_",
"vertex" : "eve"
},
{
"_key" : "12935",
"_id" : "knows/12935",
"_from" : "persons/bob",
"_to" : "persons/dave",
"_rev" : "_VwZY7uC--E",
"vertex" : "bob"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7u---_",
"name" : "Alice"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_VwZY7uC--B",
"name" : "Eve"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY7uC---",
"name" : "Bob"
},
{
"_key" : "dave",
"_id" : "persons/dave",
"_rev" : "_VwZY7uC--A",
"name" : "Dave"
}
]
},
{
"edges" : [
{
"_key" : "12938",
"_id" : "knows/12938",
"_from" : "persons/eve",
"_to" : "persons/alice",
"_rev" : "_VwZY7uG---",
"vertex" : "eve"
},
{
"_key" : "12941",
"_id" : "knows/12941",
"_from" : "persons/eve",
"_to" : "persons/bob",
"_rev" : "_VwZY7uG--_",
"vertex" : "eve"
},
{
"_key" : "12928",
"_id" : "knows/12928",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_VwZY7uC--C",
"vertex" : "alice"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7u---_",
"name" : "Alice"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_VwZY7uC--B",
"name" : "Eve"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY7uC---",
"name" : "Bob"
},
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7u---_",
"name" : "Alice"
}
]
}
]
}
},
"error" : false,
"code" : 200
}
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF
{
"startVertex" : "persons/alice",
"graphName" : "knows_graph",
"direction" : "any",
"strategy" : "depthfirst"
}
EOF
HTTP/1.1 200 OK
content-type: application/json; charset=utf-8
x-content-type-options: nosniff
Using postorder ordering
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF
{
"startVertex" : "persons/alice",
"graphName" : "knows_graph",
"direction" : "any",
"order" : "postorder"
}
EOF
HTTP/1.1 200 OK
content-type: application/json; charset=utf-8
x-content-type-options: nosniff
{
"result" : {
"visited" : {
"vertices" : [
{
"_key" : "charlie",
"_id" : "persons/charlie",
"_rev" : "_VwZY8au--A",
"name" : "Charlie"
},
{
"_key" : "dave",
"_id" : "persons/dave",
"_rev" : "_VwZY8au--B",
"name" : "Dave"
},
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY8au---",
"name" : "Alice"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_VwZY8au--C",
"name" : "Eve"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY8au--_",
"name" : "Bob"
},
{
"_key" : "charlie",
"_id" : "persons/charlie",
"_rev" : "_VwZY8au--A",
"name" : "Charlie"
},
{
"_key" : "dave",
"_id" : "persons/dave",
"_rev" : "_VwZY8au--B",
"name" : "Dave"
},
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY8au---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY8au--_",
"name" : "Bob"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_VwZY8au--C",
"name" : "Eve"
},
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY8au---",
"name" : "Alice"
}
],
"paths" : [
{
"edges" : [
{
"_key" : "13681",
"_id" : "knows/13681",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_VwZY8au--D",
"vertex" : "alice"
},
{
"_key" : "13685",
"_id" : "knows/13685",
"_from" : "persons/bob",
"_to" : "persons/charlie",
"_rev" : "_VwZY8au--E",
"vertex" : "bob"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY8au---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY8au--_",
"name" : "Bob"
},
{
"_key" : "charlie",
"_id" : "persons/charlie",
"_rev" : "_VwZY8au--A",
"name" : "Charlie"
}
]
},
{
"edges" : [
{
"_key" : "13681",
"_id" : "knows/13681",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_VwZY8au--D",
"vertex" : "alice"
},
{
"_key" : "13688",
"_id" : "knows/13688",
"_from" : "persons/bob",
"_to" : "persons/dave",
"_rev" : "_VwZY8au--F",
"vertex" : "bob"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY8au---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY8au--_",
"name" : "Bob"
},
{
"_key" : "dave",
"_id" : "persons/dave",
"_rev" : "_VwZY8au--B",
"name" : "Dave"
}
]
},
{
"edges" : [
{
"_key" : "13681",
"_id" : "knows/13681",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_VwZY8au--D",
"vertex" : "alice"
},
{
"_key" : "13694",
"_id" : "knows/13694",
"_from" : "persons/eve",
"_to" : "persons/bob",
"_rev" : "_VwZY8au--H",
"vertex" : "eve"
},
{
"_key" : "13691",
"_id" : "knows/13691",
"_from" : "persons/eve",
"_to" : "persons/alice",
"_rev" : "_VwZY8au--G",
"vertex" : "eve"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY8au---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY8au--_",
"name" : "Bob"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_VwZY8au--C",
"name" : "Eve"
},
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY8au---",
"name" : "Alice"
}
]
},
{
"edges" : [
{
"_key" : "13681",
"_id" : "knows/13681",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_VwZY8au--D",
"vertex" : "alice"
},
{
"_key" : "13694",
"_id" : "knows/13694",
"_from" : "persons/eve",
"_to" : "persons/bob",
"_rev" : "_VwZY8au--H",
"vertex" : "eve"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY8au---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY8au--_",
"name" : "Bob"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_VwZY8au--C",
"name" : "Eve"
}
]
},
{
"edges" : [
{
"_key" : "13681",
"_id" : "knows/13681",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_VwZY8au--D",
"vertex" : "alice"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY8au---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY8au--_",
"name" : "Bob"
}
]
},
{
"edges" : [
{
"_key" : "13691",
"_id" : "knows/13691",
"_from" : "persons/eve",
"_to" : "persons/alice",
"_rev" : "_VwZY8au--G",
"vertex" : "eve"
},
{
"_key" : "13694",
"_id" : "knows/13694",
"_from" : "persons/eve",
"_to" : "persons/bob",
"_rev" : "_VwZY8au--H",
"vertex" : "eve"
},
{
"_key" : "13685",
"_id" : "knows/13685",
"_from" : "persons/bob",
"_to" : "persons/charlie",
"_rev" : "_VwZY8au--E",
"vertex" : "bob"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY8au---",
"name" : "Alice"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_VwZY8au--C",
"name" : "Eve"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY8au--_",
"name" : "Bob"
},
{
"_key" : "charlie",
"_id" : "persons/charlie",
"_rev" : "_VwZY8au--A",
"name" : "Charlie"
}
]
},
{
"edges" : [
{
"_key" : "13691",
"_id" : "knows/13691",
"_from" : "persons/eve",
"_to" : "persons/alice",
"_rev" : "_VwZY8au--G",
"vertex" : "eve"
},
{
"_key" : "13694",
"_id" : "knows/13694",
"_from" : "persons/eve",
"_to" : "persons/bob",
"_rev" : "_VwZY8au--H",
"vertex" : "eve"
},
{
"_key" : "13688",
"_id" : "knows/13688",
"_from" : "persons/bob",
"_to" : "persons/dave",
"_rev" : "_VwZY8au--F",
"vertex" : "bob"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY8au---",
"name" : "Alice"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_VwZY8au--C",
"name" : "Eve"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY8au--_",
"name" : "Bob"
},
{
"_key" : "dave",
"_id" : "persons/dave",
"_rev" : "_VwZY8au--B",
"name" : "Dave"
}
]
},
{
"edges" : [
{
"_key" : "13691",
"_id" : "knows/13691",
"_from" : "persons/eve",
"_to" : "persons/alice",
"_rev" : "_VwZY8au--G",
"vertex" : "eve"
},
{
"_key" : "13694",
"_id" : "knows/13694",
"_from" : "persons/eve",
"_to" : "persons/bob",
"_rev" : "_VwZY8au--H",
"vertex" : "eve"
},
{
"_key" : "13681",
"_id" : "knows/13681",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_VwZY8au--D",
"vertex" : "alice"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY8au---",
"name" : "Alice"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_VwZY8au--C",
"name" : "Eve"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY8au--_",
"name" : "Bob"
},
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY8au---",
"name" : "Alice"
}
]
},
{
"edges" : [
{
"_key" : "13691",
"_id" : "knows/13691",
"_from" : "persons/eve",
"_to" : "persons/alice",
"_rev" : "_VwZY8au--G",
"vertex" : "eve"
},
{
"_key" : "13694",
"_id" : "knows/13694",
"_from" : "persons/eve",
"_to" : "persons/bob",
"_rev" : "_VwZY8au--H",
"vertex" : "eve"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY8au---",
"name" : "Alice"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_VwZY8au--C",
"name" : "Eve"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY8au--_",
"name" : "Bob"
}
]
},
{
"edges" : [
{
"_key" : "13691",
"_id" : "knows/13691",
"_from" : "persons/eve",
"_to" : "persons/alice",
"_rev" : "_VwZY8au--G",
"vertex" : "eve"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY8au---",
"name" : "Alice"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_VwZY8au--C",
"name" : "Eve"
}
]
},
{
"edges" : [ ],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY8au---",
"name" : "Alice"
}
]
}
]
}
},
"error" : false,
"code" : 200
}
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF
{
"startVertex" : "persons/alice",
"graphName" : "knows_graph",
"direction" : "any",
"order" : "postorder"
}
EOF
HTTP/1.1 200 OK
content-type: application/json; charset=utf-8
x-content-type-options: nosniff
Using backward item-ordering:
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF
{
"startVertex" : "persons/alice",
"graphName" : "knows_graph",
"direction" : "any",
"itemOrder" : "backward"
}
EOF
HTTP/1.1 200 OK
content-type: application/json; charset=utf-8
x-content-type-options: nosniff
{
"result" : {
"visited" : {
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7ou--_",
"name" : "Alice"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_VwZY7oy--_",
"name" : "Eve"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY7ou--A",
"name" : "Bob"
},
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7ou--_",
"name" : "Alice"
},
{
"_key" : "dave",
"_id" : "persons/dave",
"_rev" : "_VwZY7oy---",
"name" : "Dave"
},
{
"_key" : "charlie",
"_id" : "persons/charlie",
"_rev" : "_VwZY7ou--B",
"name" : "Charlie"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY7ou--A",
"name" : "Bob"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_VwZY7oy--_",
"name" : "Eve"
},
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7ou--_",
"name" : "Alice"
},
{
"_key" : "dave",
"_id" : "persons/dave",
"_rev" : "_VwZY7oy---",
"name" : "Dave"
},
{
"_key" : "charlie",
"_id" : "persons/charlie",
"_rev" : "_VwZY7ou--B",
"name" : "Charlie"
}
],
"paths" : [
{
"edges" : [ ],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7ou--_",
"name" : "Alice"
}
]
},
{
"edges" : [
{
"_key" : "12834",
"_id" : "knows/12834",
"_from" : "persons/eve",
"_to" : "persons/alice",
"_rev" : "_VwZY7oy--D",
"vertex" : "eve"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7ou--_",
"name" : "Alice"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_VwZY7oy--_",
"name" : "Eve"
}
]
},
{
"edges" : [
{
"_key" : "12834",
"_id" : "knows/12834",
"_from" : "persons/eve",
"_to" : "persons/alice",
"_rev" : "_VwZY7oy--D",
"vertex" : "eve"
},
{
"_key" : "12837",
"_id" : "knows/12837",
"_from" : "persons/eve",
"_to" : "persons/bob",
"_rev" : "_VwZY7oy--E",
"vertex" : "eve"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7ou--_",
"name" : "Alice"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_VwZY7oy--_",
"name" : "Eve"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY7ou--A",
"name" : "Bob"
}
]
},
{
"edges" : [
{
"_key" : "12834",
"_id" : "knows/12834",
"_from" : "persons/eve",
"_to" : "persons/alice",
"_rev" : "_VwZY7oy--D",
"vertex" : "eve"
},
{
"_key" : "12837",
"_id" : "knows/12837",
"_from" : "persons/eve",
"_to" : "persons/bob",
"_rev" : "_VwZY7oy--E",
"vertex" : "eve"
},
{
"_key" : "12824",
"_id" : "knows/12824",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_VwZY7oy--A",
"vertex" : "alice"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7ou--_",
"name" : "Alice"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_VwZY7oy--_",
"name" : "Eve"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY7ou--A",
"name" : "Bob"
},
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7ou--_",
"name" : "Alice"
}
]
},
{
"edges" : [
{
"_key" : "12834",
"_id" : "knows/12834",
"_from" : "persons/eve",
"_to" : "persons/alice",
"_rev" : "_VwZY7oy--D",
"vertex" : "eve"
},
{
"_key" : "12837",
"_id" : "knows/12837",
"_from" : "persons/eve",
"_to" : "persons/bob",
"_rev" : "_VwZY7oy--E",
"vertex" : "eve"
},
{
"_key" : "12831",
"_id" : "knows/12831",
"_from" : "persons/bob",
"_to" : "persons/dave",
"_rev" : "_VwZY7oy--C",
"vertex" : "bob"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7ou--_",
"name" : "Alice"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_VwZY7oy--_",
"name" : "Eve"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY7ou--A",
"name" : "Bob"
},
{
"_key" : "dave",
"_id" : "persons/dave",
"_rev" : "_VwZY7oy---",
"name" : "Dave"
}
]
},
{
"edges" : [
{
"_key" : "12834",
"_id" : "knows/12834",
"_from" : "persons/eve",
"_to" : "persons/alice",
"_rev" : "_VwZY7oy--D",
"vertex" : "eve"
},
{
"_key" : "12837",
"_id" : "knows/12837",
"_from" : "persons/eve",
"_to" : "persons/bob",
"_rev" : "_VwZY7oy--E",
"vertex" : "eve"
},
{
"_key" : "12828",
"_id" : "knows/12828",
"_from" : "persons/bob",
"_to" : "persons/charlie",
"_rev" : "_VwZY7oy--B",
"vertex" : "bob"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7ou--_",
"name" : "Alice"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_VwZY7oy--_",
"name" : "Eve"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY7ou--A",
"name" : "Bob"
},
{
"_key" : "charlie",
"_id" : "persons/charlie",
"_rev" : "_VwZY7ou--B",
"name" : "Charlie"
}
]
},
{
"edges" : [
{
"_key" : "12824",
"_id" : "knows/12824",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_VwZY7oy--A",
"vertex" : "alice"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7ou--_",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY7ou--A",
"name" : "Bob"
}
]
},
{
"edges" : [
{
"_key" : "12824",
"_id" : "knows/12824",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_VwZY7oy--A",
"vertex" : "alice"
},
{
"_key" : "12837",
"_id" : "knows/12837",
"_from" : "persons/eve",
"_to" : "persons/bob",
"_rev" : "_VwZY7oy--E",
"vertex" : "eve"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7ou--_",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY7ou--A",
"name" : "Bob"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_VwZY7oy--_",
"name" : "Eve"
}
]
},
{
"edges" : [
{
"_key" : "12824",
"_id" : "knows/12824",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_VwZY7oy--A",
"vertex" : "alice"
},
{
"_key" : "12837",
"_id" : "knows/12837",
"_from" : "persons/eve",
"_to" : "persons/bob",
"_rev" : "_VwZY7oy--E",
"vertex" : "eve"
},
{
"_key" : "12834",
"_id" : "knows/12834",
"_from" : "persons/eve",
"_to" : "persons/alice",
"_rev" : "_VwZY7oy--D",
"vertex" : "eve"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7ou--_",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY7ou--A",
"name" : "Bob"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_VwZY7oy--_",
"name" : "Eve"
},
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7ou--_",
"name" : "Alice"
}
]
},
{
"edges" : [
{
"_key" : "12824",
"_id" : "knows/12824",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_VwZY7oy--A",
"vertex" : "alice"
},
{
"_key" : "12831",
"_id" : "knows/12831",
"_from" : "persons/bob",
"_to" : "persons/dave",
"_rev" : "_VwZY7oy--C",
"vertex" : "bob"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7ou--_",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY7ou--A",
"name" : "Bob"
},
{
"_key" : "dave",
"_id" : "persons/dave",
"_rev" : "_VwZY7oy---",
"name" : "Dave"
}
]
},
{
"edges" : [
{
"_key" : "12824",
"_id" : "knows/12824",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_VwZY7oy--A",
"vertex" : "alice"
},
{
"_key" : "12828",
"_id" : "knows/12828",
"_from" : "persons/bob",
"_to" : "persons/charlie",
"_rev" : "_VwZY7oy--B",
"vertex" : "bob"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7ou--_",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY7ou--A",
"name" : "Bob"
},
{
"_key" : "charlie",
"_id" : "persons/charlie",
"_rev" : "_VwZY7ou--B",
"name" : "Charlie"
}
]
}
]
}
},
"error" : false,
"code" : 200
}
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF
{
"startVertex" : "persons/alice",
"graphName" : "knows_graph",
"direction" : "any",
"itemOrder" : "backward"
}
EOF
HTTP/1.1 200 OK
content-type: application/json; charset=utf-8
x-content-type-options: nosniff
Edges should only be included once globally, but nodes are included every time they are visited
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF
{
"startVertex" : "persons/alice",
"graphName" : "knows_graph",
"direction" : "any",
"uniqueness" : {
"vertices" : "none",
"edges" : "global"
}
}
EOF
HTTP/1.1 200 OK
content-type: application/json; charset=utf-8
x-content-type-options: nosniff
{
"result" : {
"visited" : {
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7yu---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY7yu--_",
"name" : "Bob"
},
{
"_key" : "charlie",
"_id" : "persons/charlie",
"_rev" : "_VwZY7yu--A",
"name" : "Charlie"
},
{
"_key" : "dave",
"_id" : "persons/dave",
"_rev" : "_VwZY7yu--B",
"name" : "Dave"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_VwZY7yu--C",
"name" : "Eve"
},
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7yu---",
"name" : "Alice"
}
],
"paths" : [
{
"edges" : [ ],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7yu---",
"name" : "Alice"
}
]
},
{
"edges" : [
{
"_key" : "13032",
"_id" : "knows/13032",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_VwZY7yu--D",
"vertex" : "alice"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7yu---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY7yu--_",
"name" : "Bob"
}
]
},
{
"edges" : [
{
"_key" : "13032",
"_id" : "knows/13032",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_VwZY7yu--D",
"vertex" : "alice"
},
{
"_key" : "13036",
"_id" : "knows/13036",
"_from" : "persons/bob",
"_to" : "persons/charlie",
"_rev" : "_VwZY7yu--E",
"vertex" : "bob"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7yu---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY7yu--_",
"name" : "Bob"
},
{
"_key" : "charlie",
"_id" : "persons/charlie",
"_rev" : "_VwZY7yu--A",
"name" : "Charlie"
}
]
},
{
"edges" : [
{
"_key" : "13032",
"_id" : "knows/13032",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_VwZY7yu--D",
"vertex" : "alice"
},
{
"_key" : "13039",
"_id" : "knows/13039",
"_from" : "persons/bob",
"_to" : "persons/dave",
"_rev" : "_VwZY7yu--F",
"vertex" : "bob"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7yu---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY7yu--_",
"name" : "Bob"
},
{
"_key" : "dave",
"_id" : "persons/dave",
"_rev" : "_VwZY7yu--B",
"name" : "Dave"
}
]
},
{
"edges" : [
{
"_key" : "13032",
"_id" : "knows/13032",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_VwZY7yu--D",
"vertex" : "alice"
},
{
"_key" : "13045",
"_id" : "knows/13045",
"_from" : "persons/eve",
"_to" : "persons/bob",
"_rev" : "_VwZY7yy--_",
"vertex" : "eve"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7yu---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY7yu--_",
"name" : "Bob"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_VwZY7yu--C",
"name" : "Eve"
}
]
},
{
"edges" : [
{
"_key" : "13032",
"_id" : "knows/13032",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_VwZY7yu--D",
"vertex" : "alice"
},
{
"_key" : "13045",
"_id" : "knows/13045",
"_from" : "persons/eve",
"_to" : "persons/bob",
"_rev" : "_VwZY7yy--_",
"vertex" : "eve"
},
{
"_key" : "13042",
"_id" : "knows/13042",
"_from" : "persons/eve",
"_to" : "persons/alice",
"_rev" : "_VwZY7yy---",
"vertex" : "eve"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7yu---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_VwZY7yu--_",
"name" : "Bob"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_VwZY7yu--C",
"name" : "Eve"
},
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_VwZY7yu---",
"name" : "Alice"
}
]
}
]
}
},
"error" : false,
"code" : 200
}
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF
{
"startVertex" : "persons/alice",
"graphName" : "knows_graph",
"direction" : "any",
"uniqueness" : {
"vertices" : "none",
"edges" : "global"
}
}
EOF
HTTP/1.1 200 OK
content-type: application/json; charset=utf-8
x-content-type-options: nosniff
If the underlying graph is cyclic, maxIterations should be set The underlying graph has two vertices Alice and Bob. With the directed edges:
- Alice knows Bob
- Bob knows Alice
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF
{
"startVertex" : "persons/alice",
"graphName" : "knows_graph",
"direction" : "any",
"uniqueness" : {
"vertices" : "none",
"edges" : "none"
},
"maxIterations" : 5
}
EOF
HTTP/1.1 500 Internal Server Error
content-type: application/json; charset=utf-8
x-content-type-options: nosniff
{
"error" : true,
"code" : 500,
"errorNum" : 1909,
"errorMessage" : "too many iterations - try increasing the value of 'maxIterations'"
}
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF
{
"startVertex" : "persons/alice",
"graphName" : "knows_graph",
"direction" : "any",
"uniqueness" : {
"vertices" : "none",
"edges" : "none"
},
"maxIterations" : 5
}
EOF
HTTP/1.1 500 Internal Server Error
content-type: application/json; charset=utf-8
x-content-type-options: nosniff
All examples were using this graph: