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" : "_V5cvXOK--_",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvXOK--A",
"name" : "Bob"
},
{
"_key" : "charlie",
"_id" : "persons/charlie",
"_rev" : "_V5cvXOO---",
"name" : "Charlie"
},
{
"_key" : "dave",
"_id" : "persons/dave",
"_rev" : "_V5cvXOO--_",
"name" : "Dave"
}
],
"paths" : [
{
"edges" : [ ],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvXOK--_",
"name" : "Alice"
}
]
},
{
"edges" : [
{
"_key" : "13601",
"_id" : "knows/13601",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_V5cvXOS---",
"vertex" : "alice"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvXOK--_",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvXOK--A",
"name" : "Bob"
}
]
},
{
"edges" : [
{
"_key" : "13601",
"_id" : "knows/13601",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_V5cvXOS---",
"vertex" : "alice"
},
{
"_key" : "13605",
"_id" : "knows/13605",
"_from" : "persons/bob",
"_to" : "persons/charlie",
"_rev" : "_V5cvXOS--_",
"vertex" : "bob"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvXOK--_",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvXOK--A",
"name" : "Bob"
},
{
"_key" : "charlie",
"_id" : "persons/charlie",
"_rev" : "_V5cvXOO---",
"name" : "Charlie"
}
]
},
{
"edges" : [
{
"_key" : "13601",
"_id" : "knows/13601",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_V5cvXOS---",
"vertex" : "alice"
},
{
"_key" : "13608",
"_id" : "knows/13608",
"_from" : "persons/bob",
"_to" : "persons/dave",
"_rev" : "_V5cvXOS--A",
"vertex" : "bob"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvXOK--_",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvXOK--A",
"name" : "Bob"
},
{
"_key" : "dave",
"_id" : "persons/dave",
"_rev" : "_V5cvXOO--_",
"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" : "_V5cvVyy--_",
"name" : "Alice"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_V5cvVy2--A",
"name" : "Eve"
}
],
"paths" : [
{
"edges" : [ ],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVyy--_",
"name" : "Alice"
}
]
},
{
"edges" : [
{
"_key" : "13270",
"_id" : "knows/13270",
"_from" : "persons/eve",
"_to" : "persons/alice",
"_rev" : "_V5cvVy6---",
"vertex" : "eve"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVyy--_",
"name" : "Alice"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_V5cvVy2--A",
"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" : "_V5cvVWW---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvVWW--_",
"name" : "Bob"
},
{
"_key" : "charlie",
"_id" : "persons/charlie",
"_rev" : "_V5cvVWa---",
"name" : "Charlie"
},
{
"_key" : "dave",
"_id" : "persons/dave",
"_rev" : "_V5cvVWa--_",
"name" : "Dave"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_V5cvVWa--A",
"name" : "Eve"
},
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVWW---",
"name" : "Alice"
}
],
"paths" : [
{
"edges" : [ ],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVWW---",
"name" : "Alice"
}
]
},
{
"edges" : [
{
"_key" : "12723",
"_id" : "knows/12723",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_V5cvVWa--B",
"vertex" : "alice"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVWW---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvVWW--_",
"name" : "Bob"
}
]
},
{
"edges" : [
{
"_key" : "12723",
"_id" : "knows/12723",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_V5cvVWa--B",
"vertex" : "alice"
},
{
"_key" : "12727",
"_id" : "knows/12727",
"_from" : "persons/bob",
"_to" : "persons/charlie",
"_rev" : "_V5cvVWe---",
"vertex" : "bob"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVWW---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvVWW--_",
"name" : "Bob"
},
{
"_key" : "charlie",
"_id" : "persons/charlie",
"_rev" : "_V5cvVWa---",
"name" : "Charlie"
}
]
},
{
"edges" : [
{
"_key" : "12723",
"_id" : "knows/12723",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_V5cvVWa--B",
"vertex" : "alice"
},
{
"_key" : "12730",
"_id" : "knows/12730",
"_from" : "persons/bob",
"_to" : "persons/dave",
"_rev" : "_V5cvVWe--_",
"vertex" : "bob"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVWW---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvVWW--_",
"name" : "Bob"
},
{
"_key" : "dave",
"_id" : "persons/dave",
"_rev" : "_V5cvVWa--_",
"name" : "Dave"
}
]
},
{
"edges" : [
{
"_key" : "12723",
"_id" : "knows/12723",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_V5cvVWa--B",
"vertex" : "alice"
},
{
"_key" : "12736",
"_id" : "knows/12736",
"_from" : "persons/eve",
"_to" : "persons/bob",
"_rev" : "_V5cvVWe--B",
"vertex" : "eve"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVWW---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvVWW--_",
"name" : "Bob"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_V5cvVWa--A",
"name" : "Eve"
}
]
},
{
"edges" : [
{
"_key" : "12723",
"_id" : "knows/12723",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_V5cvVWa--B",
"vertex" : "alice"
},
{
"_key" : "12736",
"_id" : "knows/12736",
"_from" : "persons/eve",
"_to" : "persons/bob",
"_rev" : "_V5cvVWe--B",
"vertex" : "eve"
},
{
"_key" : "12733",
"_id" : "knows/12733",
"_from" : "persons/eve",
"_to" : "persons/alice",
"_rev" : "_V5cvVWe--A",
"vertex" : "eve"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVWW---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvVWW--_",
"name" : "Bob"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_V5cvVWa--A",
"name" : "Eve"
},
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVWW---",
"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" : "_V5cvVpS---",
"name" : "Alice"
},
{
"_key" : "dave",
"_id" : "persons/dave",
"_rev" : "_V5cvVpS--B",
"name" : "Dave"
}
],
"paths" : [
{
"edges" : [ ],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVpS---",
"name" : "Alice"
}
]
},
{
"edges" : [
{
"_key" : "13109",
"_id" : "knows/13109",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_V5cvVpW--_",
"vertex" : "alice"
},
{
"_key" : "13116",
"_id" : "knows/13116",
"_from" : "persons/bob",
"_to" : "persons/dave",
"_rev" : "_V5cvVpW--B",
"vertex" : "bob"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVpS---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvVpS--_",
"name" : "Bob"
},
{
"_key" : "dave",
"_id" : "persons/dave",
"_rev" : "_V5cvVpS--B",
"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" : "_V5cvVtq---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvVtq--_",
"name" : "Bob"
}
],
"paths" : [
{
"edges" : [ ],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVtq---",
"name" : "Alice"
}
]
},
{
"edges" : [
{
"_key" : "13187",
"_id" : "knows/13187",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_V5cvVtu--_",
"vertex" : "alice"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVtq---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvVtq--_",
"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" : "_V5cvXJq--A",
"name" : "Charlie"
},
{
"_key" : "dave",
"_id" : "persons/dave",
"_rev" : "_V5cvXJq--B",
"name" : "Dave"
}
],
"paths" : [
{
"edges" : [
{
"_key" : "13523",
"_id" : "knows/13523",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_V5cvXJu---",
"vertex" : "alice"
},
{
"_key" : "13527",
"_id" : "knows/13527",
"_from" : "persons/bob",
"_to" : "persons/charlie",
"_rev" : "_V5cvXJu--_",
"vertex" : "bob"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvXJq---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvXJq--_",
"name" : "Bob"
},
{
"_key" : "charlie",
"_id" : "persons/charlie",
"_rev" : "_V5cvXJq--A",
"name" : "Charlie"
}
]
},
{
"edges" : [
{
"_key" : "13523",
"_id" : "knows/13523",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_V5cvXJu---",
"vertex" : "alice"
},
{
"_key" : "13530",
"_id" : "knows/13530",
"_from" : "persons/bob",
"_to" : "persons/dave",
"_rev" : "_V5cvXJu--A",
"vertex" : "bob"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvXJq---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvXJq--_",
"name" : "Bob"
},
{
"_key" : "dave",
"_id" : "persons/dave",
"_rev" : "_V5cvXJq--B",
"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" : "_V5cvV22---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvV22--_",
"name" : "Bob"
}
],
"paths" : [
{
"edges" : [ ],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvV22---",
"name" : "Alice"
}
]
},
{
"edges" : [
{
"_key" : "13334",
"_id" : "knows/13334",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_V5cvV26---",
"vertex" : "alice"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvV22---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvV22--_",
"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" : "_V5cvXXS---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvXXS--_",
"name" : "Bob"
},
{
"_key" : "charlie",
"_id" : "persons/charlie",
"_rev" : "_V5cvXXS--A",
"name" : "Charlie"
},
{
"_key" : "dave",
"_id" : "persons/dave",
"_rev" : "_V5cvXXS--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" : "_V5cvXbe---",
"name" : "Alice"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_V5cvXbe--C",
"name" : "Eve"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvXbe--_",
"name" : "Bob"
}
],
"paths" : [
{
"edges" : [ ],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvXbe---",
"name" : "Alice"
}
]
},
{
"edges" : [
{
"_key" : "13871",
"_id" : "knows/13871",
"_from" : "persons/eve",
"_to" : "persons/alice",
"_rev" : "_V5cvXbi--B",
"vertex" : "eve"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvXbe---",
"name" : "Alice"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_V5cvXbe--C",
"name" : "Eve"
}
]
},
{
"edges" : [
{
"_key" : "13871",
"_id" : "knows/13871",
"_from" : "persons/eve",
"_to" : "persons/alice",
"_rev" : "_V5cvXbi--B",
"vertex" : "eve"
},
{
"_key" : "13874",
"_id" : "knows/13874",
"_from" : "persons/eve",
"_to" : "persons/bob",
"_rev" : "_V5cvXbm---",
"vertex" : "eve"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvXbe---",
"name" : "Alice"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_V5cvXbe--C",
"name" : "Eve"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvXbe--_",
"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" : "_V5cvVey---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvVey--_",
"name" : "Bob"
},
{
"_key" : "charlie",
"_id" : "persons/charlie",
"_rev" : "_V5cvVey--A",
"name" : "Charlie"
},
{
"_key" : "dave",
"_id" : "persons/dave",
"_rev" : "_V5cvVey--B",
"name" : "Dave"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_V5cvVe2---",
"name" : "Eve"
},
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVey---",
"name" : "Alice"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_V5cvVe2---",
"name" : "Eve"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvVey--_",
"name" : "Bob"
},
{
"_key" : "charlie",
"_id" : "persons/charlie",
"_rev" : "_V5cvVey--A",
"name" : "Charlie"
},
{
"_key" : "dave",
"_id" : "persons/dave",
"_rev" : "_V5cvVey--B",
"name" : "Dave"
},
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVey---",
"name" : "Alice"
}
],
"paths" : [
{
"edges" : [ ],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVey---",
"name" : "Alice"
}
]
},
{
"edges" : [
{
"_key" : "12916",
"_id" : "knows/12916",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_V5cvVe2--_",
"vertex" : "alice"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVey---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvVey--_",
"name" : "Bob"
}
]
},
{
"edges" : [
{
"_key" : "12916",
"_id" : "knows/12916",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_V5cvVe2--_",
"vertex" : "alice"
},
{
"_key" : "12920",
"_id" : "knows/12920",
"_from" : "persons/bob",
"_to" : "persons/charlie",
"_rev" : "_V5cvVe2--A",
"vertex" : "bob"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVey---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvVey--_",
"name" : "Bob"
},
{
"_key" : "charlie",
"_id" : "persons/charlie",
"_rev" : "_V5cvVey--A",
"name" : "Charlie"
}
]
},
{
"edges" : [
{
"_key" : "12916",
"_id" : "knows/12916",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_V5cvVe2--_",
"vertex" : "alice"
},
{
"_key" : "12923",
"_id" : "knows/12923",
"_from" : "persons/bob",
"_to" : "persons/dave",
"_rev" : "_V5cvVe2--B",
"vertex" : "bob"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVey---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvVey--_",
"name" : "Bob"
},
{
"_key" : "dave",
"_id" : "persons/dave",
"_rev" : "_V5cvVey--B",
"name" : "Dave"
}
]
},
{
"edges" : [
{
"_key" : "12916",
"_id" : "knows/12916",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_V5cvVe2--_",
"vertex" : "alice"
},
{
"_key" : "12929",
"_id" : "knows/12929",
"_from" : "persons/eve",
"_to" : "persons/bob",
"_rev" : "_V5cvVe6--_",
"vertex" : "eve"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVey---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvVey--_",
"name" : "Bob"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_V5cvVe2---",
"name" : "Eve"
}
]
},
{
"edges" : [
{
"_key" : "12916",
"_id" : "knows/12916",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_V5cvVe2--_",
"vertex" : "alice"
},
{
"_key" : "12929",
"_id" : "knows/12929",
"_from" : "persons/eve",
"_to" : "persons/bob",
"_rev" : "_V5cvVe6--_",
"vertex" : "eve"
},
{
"_key" : "12926",
"_id" : "knows/12926",
"_from" : "persons/eve",
"_to" : "persons/alice",
"_rev" : "_V5cvVe6---",
"vertex" : "eve"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVey---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvVey--_",
"name" : "Bob"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_V5cvVe2---",
"name" : "Eve"
},
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVey---",
"name" : "Alice"
}
]
},
{
"edges" : [
{
"_key" : "12926",
"_id" : "knows/12926",
"_from" : "persons/eve",
"_to" : "persons/alice",
"_rev" : "_V5cvVe6---",
"vertex" : "eve"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVey---",
"name" : "Alice"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_V5cvVe2---",
"name" : "Eve"
}
]
},
{
"edges" : [
{
"_key" : "12926",
"_id" : "knows/12926",
"_from" : "persons/eve",
"_to" : "persons/alice",
"_rev" : "_V5cvVe6---",
"vertex" : "eve"
},
{
"_key" : "12929",
"_id" : "knows/12929",
"_from" : "persons/eve",
"_to" : "persons/bob",
"_rev" : "_V5cvVe6--_",
"vertex" : "eve"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVey---",
"name" : "Alice"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_V5cvVe2---",
"name" : "Eve"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvVey--_",
"name" : "Bob"
}
]
},
{
"edges" : [
{
"_key" : "12926",
"_id" : "knows/12926",
"_from" : "persons/eve",
"_to" : "persons/alice",
"_rev" : "_V5cvVe6---",
"vertex" : "eve"
},
{
"_key" : "12929",
"_id" : "knows/12929",
"_from" : "persons/eve",
"_to" : "persons/bob",
"_rev" : "_V5cvVe6--_",
"vertex" : "eve"
},
{
"_key" : "12920",
"_id" : "knows/12920",
"_from" : "persons/bob",
"_to" : "persons/charlie",
"_rev" : "_V5cvVe2--A",
"vertex" : "bob"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVey---",
"name" : "Alice"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_V5cvVe2---",
"name" : "Eve"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvVey--_",
"name" : "Bob"
},
{
"_key" : "charlie",
"_id" : "persons/charlie",
"_rev" : "_V5cvVey--A",
"name" : "Charlie"
}
]
},
{
"edges" : [
{
"_key" : "12926",
"_id" : "knows/12926",
"_from" : "persons/eve",
"_to" : "persons/alice",
"_rev" : "_V5cvVe6---",
"vertex" : "eve"
},
{
"_key" : "12929",
"_id" : "knows/12929",
"_from" : "persons/eve",
"_to" : "persons/bob",
"_rev" : "_V5cvVe6--_",
"vertex" : "eve"
},
{
"_key" : "12923",
"_id" : "knows/12923",
"_from" : "persons/bob",
"_to" : "persons/dave",
"_rev" : "_V5cvVe2--B",
"vertex" : "bob"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVey---",
"name" : "Alice"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_V5cvVe2---",
"name" : "Eve"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvVey--_",
"name" : "Bob"
},
{
"_key" : "dave",
"_id" : "persons/dave",
"_rev" : "_V5cvVey--B",
"name" : "Dave"
}
]
},
{
"edges" : [
{
"_key" : "12926",
"_id" : "knows/12926",
"_from" : "persons/eve",
"_to" : "persons/alice",
"_rev" : "_V5cvVe6---",
"vertex" : "eve"
},
{
"_key" : "12929",
"_id" : "knows/12929",
"_from" : "persons/eve",
"_to" : "persons/bob",
"_rev" : "_V5cvVe6--_",
"vertex" : "eve"
},
{
"_key" : "12916",
"_id" : "knows/12916",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_V5cvVe2--_",
"vertex" : "alice"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVey---",
"name" : "Alice"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_V5cvVe2---",
"name" : "Eve"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvVey--_",
"name" : "Bob"
},
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVey---",
"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" : "_V5cvXSK--A",
"name" : "Charlie"
},
{
"_key" : "dave",
"_id" : "persons/dave",
"_rev" : "_V5cvXSK--B",
"name" : "Dave"
},
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvXSK---",
"name" : "Alice"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_V5cvXSK--C",
"name" : "Eve"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvXSK--_",
"name" : "Bob"
},
{
"_key" : "charlie",
"_id" : "persons/charlie",
"_rev" : "_V5cvXSK--A",
"name" : "Charlie"
},
{
"_key" : "dave",
"_id" : "persons/dave",
"_rev" : "_V5cvXSK--B",
"name" : "Dave"
},
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvXSK---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvXSK--_",
"name" : "Bob"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_V5cvXSK--C",
"name" : "Eve"
},
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvXSK---",
"name" : "Alice"
}
],
"paths" : [
{
"edges" : [
{
"_key" : "13679",
"_id" : "knows/13679",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_V5cvXSO---",
"vertex" : "alice"
},
{
"_key" : "13683",
"_id" : "knows/13683",
"_from" : "persons/bob",
"_to" : "persons/charlie",
"_rev" : "_V5cvXSO--_",
"vertex" : "bob"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvXSK---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvXSK--_",
"name" : "Bob"
},
{
"_key" : "charlie",
"_id" : "persons/charlie",
"_rev" : "_V5cvXSK--A",
"name" : "Charlie"
}
]
},
{
"edges" : [
{
"_key" : "13679",
"_id" : "knows/13679",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_V5cvXSO---",
"vertex" : "alice"
},
{
"_key" : "13686",
"_id" : "knows/13686",
"_from" : "persons/bob",
"_to" : "persons/dave",
"_rev" : "_V5cvXSO--A",
"vertex" : "bob"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvXSK---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvXSK--_",
"name" : "Bob"
},
{
"_key" : "dave",
"_id" : "persons/dave",
"_rev" : "_V5cvXSK--B",
"name" : "Dave"
}
]
},
{
"edges" : [
{
"_key" : "13679",
"_id" : "knows/13679",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_V5cvXSO---",
"vertex" : "alice"
},
{
"_key" : "13692",
"_id" : "knows/13692",
"_from" : "persons/eve",
"_to" : "persons/bob",
"_rev" : "_V5cvXSS---",
"vertex" : "eve"
},
{
"_key" : "13689",
"_id" : "knows/13689",
"_from" : "persons/eve",
"_to" : "persons/alice",
"_rev" : "_V5cvXSO--B",
"vertex" : "eve"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvXSK---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvXSK--_",
"name" : "Bob"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_V5cvXSK--C",
"name" : "Eve"
},
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvXSK---",
"name" : "Alice"
}
]
},
{
"edges" : [
{
"_key" : "13679",
"_id" : "knows/13679",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_V5cvXSO---",
"vertex" : "alice"
},
{
"_key" : "13692",
"_id" : "knows/13692",
"_from" : "persons/eve",
"_to" : "persons/bob",
"_rev" : "_V5cvXSS---",
"vertex" : "eve"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvXSK---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvXSK--_",
"name" : "Bob"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_V5cvXSK--C",
"name" : "Eve"
}
]
},
{
"edges" : [
{
"_key" : "13679",
"_id" : "knows/13679",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_V5cvXSO---",
"vertex" : "alice"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvXSK---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvXSK--_",
"name" : "Bob"
}
]
},
{
"edges" : [
{
"_key" : "13689",
"_id" : "knows/13689",
"_from" : "persons/eve",
"_to" : "persons/alice",
"_rev" : "_V5cvXSO--B",
"vertex" : "eve"
},
{
"_key" : "13692",
"_id" : "knows/13692",
"_from" : "persons/eve",
"_to" : "persons/bob",
"_rev" : "_V5cvXSS---",
"vertex" : "eve"
},
{
"_key" : "13683",
"_id" : "knows/13683",
"_from" : "persons/bob",
"_to" : "persons/charlie",
"_rev" : "_V5cvXSO--_",
"vertex" : "bob"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvXSK---",
"name" : "Alice"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_V5cvXSK--C",
"name" : "Eve"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvXSK--_",
"name" : "Bob"
},
{
"_key" : "charlie",
"_id" : "persons/charlie",
"_rev" : "_V5cvXSK--A",
"name" : "Charlie"
}
]
},
{
"edges" : [
{
"_key" : "13689",
"_id" : "knows/13689",
"_from" : "persons/eve",
"_to" : "persons/alice",
"_rev" : "_V5cvXSO--B",
"vertex" : "eve"
},
{
"_key" : "13692",
"_id" : "knows/13692",
"_from" : "persons/eve",
"_to" : "persons/bob",
"_rev" : "_V5cvXSS---",
"vertex" : "eve"
},
{
"_key" : "13686",
"_id" : "knows/13686",
"_from" : "persons/bob",
"_to" : "persons/dave",
"_rev" : "_V5cvXSO--A",
"vertex" : "bob"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvXSK---",
"name" : "Alice"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_V5cvXSK--C",
"name" : "Eve"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvXSK--_",
"name" : "Bob"
},
{
"_key" : "dave",
"_id" : "persons/dave",
"_rev" : "_V5cvXSK--B",
"name" : "Dave"
}
]
},
{
"edges" : [
{
"_key" : "13689",
"_id" : "knows/13689",
"_from" : "persons/eve",
"_to" : "persons/alice",
"_rev" : "_V5cvXSO--B",
"vertex" : "eve"
},
{
"_key" : "13692",
"_id" : "knows/13692",
"_from" : "persons/eve",
"_to" : "persons/bob",
"_rev" : "_V5cvXSS---",
"vertex" : "eve"
},
{
"_key" : "13679",
"_id" : "knows/13679",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_V5cvXSO---",
"vertex" : "alice"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvXSK---",
"name" : "Alice"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_V5cvXSK--C",
"name" : "Eve"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvXSK--_",
"name" : "Bob"
},
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvXSK---",
"name" : "Alice"
}
]
},
{
"edges" : [
{
"_key" : "13689",
"_id" : "knows/13689",
"_from" : "persons/eve",
"_to" : "persons/alice",
"_rev" : "_V5cvXSO--B",
"vertex" : "eve"
},
{
"_key" : "13692",
"_id" : "knows/13692",
"_from" : "persons/eve",
"_to" : "persons/bob",
"_rev" : "_V5cvXSS---",
"vertex" : "eve"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvXSK---",
"name" : "Alice"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_V5cvXSK--C",
"name" : "Eve"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvXSK--_",
"name" : "Bob"
}
]
},
{
"edges" : [
{
"_key" : "13689",
"_id" : "knows/13689",
"_from" : "persons/eve",
"_to" : "persons/alice",
"_rev" : "_V5cvXSO--B",
"vertex" : "eve"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvXSK---",
"name" : "Alice"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_V5cvXSK--C",
"name" : "Eve"
}
]
},
{
"edges" : [ ],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvXSK---",
"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" : "_V5cvVaS---",
"name" : "Alice"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_V5cvVaW--_",
"name" : "Eve"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvVaS--_",
"name" : "Bob"
},
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVaS---",
"name" : "Alice"
},
{
"_key" : "dave",
"_id" : "persons/dave",
"_rev" : "_V5cvVaW---",
"name" : "Dave"
},
{
"_key" : "charlie",
"_id" : "persons/charlie",
"_rev" : "_V5cvVaS--A",
"name" : "Charlie"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvVaS--_",
"name" : "Bob"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_V5cvVaW--_",
"name" : "Eve"
},
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVaS---",
"name" : "Alice"
},
{
"_key" : "dave",
"_id" : "persons/dave",
"_rev" : "_V5cvVaW---",
"name" : "Dave"
},
{
"_key" : "charlie",
"_id" : "persons/charlie",
"_rev" : "_V5cvVaS--A",
"name" : "Charlie"
}
],
"paths" : [
{
"edges" : [ ],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVaS---",
"name" : "Alice"
}
]
},
{
"edges" : [
{
"_key" : "12822",
"_id" : "knows/12822",
"_from" : "persons/eve",
"_to" : "persons/alice",
"_rev" : "_V5cvVaa--_",
"vertex" : "eve"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVaS---",
"name" : "Alice"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_V5cvVaW--_",
"name" : "Eve"
}
]
},
{
"edges" : [
{
"_key" : "12822",
"_id" : "knows/12822",
"_from" : "persons/eve",
"_to" : "persons/alice",
"_rev" : "_V5cvVaa--_",
"vertex" : "eve"
},
{
"_key" : "12825",
"_id" : "knows/12825",
"_from" : "persons/eve",
"_to" : "persons/bob",
"_rev" : "_V5cvVaa--A",
"vertex" : "eve"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVaS---",
"name" : "Alice"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_V5cvVaW--_",
"name" : "Eve"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvVaS--_",
"name" : "Bob"
}
]
},
{
"edges" : [
{
"_key" : "12822",
"_id" : "knows/12822",
"_from" : "persons/eve",
"_to" : "persons/alice",
"_rev" : "_V5cvVaa--_",
"vertex" : "eve"
},
{
"_key" : "12825",
"_id" : "knows/12825",
"_from" : "persons/eve",
"_to" : "persons/bob",
"_rev" : "_V5cvVaa--A",
"vertex" : "eve"
},
{
"_key" : "12812",
"_id" : "knows/12812",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_V5cvVaW--A",
"vertex" : "alice"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVaS---",
"name" : "Alice"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_V5cvVaW--_",
"name" : "Eve"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvVaS--_",
"name" : "Bob"
},
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVaS---",
"name" : "Alice"
}
]
},
{
"edges" : [
{
"_key" : "12822",
"_id" : "knows/12822",
"_from" : "persons/eve",
"_to" : "persons/alice",
"_rev" : "_V5cvVaa--_",
"vertex" : "eve"
},
{
"_key" : "12825",
"_id" : "knows/12825",
"_from" : "persons/eve",
"_to" : "persons/bob",
"_rev" : "_V5cvVaa--A",
"vertex" : "eve"
},
{
"_key" : "12819",
"_id" : "knows/12819",
"_from" : "persons/bob",
"_to" : "persons/dave",
"_rev" : "_V5cvVaa---",
"vertex" : "bob"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVaS---",
"name" : "Alice"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_V5cvVaW--_",
"name" : "Eve"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvVaS--_",
"name" : "Bob"
},
{
"_key" : "dave",
"_id" : "persons/dave",
"_rev" : "_V5cvVaW---",
"name" : "Dave"
}
]
},
{
"edges" : [
{
"_key" : "12822",
"_id" : "knows/12822",
"_from" : "persons/eve",
"_to" : "persons/alice",
"_rev" : "_V5cvVaa--_",
"vertex" : "eve"
},
{
"_key" : "12825",
"_id" : "knows/12825",
"_from" : "persons/eve",
"_to" : "persons/bob",
"_rev" : "_V5cvVaa--A",
"vertex" : "eve"
},
{
"_key" : "12816",
"_id" : "knows/12816",
"_from" : "persons/bob",
"_to" : "persons/charlie",
"_rev" : "_V5cvVaW--B",
"vertex" : "bob"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVaS---",
"name" : "Alice"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_V5cvVaW--_",
"name" : "Eve"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvVaS--_",
"name" : "Bob"
},
{
"_key" : "charlie",
"_id" : "persons/charlie",
"_rev" : "_V5cvVaS--A",
"name" : "Charlie"
}
]
},
{
"edges" : [
{
"_key" : "12812",
"_id" : "knows/12812",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_V5cvVaW--A",
"vertex" : "alice"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVaS---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvVaS--_",
"name" : "Bob"
}
]
},
{
"edges" : [
{
"_key" : "12812",
"_id" : "knows/12812",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_V5cvVaW--A",
"vertex" : "alice"
},
{
"_key" : "12825",
"_id" : "knows/12825",
"_from" : "persons/eve",
"_to" : "persons/bob",
"_rev" : "_V5cvVaa--A",
"vertex" : "eve"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVaS---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvVaS--_",
"name" : "Bob"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_V5cvVaW--_",
"name" : "Eve"
}
]
},
{
"edges" : [
{
"_key" : "12812",
"_id" : "knows/12812",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_V5cvVaW--A",
"vertex" : "alice"
},
{
"_key" : "12825",
"_id" : "knows/12825",
"_from" : "persons/eve",
"_to" : "persons/bob",
"_rev" : "_V5cvVaa--A",
"vertex" : "eve"
},
{
"_key" : "12822",
"_id" : "knows/12822",
"_from" : "persons/eve",
"_to" : "persons/alice",
"_rev" : "_V5cvVaa--_",
"vertex" : "eve"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVaS---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvVaS--_",
"name" : "Bob"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_V5cvVaW--_",
"name" : "Eve"
},
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVaS---",
"name" : "Alice"
}
]
},
{
"edges" : [
{
"_key" : "12812",
"_id" : "knows/12812",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_V5cvVaW--A",
"vertex" : "alice"
},
{
"_key" : "12819",
"_id" : "knows/12819",
"_from" : "persons/bob",
"_to" : "persons/dave",
"_rev" : "_V5cvVaa---",
"vertex" : "bob"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVaS---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvVaS--_",
"name" : "Bob"
},
{
"_key" : "dave",
"_id" : "persons/dave",
"_rev" : "_V5cvVaW---",
"name" : "Dave"
}
]
},
{
"edges" : [
{
"_key" : "12812",
"_id" : "knows/12812",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_V5cvVaW--A",
"vertex" : "alice"
},
{
"_key" : "12816",
"_id" : "knows/12816",
"_from" : "persons/bob",
"_to" : "persons/charlie",
"_rev" : "_V5cvVaW--B",
"vertex" : "bob"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVaS---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvVaS--_",
"name" : "Bob"
},
{
"_key" : "charlie",
"_id" : "persons/charlie",
"_rev" : "_V5cvVaS--A",
"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" : "_V5cvVkG---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvVkG--_",
"name" : "Bob"
},
{
"_key" : "charlie",
"_id" : "persons/charlie",
"_rev" : "_V5cvVkG--A",
"name" : "Charlie"
},
{
"_key" : "dave",
"_id" : "persons/dave",
"_rev" : "_V5cvVkK---",
"name" : "Dave"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_V5cvVkK--_",
"name" : "Eve"
},
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVkG---",
"name" : "Alice"
}
],
"paths" : [
{
"edges" : [ ],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVkG---",
"name" : "Alice"
}
]
},
{
"edges" : [
{
"_key" : "13020",
"_id" : "knows/13020",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_V5cvVkK--A",
"vertex" : "alice"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVkG---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvVkG--_",
"name" : "Bob"
}
]
},
{
"edges" : [
{
"_key" : "13020",
"_id" : "knows/13020",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_V5cvVkK--A",
"vertex" : "alice"
},
{
"_key" : "13024",
"_id" : "knows/13024",
"_from" : "persons/bob",
"_to" : "persons/charlie",
"_rev" : "_V5cvVkK--B",
"vertex" : "bob"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVkG---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvVkG--_",
"name" : "Bob"
},
{
"_key" : "charlie",
"_id" : "persons/charlie",
"_rev" : "_V5cvVkG--A",
"name" : "Charlie"
}
]
},
{
"edges" : [
{
"_key" : "13020",
"_id" : "knows/13020",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_V5cvVkK--A",
"vertex" : "alice"
},
{
"_key" : "13027",
"_id" : "knows/13027",
"_from" : "persons/bob",
"_to" : "persons/dave",
"_rev" : "_V5cvVkK--C",
"vertex" : "bob"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVkG---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvVkG--_",
"name" : "Bob"
},
{
"_key" : "dave",
"_id" : "persons/dave",
"_rev" : "_V5cvVkK---",
"name" : "Dave"
}
]
},
{
"edges" : [
{
"_key" : "13020",
"_id" : "knows/13020",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_V5cvVkK--A",
"vertex" : "alice"
},
{
"_key" : "13033",
"_id" : "knows/13033",
"_from" : "persons/eve",
"_to" : "persons/bob",
"_rev" : "_V5cvVkO--_",
"vertex" : "eve"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVkG---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvVkG--_",
"name" : "Bob"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_V5cvVkK--_",
"name" : "Eve"
}
]
},
{
"edges" : [
{
"_key" : "13020",
"_id" : "knows/13020",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_V5cvVkK--A",
"vertex" : "alice"
},
{
"_key" : "13033",
"_id" : "knows/13033",
"_from" : "persons/eve",
"_to" : "persons/bob",
"_rev" : "_V5cvVkO--_",
"vertex" : "eve"
},
{
"_key" : "13030",
"_id" : "knows/13030",
"_from" : "persons/eve",
"_to" : "persons/alice",
"_rev" : "_V5cvVkO---",
"vertex" : "eve"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVkG---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvVkG--_",
"name" : "Bob"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_V5cvVkK--_",
"name" : "Eve"
},
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVkG---",
"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" : "_V5cvXOK--_",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvXOK--A",
"name" : "Bob"
},
{
"_key" : "charlie",
"_id" : "persons/charlie",
"_rev" : "_V5cvXOO---",
"name" : "Charlie"
},
{
"_key" : "dave",
"_id" : "persons/dave",
"_rev" : "_V5cvXOO--_",
"name" : "Dave"
}
],
"paths" : [
{
"edges" : [ ],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvXOK--_",
"name" : "Alice"
}
]
},
{
"edges" : [
{
"_key" : "13601",
"_id" : "knows/13601",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_V5cvXOS---",
"vertex" : "alice"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvXOK--_",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvXOK--A",
"name" : "Bob"
}
]
},
{
"edges" : [
{
"_key" : "13601",
"_id" : "knows/13601",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_V5cvXOS---",
"vertex" : "alice"
},
{
"_key" : "13605",
"_id" : "knows/13605",
"_from" : "persons/bob",
"_to" : "persons/charlie",
"_rev" : "_V5cvXOS--_",
"vertex" : "bob"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvXOK--_",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvXOK--A",
"name" : "Bob"
},
{
"_key" : "charlie",
"_id" : "persons/charlie",
"_rev" : "_V5cvXOO---",
"name" : "Charlie"
}
]
},
{
"edges" : [
{
"_key" : "13601",
"_id" : "knows/13601",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_V5cvXOS---",
"vertex" : "alice"
},
{
"_key" : "13608",
"_id" : "knows/13608",
"_from" : "persons/bob",
"_to" : "persons/dave",
"_rev" : "_V5cvXOS--A",
"vertex" : "bob"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvXOK--_",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvXOK--A",
"name" : "Bob"
},
{
"_key" : "dave",
"_id" : "persons/dave",
"_rev" : "_V5cvXOO--_",
"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" : "_V5cvVyy--_",
"name" : "Alice"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_V5cvVy2--A",
"name" : "Eve"
}
],
"paths" : [
{
"edges" : [ ],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVyy--_",
"name" : "Alice"
}
]
},
{
"edges" : [
{
"_key" : "13270",
"_id" : "knows/13270",
"_from" : "persons/eve",
"_to" : "persons/alice",
"_rev" : "_V5cvVy6---",
"vertex" : "eve"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVyy--_",
"name" : "Alice"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_V5cvVy2--A",
"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" : "_V5cvVWW---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvVWW--_",
"name" : "Bob"
},
{
"_key" : "charlie",
"_id" : "persons/charlie",
"_rev" : "_V5cvVWa---",
"name" : "Charlie"
},
{
"_key" : "dave",
"_id" : "persons/dave",
"_rev" : "_V5cvVWa--_",
"name" : "Dave"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_V5cvVWa--A",
"name" : "Eve"
},
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVWW---",
"name" : "Alice"
}
],
"paths" : [
{
"edges" : [ ],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVWW---",
"name" : "Alice"
}
]
},
{
"edges" : [
{
"_key" : "12723",
"_id" : "knows/12723",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_V5cvVWa--B",
"vertex" : "alice"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVWW---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvVWW--_",
"name" : "Bob"
}
]
},
{
"edges" : [
{
"_key" : "12723",
"_id" : "knows/12723",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_V5cvVWa--B",
"vertex" : "alice"
},
{
"_key" : "12727",
"_id" : "knows/12727",
"_from" : "persons/bob",
"_to" : "persons/charlie",
"_rev" : "_V5cvVWe---",
"vertex" : "bob"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVWW---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvVWW--_",
"name" : "Bob"
},
{
"_key" : "charlie",
"_id" : "persons/charlie",
"_rev" : "_V5cvVWa---",
"name" : "Charlie"
}
]
},
{
"edges" : [
{
"_key" : "12723",
"_id" : "knows/12723",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_V5cvVWa--B",
"vertex" : "alice"
},
{
"_key" : "12730",
"_id" : "knows/12730",
"_from" : "persons/bob",
"_to" : "persons/dave",
"_rev" : "_V5cvVWe--_",
"vertex" : "bob"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVWW---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvVWW--_",
"name" : "Bob"
},
{
"_key" : "dave",
"_id" : "persons/dave",
"_rev" : "_V5cvVWa--_",
"name" : "Dave"
}
]
},
{
"edges" : [
{
"_key" : "12723",
"_id" : "knows/12723",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_V5cvVWa--B",
"vertex" : "alice"
},
{
"_key" : "12736",
"_id" : "knows/12736",
"_from" : "persons/eve",
"_to" : "persons/bob",
"_rev" : "_V5cvVWe--B",
"vertex" : "eve"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVWW---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvVWW--_",
"name" : "Bob"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_V5cvVWa--A",
"name" : "Eve"
}
]
},
{
"edges" : [
{
"_key" : "12723",
"_id" : "knows/12723",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_V5cvVWa--B",
"vertex" : "alice"
},
{
"_key" : "12736",
"_id" : "knows/12736",
"_from" : "persons/eve",
"_to" : "persons/bob",
"_rev" : "_V5cvVWe--B",
"vertex" : "eve"
},
{
"_key" : "12733",
"_id" : "knows/12733",
"_from" : "persons/eve",
"_to" : "persons/alice",
"_rev" : "_V5cvVWe--A",
"vertex" : "eve"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVWW---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvVWW--_",
"name" : "Bob"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_V5cvVWa--A",
"name" : "Eve"
},
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVWW---",
"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" : "_V5cvVpS---",
"name" : "Alice"
},
{
"_key" : "dave",
"_id" : "persons/dave",
"_rev" : "_V5cvVpS--B",
"name" : "Dave"
}
],
"paths" : [
{
"edges" : [ ],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVpS---",
"name" : "Alice"
}
]
},
{
"edges" : [
{
"_key" : "13109",
"_id" : "knows/13109",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_V5cvVpW--_",
"vertex" : "alice"
},
{
"_key" : "13116",
"_id" : "knows/13116",
"_from" : "persons/bob",
"_to" : "persons/dave",
"_rev" : "_V5cvVpW--B",
"vertex" : "bob"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVpS---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvVpS--_",
"name" : "Bob"
},
{
"_key" : "dave",
"_id" : "persons/dave",
"_rev" : "_V5cvVpS--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",
"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" : "_V5cvVtq---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvVtq--_",
"name" : "Bob"
}
],
"paths" : [
{
"edges" : [ ],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVtq---",
"name" : "Alice"
}
]
},
{
"edges" : [
{
"_key" : "13187",
"_id" : "knows/13187",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_V5cvVtu--_",
"vertex" : "alice"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVtq---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvVtq--_",
"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" : "_V5cvXJq--A",
"name" : "Charlie"
},
{
"_key" : "dave",
"_id" : "persons/dave",
"_rev" : "_V5cvXJq--B",
"name" : "Dave"
}
],
"paths" : [
{
"edges" : [
{
"_key" : "13523",
"_id" : "knows/13523",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_V5cvXJu---",
"vertex" : "alice"
},
{
"_key" : "13527",
"_id" : "knows/13527",
"_from" : "persons/bob",
"_to" : "persons/charlie",
"_rev" : "_V5cvXJu--_",
"vertex" : "bob"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvXJq---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvXJq--_",
"name" : "Bob"
},
{
"_key" : "charlie",
"_id" : "persons/charlie",
"_rev" : "_V5cvXJq--A",
"name" : "Charlie"
}
]
},
{
"edges" : [
{
"_key" : "13523",
"_id" : "knows/13523",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_V5cvXJu---",
"vertex" : "alice"
},
{
"_key" : "13530",
"_id" : "knows/13530",
"_from" : "persons/bob",
"_to" : "persons/dave",
"_rev" : "_V5cvXJu--A",
"vertex" : "bob"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvXJq---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvXJq--_",
"name" : "Bob"
},
{
"_key" : "dave",
"_id" : "persons/dave",
"_rev" : "_V5cvXJq--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",
"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" : "_V5cvV22---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvV22--_",
"name" : "Bob"
}
],
"paths" : [
{
"edges" : [ ],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvV22---",
"name" : "Alice"
}
]
},
{
"edges" : [
{
"_key" : "13334",
"_id" : "knows/13334",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_V5cvV26---",
"vertex" : "alice"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvV22---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvV22--_",
"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" : "_V5cvXXS---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvXXS--_",
"name" : "Bob"
},
{
"_key" : "charlie",
"_id" : "persons/charlie",
"_rev" : "_V5cvXXS--A",
"name" : "Charlie"
},
{
"_key" : "dave",
"_id" : "persons/dave",
"_rev" : "_V5cvXXS--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" : "_V5cvXbe---",
"name" : "Alice"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_V5cvXbe--C",
"name" : "Eve"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvXbe--_",
"name" : "Bob"
}
],
"paths" : [
{
"edges" : [ ],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvXbe---",
"name" : "Alice"
}
]
},
{
"edges" : [
{
"_key" : "13871",
"_id" : "knows/13871",
"_from" : "persons/eve",
"_to" : "persons/alice",
"_rev" : "_V5cvXbi--B",
"vertex" : "eve"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvXbe---",
"name" : "Alice"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_V5cvXbe--C",
"name" : "Eve"
}
]
},
{
"edges" : [
{
"_key" : "13871",
"_id" : "knows/13871",
"_from" : "persons/eve",
"_to" : "persons/alice",
"_rev" : "_V5cvXbi--B",
"vertex" : "eve"
},
{
"_key" : "13874",
"_id" : "knows/13874",
"_from" : "persons/eve",
"_to" : "persons/bob",
"_rev" : "_V5cvXbm---",
"vertex" : "eve"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvXbe---",
"name" : "Alice"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_V5cvXbe--C",
"name" : "Eve"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvXbe--_",
"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" : "_V5cvVey---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvVey--_",
"name" : "Bob"
},
{
"_key" : "charlie",
"_id" : "persons/charlie",
"_rev" : "_V5cvVey--A",
"name" : "Charlie"
},
{
"_key" : "dave",
"_id" : "persons/dave",
"_rev" : "_V5cvVey--B",
"name" : "Dave"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_V5cvVe2---",
"name" : "Eve"
},
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVey---",
"name" : "Alice"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_V5cvVe2---",
"name" : "Eve"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvVey--_",
"name" : "Bob"
},
{
"_key" : "charlie",
"_id" : "persons/charlie",
"_rev" : "_V5cvVey--A",
"name" : "Charlie"
},
{
"_key" : "dave",
"_id" : "persons/dave",
"_rev" : "_V5cvVey--B",
"name" : "Dave"
},
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVey---",
"name" : "Alice"
}
],
"paths" : [
{
"edges" : [ ],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVey---",
"name" : "Alice"
}
]
},
{
"edges" : [
{
"_key" : "12916",
"_id" : "knows/12916",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_V5cvVe2--_",
"vertex" : "alice"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVey---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvVey--_",
"name" : "Bob"
}
]
},
{
"edges" : [
{
"_key" : "12916",
"_id" : "knows/12916",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_V5cvVe2--_",
"vertex" : "alice"
},
{
"_key" : "12920",
"_id" : "knows/12920",
"_from" : "persons/bob",
"_to" : "persons/charlie",
"_rev" : "_V5cvVe2--A",
"vertex" : "bob"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVey---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvVey--_",
"name" : "Bob"
},
{
"_key" : "charlie",
"_id" : "persons/charlie",
"_rev" : "_V5cvVey--A",
"name" : "Charlie"
}
]
},
{
"edges" : [
{
"_key" : "12916",
"_id" : "knows/12916",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_V5cvVe2--_",
"vertex" : "alice"
},
{
"_key" : "12923",
"_id" : "knows/12923",
"_from" : "persons/bob",
"_to" : "persons/dave",
"_rev" : "_V5cvVe2--B",
"vertex" : "bob"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVey---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvVey--_",
"name" : "Bob"
},
{
"_key" : "dave",
"_id" : "persons/dave",
"_rev" : "_V5cvVey--B",
"name" : "Dave"
}
]
},
{
"edges" : [
{
"_key" : "12916",
"_id" : "knows/12916",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_V5cvVe2--_",
"vertex" : "alice"
},
{
"_key" : "12929",
"_id" : "knows/12929",
"_from" : "persons/eve",
"_to" : "persons/bob",
"_rev" : "_V5cvVe6--_",
"vertex" : "eve"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVey---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvVey--_",
"name" : "Bob"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_V5cvVe2---",
"name" : "Eve"
}
]
},
{
"edges" : [
{
"_key" : "12916",
"_id" : "knows/12916",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_V5cvVe2--_",
"vertex" : "alice"
},
{
"_key" : "12929",
"_id" : "knows/12929",
"_from" : "persons/eve",
"_to" : "persons/bob",
"_rev" : "_V5cvVe6--_",
"vertex" : "eve"
},
{
"_key" : "12926",
"_id" : "knows/12926",
"_from" : "persons/eve",
"_to" : "persons/alice",
"_rev" : "_V5cvVe6---",
"vertex" : "eve"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVey---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvVey--_",
"name" : "Bob"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_V5cvVe2---",
"name" : "Eve"
},
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVey---",
"name" : "Alice"
}
]
},
{
"edges" : [
{
"_key" : "12926",
"_id" : "knows/12926",
"_from" : "persons/eve",
"_to" : "persons/alice",
"_rev" : "_V5cvVe6---",
"vertex" : "eve"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVey---",
"name" : "Alice"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_V5cvVe2---",
"name" : "Eve"
}
]
},
{
"edges" : [
{
"_key" : "12926",
"_id" : "knows/12926",
"_from" : "persons/eve",
"_to" : "persons/alice",
"_rev" : "_V5cvVe6---",
"vertex" : "eve"
},
{
"_key" : "12929",
"_id" : "knows/12929",
"_from" : "persons/eve",
"_to" : "persons/bob",
"_rev" : "_V5cvVe6--_",
"vertex" : "eve"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVey---",
"name" : "Alice"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_V5cvVe2---",
"name" : "Eve"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvVey--_",
"name" : "Bob"
}
]
},
{
"edges" : [
{
"_key" : "12926",
"_id" : "knows/12926",
"_from" : "persons/eve",
"_to" : "persons/alice",
"_rev" : "_V5cvVe6---",
"vertex" : "eve"
},
{
"_key" : "12929",
"_id" : "knows/12929",
"_from" : "persons/eve",
"_to" : "persons/bob",
"_rev" : "_V5cvVe6--_",
"vertex" : "eve"
},
{
"_key" : "12920",
"_id" : "knows/12920",
"_from" : "persons/bob",
"_to" : "persons/charlie",
"_rev" : "_V5cvVe2--A",
"vertex" : "bob"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVey---",
"name" : "Alice"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_V5cvVe2---",
"name" : "Eve"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvVey--_",
"name" : "Bob"
},
{
"_key" : "charlie",
"_id" : "persons/charlie",
"_rev" : "_V5cvVey--A",
"name" : "Charlie"
}
]
},
{
"edges" : [
{
"_key" : "12926",
"_id" : "knows/12926",
"_from" : "persons/eve",
"_to" : "persons/alice",
"_rev" : "_V5cvVe6---",
"vertex" : "eve"
},
{
"_key" : "12929",
"_id" : "knows/12929",
"_from" : "persons/eve",
"_to" : "persons/bob",
"_rev" : "_V5cvVe6--_",
"vertex" : "eve"
},
{
"_key" : "12923",
"_id" : "knows/12923",
"_from" : "persons/bob",
"_to" : "persons/dave",
"_rev" : "_V5cvVe2--B",
"vertex" : "bob"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVey---",
"name" : "Alice"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_V5cvVe2---",
"name" : "Eve"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvVey--_",
"name" : "Bob"
},
{
"_key" : "dave",
"_id" : "persons/dave",
"_rev" : "_V5cvVey--B",
"name" : "Dave"
}
]
},
{
"edges" : [
{
"_key" : "12926",
"_id" : "knows/12926",
"_from" : "persons/eve",
"_to" : "persons/alice",
"_rev" : "_V5cvVe6---",
"vertex" : "eve"
},
{
"_key" : "12929",
"_id" : "knows/12929",
"_from" : "persons/eve",
"_to" : "persons/bob",
"_rev" : "_V5cvVe6--_",
"vertex" : "eve"
},
{
"_key" : "12916",
"_id" : "knows/12916",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_V5cvVe2--_",
"vertex" : "alice"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVey---",
"name" : "Alice"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_V5cvVe2---",
"name" : "Eve"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvVey--_",
"name" : "Bob"
},
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVey---",
"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" : "_V5cvXSK--A",
"name" : "Charlie"
},
{
"_key" : "dave",
"_id" : "persons/dave",
"_rev" : "_V5cvXSK--B",
"name" : "Dave"
},
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvXSK---",
"name" : "Alice"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_V5cvXSK--C",
"name" : "Eve"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvXSK--_",
"name" : "Bob"
},
{
"_key" : "charlie",
"_id" : "persons/charlie",
"_rev" : "_V5cvXSK--A",
"name" : "Charlie"
},
{
"_key" : "dave",
"_id" : "persons/dave",
"_rev" : "_V5cvXSK--B",
"name" : "Dave"
},
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvXSK---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvXSK--_",
"name" : "Bob"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_V5cvXSK--C",
"name" : "Eve"
},
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvXSK---",
"name" : "Alice"
}
],
"paths" : [
{
"edges" : [
{
"_key" : "13679",
"_id" : "knows/13679",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_V5cvXSO---",
"vertex" : "alice"
},
{
"_key" : "13683",
"_id" : "knows/13683",
"_from" : "persons/bob",
"_to" : "persons/charlie",
"_rev" : "_V5cvXSO--_",
"vertex" : "bob"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvXSK---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvXSK--_",
"name" : "Bob"
},
{
"_key" : "charlie",
"_id" : "persons/charlie",
"_rev" : "_V5cvXSK--A",
"name" : "Charlie"
}
]
},
{
"edges" : [
{
"_key" : "13679",
"_id" : "knows/13679",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_V5cvXSO---",
"vertex" : "alice"
},
{
"_key" : "13686",
"_id" : "knows/13686",
"_from" : "persons/bob",
"_to" : "persons/dave",
"_rev" : "_V5cvXSO--A",
"vertex" : "bob"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvXSK---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvXSK--_",
"name" : "Bob"
},
{
"_key" : "dave",
"_id" : "persons/dave",
"_rev" : "_V5cvXSK--B",
"name" : "Dave"
}
]
},
{
"edges" : [
{
"_key" : "13679",
"_id" : "knows/13679",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_V5cvXSO---",
"vertex" : "alice"
},
{
"_key" : "13692",
"_id" : "knows/13692",
"_from" : "persons/eve",
"_to" : "persons/bob",
"_rev" : "_V5cvXSS---",
"vertex" : "eve"
},
{
"_key" : "13689",
"_id" : "knows/13689",
"_from" : "persons/eve",
"_to" : "persons/alice",
"_rev" : "_V5cvXSO--B",
"vertex" : "eve"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvXSK---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvXSK--_",
"name" : "Bob"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_V5cvXSK--C",
"name" : "Eve"
},
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvXSK---",
"name" : "Alice"
}
]
},
{
"edges" : [
{
"_key" : "13679",
"_id" : "knows/13679",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_V5cvXSO---",
"vertex" : "alice"
},
{
"_key" : "13692",
"_id" : "knows/13692",
"_from" : "persons/eve",
"_to" : "persons/bob",
"_rev" : "_V5cvXSS---",
"vertex" : "eve"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvXSK---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvXSK--_",
"name" : "Bob"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_V5cvXSK--C",
"name" : "Eve"
}
]
},
{
"edges" : [
{
"_key" : "13679",
"_id" : "knows/13679",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_V5cvXSO---",
"vertex" : "alice"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvXSK---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvXSK--_",
"name" : "Bob"
}
]
},
{
"edges" : [
{
"_key" : "13689",
"_id" : "knows/13689",
"_from" : "persons/eve",
"_to" : "persons/alice",
"_rev" : "_V5cvXSO--B",
"vertex" : "eve"
},
{
"_key" : "13692",
"_id" : "knows/13692",
"_from" : "persons/eve",
"_to" : "persons/bob",
"_rev" : "_V5cvXSS---",
"vertex" : "eve"
},
{
"_key" : "13683",
"_id" : "knows/13683",
"_from" : "persons/bob",
"_to" : "persons/charlie",
"_rev" : "_V5cvXSO--_",
"vertex" : "bob"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvXSK---",
"name" : "Alice"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_V5cvXSK--C",
"name" : "Eve"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvXSK--_",
"name" : "Bob"
},
{
"_key" : "charlie",
"_id" : "persons/charlie",
"_rev" : "_V5cvXSK--A",
"name" : "Charlie"
}
]
},
{
"edges" : [
{
"_key" : "13689",
"_id" : "knows/13689",
"_from" : "persons/eve",
"_to" : "persons/alice",
"_rev" : "_V5cvXSO--B",
"vertex" : "eve"
},
{
"_key" : "13692",
"_id" : "knows/13692",
"_from" : "persons/eve",
"_to" : "persons/bob",
"_rev" : "_V5cvXSS---",
"vertex" : "eve"
},
{
"_key" : "13686",
"_id" : "knows/13686",
"_from" : "persons/bob",
"_to" : "persons/dave",
"_rev" : "_V5cvXSO--A",
"vertex" : "bob"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvXSK---",
"name" : "Alice"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_V5cvXSK--C",
"name" : "Eve"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvXSK--_",
"name" : "Bob"
},
{
"_key" : "dave",
"_id" : "persons/dave",
"_rev" : "_V5cvXSK--B",
"name" : "Dave"
}
]
},
{
"edges" : [
{
"_key" : "13689",
"_id" : "knows/13689",
"_from" : "persons/eve",
"_to" : "persons/alice",
"_rev" : "_V5cvXSO--B",
"vertex" : "eve"
},
{
"_key" : "13692",
"_id" : "knows/13692",
"_from" : "persons/eve",
"_to" : "persons/bob",
"_rev" : "_V5cvXSS---",
"vertex" : "eve"
},
{
"_key" : "13679",
"_id" : "knows/13679",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_V5cvXSO---",
"vertex" : "alice"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvXSK---",
"name" : "Alice"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_V5cvXSK--C",
"name" : "Eve"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvXSK--_",
"name" : "Bob"
},
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvXSK---",
"name" : "Alice"
}
]
},
{
"edges" : [
{
"_key" : "13689",
"_id" : "knows/13689",
"_from" : "persons/eve",
"_to" : "persons/alice",
"_rev" : "_V5cvXSO--B",
"vertex" : "eve"
},
{
"_key" : "13692",
"_id" : "knows/13692",
"_from" : "persons/eve",
"_to" : "persons/bob",
"_rev" : "_V5cvXSS---",
"vertex" : "eve"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvXSK---",
"name" : "Alice"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_V5cvXSK--C",
"name" : "Eve"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvXSK--_",
"name" : "Bob"
}
]
},
{
"edges" : [
{
"_key" : "13689",
"_id" : "knows/13689",
"_from" : "persons/eve",
"_to" : "persons/alice",
"_rev" : "_V5cvXSO--B",
"vertex" : "eve"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvXSK---",
"name" : "Alice"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_V5cvXSK--C",
"name" : "Eve"
}
]
},
{
"edges" : [ ],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvXSK---",
"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" : "_V5cvVaS---",
"name" : "Alice"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_V5cvVaW--_",
"name" : "Eve"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvVaS--_",
"name" : "Bob"
},
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVaS---",
"name" : "Alice"
},
{
"_key" : "dave",
"_id" : "persons/dave",
"_rev" : "_V5cvVaW---",
"name" : "Dave"
},
{
"_key" : "charlie",
"_id" : "persons/charlie",
"_rev" : "_V5cvVaS--A",
"name" : "Charlie"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvVaS--_",
"name" : "Bob"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_V5cvVaW--_",
"name" : "Eve"
},
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVaS---",
"name" : "Alice"
},
{
"_key" : "dave",
"_id" : "persons/dave",
"_rev" : "_V5cvVaW---",
"name" : "Dave"
},
{
"_key" : "charlie",
"_id" : "persons/charlie",
"_rev" : "_V5cvVaS--A",
"name" : "Charlie"
}
],
"paths" : [
{
"edges" : [ ],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVaS---",
"name" : "Alice"
}
]
},
{
"edges" : [
{
"_key" : "12822",
"_id" : "knows/12822",
"_from" : "persons/eve",
"_to" : "persons/alice",
"_rev" : "_V5cvVaa--_",
"vertex" : "eve"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVaS---",
"name" : "Alice"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_V5cvVaW--_",
"name" : "Eve"
}
]
},
{
"edges" : [
{
"_key" : "12822",
"_id" : "knows/12822",
"_from" : "persons/eve",
"_to" : "persons/alice",
"_rev" : "_V5cvVaa--_",
"vertex" : "eve"
},
{
"_key" : "12825",
"_id" : "knows/12825",
"_from" : "persons/eve",
"_to" : "persons/bob",
"_rev" : "_V5cvVaa--A",
"vertex" : "eve"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVaS---",
"name" : "Alice"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_V5cvVaW--_",
"name" : "Eve"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvVaS--_",
"name" : "Bob"
}
]
},
{
"edges" : [
{
"_key" : "12822",
"_id" : "knows/12822",
"_from" : "persons/eve",
"_to" : "persons/alice",
"_rev" : "_V5cvVaa--_",
"vertex" : "eve"
},
{
"_key" : "12825",
"_id" : "knows/12825",
"_from" : "persons/eve",
"_to" : "persons/bob",
"_rev" : "_V5cvVaa--A",
"vertex" : "eve"
},
{
"_key" : "12812",
"_id" : "knows/12812",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_V5cvVaW--A",
"vertex" : "alice"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVaS---",
"name" : "Alice"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_V5cvVaW--_",
"name" : "Eve"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvVaS--_",
"name" : "Bob"
},
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVaS---",
"name" : "Alice"
}
]
},
{
"edges" : [
{
"_key" : "12822",
"_id" : "knows/12822",
"_from" : "persons/eve",
"_to" : "persons/alice",
"_rev" : "_V5cvVaa--_",
"vertex" : "eve"
},
{
"_key" : "12825",
"_id" : "knows/12825",
"_from" : "persons/eve",
"_to" : "persons/bob",
"_rev" : "_V5cvVaa--A",
"vertex" : "eve"
},
{
"_key" : "12819",
"_id" : "knows/12819",
"_from" : "persons/bob",
"_to" : "persons/dave",
"_rev" : "_V5cvVaa---",
"vertex" : "bob"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVaS---",
"name" : "Alice"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_V5cvVaW--_",
"name" : "Eve"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvVaS--_",
"name" : "Bob"
},
{
"_key" : "dave",
"_id" : "persons/dave",
"_rev" : "_V5cvVaW---",
"name" : "Dave"
}
]
},
{
"edges" : [
{
"_key" : "12822",
"_id" : "knows/12822",
"_from" : "persons/eve",
"_to" : "persons/alice",
"_rev" : "_V5cvVaa--_",
"vertex" : "eve"
},
{
"_key" : "12825",
"_id" : "knows/12825",
"_from" : "persons/eve",
"_to" : "persons/bob",
"_rev" : "_V5cvVaa--A",
"vertex" : "eve"
},
{
"_key" : "12816",
"_id" : "knows/12816",
"_from" : "persons/bob",
"_to" : "persons/charlie",
"_rev" : "_V5cvVaW--B",
"vertex" : "bob"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVaS---",
"name" : "Alice"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_V5cvVaW--_",
"name" : "Eve"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvVaS--_",
"name" : "Bob"
},
{
"_key" : "charlie",
"_id" : "persons/charlie",
"_rev" : "_V5cvVaS--A",
"name" : "Charlie"
}
]
},
{
"edges" : [
{
"_key" : "12812",
"_id" : "knows/12812",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_V5cvVaW--A",
"vertex" : "alice"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVaS---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvVaS--_",
"name" : "Bob"
}
]
},
{
"edges" : [
{
"_key" : "12812",
"_id" : "knows/12812",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_V5cvVaW--A",
"vertex" : "alice"
},
{
"_key" : "12825",
"_id" : "knows/12825",
"_from" : "persons/eve",
"_to" : "persons/bob",
"_rev" : "_V5cvVaa--A",
"vertex" : "eve"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVaS---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvVaS--_",
"name" : "Bob"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_V5cvVaW--_",
"name" : "Eve"
}
]
},
{
"edges" : [
{
"_key" : "12812",
"_id" : "knows/12812",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_V5cvVaW--A",
"vertex" : "alice"
},
{
"_key" : "12825",
"_id" : "knows/12825",
"_from" : "persons/eve",
"_to" : "persons/bob",
"_rev" : "_V5cvVaa--A",
"vertex" : "eve"
},
{
"_key" : "12822",
"_id" : "knows/12822",
"_from" : "persons/eve",
"_to" : "persons/alice",
"_rev" : "_V5cvVaa--_",
"vertex" : "eve"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVaS---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvVaS--_",
"name" : "Bob"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_V5cvVaW--_",
"name" : "Eve"
},
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVaS---",
"name" : "Alice"
}
]
},
{
"edges" : [
{
"_key" : "12812",
"_id" : "knows/12812",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_V5cvVaW--A",
"vertex" : "alice"
},
{
"_key" : "12819",
"_id" : "knows/12819",
"_from" : "persons/bob",
"_to" : "persons/dave",
"_rev" : "_V5cvVaa---",
"vertex" : "bob"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVaS---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvVaS--_",
"name" : "Bob"
},
{
"_key" : "dave",
"_id" : "persons/dave",
"_rev" : "_V5cvVaW---",
"name" : "Dave"
}
]
},
{
"edges" : [
{
"_key" : "12812",
"_id" : "knows/12812",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_V5cvVaW--A",
"vertex" : "alice"
},
{
"_key" : "12816",
"_id" : "knows/12816",
"_from" : "persons/bob",
"_to" : "persons/charlie",
"_rev" : "_V5cvVaW--B",
"vertex" : "bob"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVaS---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvVaS--_",
"name" : "Bob"
},
{
"_key" : "charlie",
"_id" : "persons/charlie",
"_rev" : "_V5cvVaS--A",
"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" : "_V5cvVkG---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvVkG--_",
"name" : "Bob"
},
{
"_key" : "charlie",
"_id" : "persons/charlie",
"_rev" : "_V5cvVkG--A",
"name" : "Charlie"
},
{
"_key" : "dave",
"_id" : "persons/dave",
"_rev" : "_V5cvVkK---",
"name" : "Dave"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_V5cvVkK--_",
"name" : "Eve"
},
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVkG---",
"name" : "Alice"
}
],
"paths" : [
{
"edges" : [ ],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVkG---",
"name" : "Alice"
}
]
},
{
"edges" : [
{
"_key" : "13020",
"_id" : "knows/13020",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_V5cvVkK--A",
"vertex" : "alice"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVkG---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvVkG--_",
"name" : "Bob"
}
]
},
{
"edges" : [
{
"_key" : "13020",
"_id" : "knows/13020",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_V5cvVkK--A",
"vertex" : "alice"
},
{
"_key" : "13024",
"_id" : "knows/13024",
"_from" : "persons/bob",
"_to" : "persons/charlie",
"_rev" : "_V5cvVkK--B",
"vertex" : "bob"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVkG---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvVkG--_",
"name" : "Bob"
},
{
"_key" : "charlie",
"_id" : "persons/charlie",
"_rev" : "_V5cvVkG--A",
"name" : "Charlie"
}
]
},
{
"edges" : [
{
"_key" : "13020",
"_id" : "knows/13020",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_V5cvVkK--A",
"vertex" : "alice"
},
{
"_key" : "13027",
"_id" : "knows/13027",
"_from" : "persons/bob",
"_to" : "persons/dave",
"_rev" : "_V5cvVkK--C",
"vertex" : "bob"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVkG---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvVkG--_",
"name" : "Bob"
},
{
"_key" : "dave",
"_id" : "persons/dave",
"_rev" : "_V5cvVkK---",
"name" : "Dave"
}
]
},
{
"edges" : [
{
"_key" : "13020",
"_id" : "knows/13020",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_V5cvVkK--A",
"vertex" : "alice"
},
{
"_key" : "13033",
"_id" : "knows/13033",
"_from" : "persons/eve",
"_to" : "persons/bob",
"_rev" : "_V5cvVkO--_",
"vertex" : "eve"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVkG---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvVkG--_",
"name" : "Bob"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_V5cvVkK--_",
"name" : "Eve"
}
]
},
{
"edges" : [
{
"_key" : "13020",
"_id" : "knows/13020",
"_from" : "persons/alice",
"_to" : "persons/bob",
"_rev" : "_V5cvVkK--A",
"vertex" : "alice"
},
{
"_key" : "13033",
"_id" : "knows/13033",
"_from" : "persons/eve",
"_to" : "persons/bob",
"_rev" : "_V5cvVkO--_",
"vertex" : "eve"
},
{
"_key" : "13030",
"_id" : "knows/13030",
"_from" : "persons/eve",
"_to" : "persons/alice",
"_rev" : "_V5cvVkO---",
"vertex" : "eve"
}
],
"vertices" : [
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVkG---",
"name" : "Alice"
},
{
"_key" : "bob",
"_id" : "persons/bob",
"_rev" : "_V5cvVkG--_",
"name" : "Bob"
},
{
"_key" : "eve",
"_id" : "persons/eve",
"_rev" : "_V5cvVkK--_",
"name" : "Eve"
},
{
"_key" : "alice",
"_id" : "persons/alice",
"_rev" : "_V5cvVkG---",
"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: