ArangoDB Logo

ArangoDB v3.13 is under development and not released yet. This documentation is not final and potentially incomplete.

HTTP interface for edges

The Edge API lets you retrieve the connected edges of a single node, optionally restricted to incoming or outgoing edges

You can use the general Document API to create, read, modify, and delete edge documents. The only difference to working with node documents is that the _from and _to attributes are mandatory and must contain document identifiers.

The Edge API is useful if you want to look up the inbound and outbound edges of a node with low overhead. You can also retrieve edges with AQL queries, but queries need to be parsed and planned, and thus have an overhead. On the other hand, AQL is far more powerful, letting you perform graph traversals, for instance.

Addresses of edges

Edges are a special variation of documents and you can access them like any document. See Addresses of documents for details.

Get inbound and outbound edges

GET /_db/{database-name}/_api/edges/{collection}
Returns an array of edges starting or ending in the node identified by vertex.
Path Parameters

  • The name of the database.

  • The name of the edge collection you want to retrieve edges from.

Query Parameters

  • The document identifier of the start node.

  • Possible values: "any", "in", "out"

    • "in": Return edges that reference the vertex in the _to attribute.
    • "out": Return edges that reference the vertex in the _from attribute.
    • "any": Return edges that reference the vertex in the _from or _to attribute.

HTTP Headers

  • Set this header to true to allow the Coordinator to ask any shard replica for the data, not only the shard leader. This may result in “dirty reads”.

Responses

  • is returned if the edge collection was found and edges were retrieved.

  • is returned if the request contains invalid parameters.

  • is returned if the edge collection was not found.

Examples

Any direction

curl --header 'accept: application/json' --dump - 'http://localhost:8529/_api/edges/edges?vertex=nodes/1'
Show output
HTTP/1.1 200 OK
content-type: application/json
cache-control: no-cache, no-store, must-revalidate, pre-check=0, post-check=0, max-age=0, s-maxage=0
connection: Keep-Alive
content-length: 642
content-security-policy: frame-ancestors 'self'; form-action 'self';
expires: 0
pragma: no-cache
server: ArangoDB
strict-transport-security: max-age=31536000 ; includeSubDomains
x-arango-queue-time-seconds: 0.000000
x-content-type-options: nosniff

{ 
  "edges" : [ 
    { 
      "_key" : "5", 
      "_id" : "edges/5", 
      "_from" : "nodes/1", 
      "_to" : "nodes/3", 
      "_rev" : "_kKbjuuy--_", 
      "$label" : "v1 -> v3" 
    }, 
    { 
      "_key" : "6", 
      "_id" : "edges/6", 
      "_from" : "nodes/2", 
      "_to" : "nodes/1", 
      "_rev" : "_kKbjuu2---", 
      "$label" : "v2 -> v1" 
    }, 
    { 
      "_key" : "7", 
      "_id" : "edges/7", 
      "_from" : "nodes/4", 
      "_to" : "nodes/1", 
      "_rev" : "_kKbjuu2--_", 
      "$label" : "v4 -> v1" 
    } 
  ], 
  "error" : false, 
  "code" : 200, 
  "stats" : { 
    "writesExecuted" : 0, 
    "writesIgnored" : 0, 
    "documentLookups" : 3, 
    "seeks" : 0, 
    "scannedFull" : 0, 
    "scannedIndex" : 3, 
    "cursorsCreated" : 2, 
    "cursorsRearmed" : 0, 
    "cacheHits" : 0, 
    "cacheMisses" : 2, 
    "filtered" : 0, 
    "httpRequests" : 0, 
    "executionTime" : 0.00034181400002353257, 
    "peakMemoryUsage" : 32768, 
    "intermediateCommits" : 0 
  } 
}

In edges

curl --header 'accept: application/json' --dump - 'http://localhost:8529/_api/edges/edges?vertex=nodes/1&direction=in'
Show output
HTTP/1.1 200 OK
content-type: application/json
cache-control: no-cache, no-store, must-revalidate, pre-check=0, post-check=0, max-age=0, s-maxage=0
connection: Keep-Alive
content-length: 534
content-security-policy: frame-ancestors 'self'; form-action 'self';
expires: 0
pragma: no-cache
server: ArangoDB
strict-transport-security: max-age=31536000 ; includeSubDomains
x-arango-queue-time-seconds: 0.000000
x-content-type-options: nosniff

{ 
  "edges" : [ 
    { 
      "_key" : "6", 
      "_id" : "edges/6", 
      "_from" : "nodes/2", 
      "_to" : "nodes/1", 
      "_rev" : "_kKbjuy---_", 
      "$label" : "v2 -> v1" 
    }, 
    { 
      "_key" : "7", 
      "_id" : "edges/7", 
      "_from" : "nodes/4", 
      "_to" : "nodes/1", 
      "_rev" : "_kKbjuyC---", 
      "$label" : "v4 -> v1" 
    } 
  ], 
  "error" : false, 
  "code" : 200, 
  "stats" : { 
    "writesExecuted" : 0, 
    "writesIgnored" : 0, 
    "documentLookups" : 2, 
    "seeks" : 0, 
    "scannedFull" : 0, 
    "scannedIndex" : 2, 
    "cursorsCreated" : 1, 
    "cursorsRearmed" : 0, 
    "cacheHits" : 0, 
    "cacheMisses" : 1, 
    "filtered" : 0, 
    "httpRequests" : 0, 
    "executionTime" : 0.00029967900002247916, 
    "peakMemoryUsage" : 0, 
    "intermediateCommits" : 0 
  } 
}

Out edges

curl --header 'accept: application/json' --dump - 'http://localhost:8529/_api/edges/edges?vertex=nodes/1&direction=out'
Show output
HTTP/1.1 200 OK
content-type: application/json
cache-control: no-cache, no-store, must-revalidate, pre-check=0, post-check=0, max-age=0, s-maxage=0
connection: Keep-Alive
content-length: 430
content-security-policy: frame-ancestors 'self'; form-action 'self';
expires: 0
pragma: no-cache
server: ArangoDB
strict-transport-security: max-age=31536000 ; includeSubDomains
x-arango-queue-time-seconds: 0.000000
x-content-type-options: nosniff

{ 
  "edges" : [ 
    { 
      "_key" : "5", 
      "_id" : "edges/5", 
      "_from" : "nodes/1", 
      "_to" : "nodes/3", 
      "_rev" : "_kKbju2m---", 
      "$label" : "v1 -> v3" 
    } 
  ], 
  "error" : false, 
  "code" : 200, 
  "stats" : { 
    "writesExecuted" : 0, 
    "writesIgnored" : 0, 
    "documentLookups" : 1, 
    "seeks" : 0, 
    "scannedFull" : 0, 
    "scannedIndex" : 1, 
    "cursorsCreated" : 1, 
    "cursorsRearmed" : 0, 
    "cacheHits" : 0, 
    "cacheMisses" : 1, 
    "filtered" : 0, 
    "httpRequests" : 0, 
    "executionTime" : 0.00021778699999686069, 
    "peakMemoryUsage" : 0, 
    "intermediateCommits" : 0 
  } 
}

On this page