Graph Management

This chapter describes the javascript interface for creating and modifying named graphs.

Edge Definitions

An edge definition is always a directed relation of a graph. Each graph can have arbitrary many relations defined within the edge definitions array.

Initialize the List

Create a list of edge definitions to construct a graph:

graph_module._edgeDefinitions(relation1, relation2, ..., relationN)

  • relation (object, optional): An object representing a definition of one relation in the graph

The list of edge definitions of a graph can be managed by the graph module itself. This function is the entry point for the management and will return the correct list.

Examples

arangosh> var graph_module = require("@arangodb/general-graph");
arangosh> directed_relation = graph_module._relation("lives_in", "user", "city");
arangosh> undirected_relation = graph_module._relation("knows", "user", "user");
arangosh> edgedefinitions = graph_module._edgeDefinitions(directed_relation, undirected_relation);
Show execution results
{ 
  "collection" : "lives_in", 
  "from" : [ 
    "user" 
  ], 
  "to" : [ 
    "city" 
  ] 
}
{ 
  "collection" : "knows", 
  "from" : [ 
    "user" 
  ], 
  "to" : [ 
    "user" 
  ] 
}
[ 
  { 
    "collection" : "lives_in", 
    "from" : [ 
      "user" 
    ], 
    "to" : [ 
      "city" 
    ] 
  }, 
  { 
    "collection" : "knows", 
    "from" : [ 
      "user" 
    ], 
    "to" : [ 
      "user" 
    ] 
  } 
]
Hide execution results

Extend the List

Extend the list of edge definitions to construct a graph:

graph_module._extendEdgeDefinitions(edgeDefinitions, relation1, relation2, ..., relationN)

  • edgeDefinitions (array): A list of relation definition objects.
  • relationX (object): An object representing a definition of one relation in the graph

In order to add more edge definitions to the graph before creating this function can be used to add more definitions to the initial list.

Examples

arangosh> var graph_module = require("@arangodb/general-graph");
arangosh> directed_relation = graph_module._relation("lives_in", "user", "city");
arangosh> undirected_relation = graph_module._relation("knows", "user", "user");
arangosh> edgedefinitions = graph_module._edgeDefinitions(directed_relation);
arangosh> edgedefinitions = graph_module._extendEdgeDefinitions(undirected_relation);
Show execution results
{ 
  "collection" : "lives_in", 
  "from" : [ 
    "user" 
  ], 
  "to" : [ 
    "city" 
  ] 
}
{ 
  "collection" : "knows", 
  "from" : [ 
    "user" 
  ], 
  "to" : [ 
    "user" 
  ] 
}
[ 
  { 
    "collection" : "lives_in", 
    "from" : [ 
      "user" 
    ], 
    "to" : [ 
      "city" 
    ] 
  } 
]
Hide execution results

Relation

Define a directed relation:

graph_module._relation(relationName, fromVertexCollections, toVertexCollections)

  • relationName (string): The name of the edge collection where the edges should be stored. Will be created if it does not yet exist.
  • fromVertexCollections (string|array): One or a list of collection names. Source vertices for the edges have to be stored in these collections. Collections will be created if they do not exist.
  • toVertexCollections (string|array): One or a list of collection names. Target vertices for the edges have to be stored in these collections. Collections will be created if they do not exist.

The relationName defines the name of this relation and references to the underlying edge collection. The fromVertexCollections is an Array of document collections holding the start vertices. The toVertexCollections is an array of document collections holding the target vertices. Relations are only allowed in the direction from any collection in fromVertexCollections to any collection in toVertexCollections.

Examples

arangosh> var graph_module = require("@arangodb/general-graph");
arangosh> graph_module._relation("has_bought", ["Customer", "Company"], ["Groceries", "Electronics"]);
Show execution results
{ 
  "collection" : "has_bought", 
  "from" : [ 
    "Customer", 
    "Company" 
  ], 
  "to" : [ 
    "Groceries", 
    "Electronics" 
  ] 
}
Hide execution results
arangosh> var graph_module = require("@arangodb/general-graph");
arangosh> graph_module._relation("has_bought", "Customer", "Product");
Show execution results
{ 
  "collection" : "has_bought", 
  "from" : [ 
    "Customer" 
  ], 
  "to" : [ 
    "Product" 
  ] 
}
Hide execution results

Create a Graph

graph_module._create(graphName, edgeDefinitions, orphanCollections)

  • graphName (string): Unique identifier of the graph
  • edgeDefinitions (array, optional): List of relation definition objects
  • orphanCollections (array, optional): List of additional vertex collection names

The creation of a graph requires the name of the graph and a definition of its edges.

For every type of edge definition a convenience method exists that can be used to create a graph. Optionally a list of vertex collections can be added, which are not used in any edge definition. These collections are referred to as orphan collections within this chapter. All collections used within the creation process are created if they do not exist.

Examples

Create an empty graph, edge definitions can be added at runtime:

arangosh> var graph_module = require("@arangodb/general-graph");
arangosh> graph = graph_module._create("myGraph");
Show execution results
{[Graph] 
}
Hide execution results

Create a graph using an edge collection edges and a single vertex collection vertices:

arangosh> var graph_module = require("@arangodb/general-graph");
arangosh> var edgeDefinitions = [ { collection: "edges", "from": [ "vertices" ], "to" : [ "vertices" ] } ];
arangosh> graph = graph_module._create("myGraph", edgeDefinitions);
Show execution results
{[Graph] 
  "edges" : [ArangoCollection 75128, "edges" (type edge, status loaded)], 
  "vertices" : [ArangoCollection 75125, "vertices" (type document, status loaded)] 
}
Hide execution results

Create a graph with edge definitions and orphan collections:

arangosh> var graph_module = require("@arangodb/general-graph");
arangosh> graph = graph_module._create("myGraph",
........> [graph_module._relation("myRelation", ["male", "female"], ["male", "female"])], ["sessions"]);
Show execution results
{[Graph] 
  "myRelation" : [ArangoCollection 75012, "myRelation" (type edge, status loaded)], 
  "female" : [ArangoCollection 75006, "female" (type document, status loaded)], 
  "male" : [ArangoCollection 75009, "male" (type document, status loaded)], 
  "sessions" : [ArangoCollection 75003, "sessions" (type document, status loaded)] 
}
Hide execution results

Complete Example to Create a Graph

Example call:

arangosh> var graph_module = require("@arangodb/general-graph");
arangosh> var edgeDefinitions = graph_module._edgeDefinitions();
arangosh> graph_module._extendEdgeDefinitions(edgeDefinitions, graph_module._relation("friend_of", "Customer", "Customer"));
arangosh> graph_module._extendEdgeDefinitions(
........> edgeDefinitions, graph_module._relation(
........> "has_bought", ["Customer", "Company"], ["Groceries", "Electronics"]));
arangosh> graph_module._create("myStore", edgeDefinitions);
Show execution results
{[Graph] 
  "friend_of" : [ArangoCollection 78989, "friend_of" (type edge, status loaded)], 
  "Customer" : [ArangoCollection 78981, "Customer" (type document, status loaded)], 
  "has_bought" : [ArangoCollection 78984, "has_bought" (type edge, status loaded)], 
  "Company" : [ArangoCollection 78978, "Company" (type document, status loaded)], 
  "Electronics" : [ArangoCollection 78975, "Electronics" (type document, status loaded)], 
  "Groceries" : [ArangoCollection 78972, "Groceries" (type document, status loaded)] 
}
Hide execution results

Alternative call:

arangosh> var graph_module = require("@arangodb/general-graph");
arangosh>  var edgeDefinitions = graph_module._edgeDefinitions(
........>  graph_module._relation("friend_of", ["Customer"], ["Customer"]), graph_module._relation(
........> "has_bought", ["Customer", "Company"], ["Groceries", "Electronics"]));
arangosh> graph_module._create("myStore", edgeDefinitions);
Show execution results
{[Graph] 
  "friend_of" : [ArangoCollection 79025, "friend_of" (type edge, status loaded)], 
  "Customer" : [ArangoCollection 79017, "Customer" (type document, status loaded)], 
  "has_bought" : [ArangoCollection 79020, "has_bought" (type edge, status loaded)], 
  "Company" : [ArangoCollection 79014, "Company" (type document, status loaded)], 
  "Electronics" : [ArangoCollection 79011, "Electronics" (type document, status loaded)], 
  "Groceries" : [ArangoCollection 79008, "Groceries" (type document, status loaded)] 
}
Hide execution results

List available Graphs

List all graphs:

graph_module._list()

Lists all graph names stored in this database.

Examples

arangosh> var graph_module = require("@arangodb/general-graph");
arangosh> graph_module._list();
Show execution results
[ ]
Hide execution results

Load a Graph

Get a graph by its name:

graph_module._graph(graphName)

  • graphName (string): Unique identifier of the graph

Examples

arangosh> var graph_module = require("@arangodb/general-graph");
arangosh> graph = graph_module._graph("social");
Show execution results
{[Graph] 
  "relation" : [ArangoCollection 75566, "relation" (type edge, status loaded)], 
  "female" : [ArangoCollection 75556, "female" (type document, status loaded)], 
  "male" : [ArangoCollection 75561, "male" (type document, status loaded)] 
}
Hide execution results

Remove a Graph

Drop a Graph by its name:

graph_module._drop(graphName, dropCollections)

  • graphName (string): Unique identifier of the graph
  • dropCollections (bool, optional): Define if collections should be dropped (default: false)

This can drop all collections contained in the graph as long as they are not used within other graphs. To drop the collections only belonging to this graph, the optional parameter drop-collections has to be set to true.

Examples

Drop a graph and keep collections:

arangosh> var graph_module = require("@arangodb/general-graph");
arangosh> graph_module._drop("social");
arangosh> db._collection("female");
arangosh> db._collection("male");
arangosh> db._collection("relation");
Show execution results
[ArangoCollection 75187, "female" (type document, status loaded)]
[ArangoCollection 75192, "male" (type document, status loaded)]
[ArangoCollection 75197, "relation" (type edge, status loaded)]
Hide execution results
arangosh> var graph_module = require("@arangodb/general-graph");
arangosh> graph_module._drop("social", true);
arangosh> db._collection("female");
arangosh> db._collection("male");
arangosh> db._collection("relation");
Show execution results
null
null
null
Hide execution results

Modify a Graph definition at runtime

After you have created an graph its definition is not immutable. You can still add, delete or modify edge definitions and vertex collections.

Extend the Edge Definitions

Add another edge definition to the graph:

graph._extendEdgeDefinitions(edgeDefinition)

  • edgeDefinition (object): The relation definition to extend the graph

Extends the edge definitions of a graph. If an orphan collection is used in this edge definition, it will be removed from the orphanage. If the edge collection of the edge definition to add is already used in the graph or used in a different graph with different from and/or to collections an error is thrown.

Examples

arangosh> var graph_module = require("@arangodb/general-graph")
arangosh> var ed1 = graph_module._relation("myEC1", ["myVC1"], ["myVC2"]);
arangosh> var ed2 = graph_module._relation("myEC2", ["myVC1"], ["myVC3"]);
arangosh> var graph = graph_module._create("myGraph", [ed1]);
arangosh> graph._extendEdgeDefinitions(ed2);
Show execution results

        
Hide execution results

Modify an Edge Definition

Modify a relation definition:

graph_module._editEdgeDefinitions(edgeDefinition)

  • edgeDefinition (object): The edge definition to replace the existing edge definition with the same attribute collection.

Edits one relation definition of a graph. The edge definition used as argument will replace the existing edge definition of the graph which has the same collection. Vertex Collections of the replaced edge definition that are not used in the new definition will transform to an orphan. Orphans that are used in this new edge definition will be deleted from the list of orphans. Other graphs with the same edge definition will be modified, too.

Examples

arangosh> var graph_module = require("@arangodb/general-graph")
arangosh> var original = graph_module._relation("myEC1", ["myVC1"], ["myVC2"]);
arangosh> var modified = graph_module._relation("myEC1", ["myVC2"], ["myVC3"]);
arangosh> var graph = graph_module._create("myGraph", [original]);
arangosh> graph._editEdgeDefinitions(modified);
Show execution results

        
Hide execution results

Delete an Edge Definition

Delete one relation definition:

graph_module._deleteEdgeDefinition(edgeCollectionName, dropCollection)

  • edgeCollectionName (string): Name of edge collection in the relation definition.
  • dropCollection (bool, optional): Define if the edge collection should be dropped. Default: false

Deletes a relation definition defined by the edge collection of a graph. If the collections defined in the edge definition (collection, from, to) are not used in another edge definition of the graph, they will be moved to the orphanage.

Examples

Remove an edge definition but keep the edge collection:

arangosh> var graph_module = require("@arangodb/general-graph")
arangosh> var ed1 = graph_module._relation("myEC1", ["myVC1"], ["myVC2"]);
arangosh> var ed2 = graph_module._relation("myEC2", ["myVC1"], ["myVC3"]);
arangosh> var graph = graph_module._create("myGraph", [ed1, ed2]);
arangosh> graph._deleteEdgeDefinition("myEC1");
arangosh> db._collection("myEC1");
Show execution results
[ArangoCollection 78740, "myEC1" (type edge, status loaded)]
Hide execution results

Remove an edge definition and drop the edge collection:

arangosh> var graph_module = require("@arangodb/general-graph")
arangosh> var ed1 = graph_module._relation("myEC1", ["myVC1"], ["myVC2"]);
arangosh> var ed2 = graph_module._relation("myEC2", ["myVC1"], ["myVC3"]);
arangosh> var graph = graph_module._create("myGraph", [ed1, ed2]);
arangosh> graph._deleteEdgeDefinition("myEC1", true);
arangosh> db._collection("myEC1");
Show execution results
null
Hide execution results

Extend Vertex Collections

Each graph can have an arbitrary amount of vertex collections, which are not part of any edge definition of the graph. These collections are called orphan collections. If the graph is extended with an edge definition using one of the orphans, it will be removed from the set of orphan collection automatically.

Add a Vertex Collection

Add a vertex collection to the graph:

graph._addVertexCollection(vertexCollectionName, createCollection)

  • vertexCollectionName (string): Name of vertex collection.
  • createCollection (bool, optional): If true the collection will be created if it does not exist. Default: true

Adds a vertex collection to the set of orphan collections of the graph. If the collection does not exist, it will be created. If it is already used by any edge definition of the graph, an error will be thrown.

Examples

arangosh> var graph_module = require("@arangodb/general-graph");
arangosh> var ed1 = graph_module._relation("myEC1", ["myVC1"], ["myVC2"]);
arangosh> var graph = graph_module._create("myGraph", [ed1]);
arangosh> graph._addVertexCollection("myVC3", true);
Show execution results

        
Hide execution results

Get the Orphaned Collections

Get all orphan collections:

graph._orphanCollections()

Returns all vertex collections of the graph that are not used in any edge definition.

Examples

arangosh> var graph_module = require("@arangodb/general-graph")
arangosh> var ed1 = graph_module._relation("myEC1", ["myVC1"], ["myVC2"]);
arangosh> var graph = graph_module._create("myGraph", [ed1]);
arangosh> graph._addVertexCollection("myVC3", true);
arangosh> graph._orphanCollections();
Show execution results
[ 
  "myVC3" 
]
Hide execution results

Remove a Vertex Collection

Remove a vertex collection from the graph:

graph._removeVertexCollection(vertexCollectionName, dropCollection)

  • vertexCollectionName (string): Name of vertex collection.
  • dropCollection (bool, optional): If true the collection will be dropped if it is not used in any other graph. Default: false

Removes a vertex collection from the graph. Only collections not used in any relation definition can be removed. Optionally the collection can be deleted, if it is not used in any other graph.

Examples

arangosh> var graph_module = require("@arangodb/general-graph")
arangosh> var ed1 = graph_module._relation("myEC1", ["myVC1"], ["myVC2"]);
arangosh> var graph = graph_module._create("myGraph", [ed1]);
arangosh> graph._addVertexCollection("myVC3", true);
arangosh> graph._addVertexCollection("myVC4", true);
arangosh> graph._orphanCollections();
arangosh> graph._removeVertexCollection("myVC3");
arangosh> graph._orphanCollections();
Show execution results
[ 
  "myVC3", 
  "myVC4" 
]
[ 
  "myVC4" 
]
Hide execution results

Manipulating Vertices

Save a Vertex

Create a new vertex in vertexCollectionName:

graph.vertexCollectionName.save(data)

  • data (object): JSON data of vertex.

Examples

arangosh> var examples = require("@arangodb/graph-examples/example-graph.js");
arangosh> var graph = examples.loadGraph("social");
arangosh> graph.male.save({name: "Floyd", _key: "floyd"});
Show execution results
{ 
  "_id" : "male/floyd", 
  "_key" : "floyd", 
  "_rev" : "_ZiYaeEa--A" 
}
Hide execution results

Replace a Vertex

Replaces the data of a vertex in collection vertexCollectionName:

graph.vertexCollectionName.replace(vertexId, data, options)

  • vertexId (string): _id attribute of the vertex
  • data (object): JSON data of vertex.
  • options (object, optional): See collection documentation

Examples

arangosh> var examples = require("@arangodb/graph-examples/example-graph.js");
arangosh> var graph = examples.loadGraph("social");
arangosh> graph.male.save({neym: "Jon", _key: "john"});
arangosh> graph.male.replace("male/john", {name: "John"});
Show execution results
{ 
  "_id" : "male/john", 
  "_key" : "john", 
  "_rev" : "_ZiYaeDi--C" 
}
{ 
  "_id" : "male/john", 
  "_key" : "john", 
  "_rev" : "_ZiYaeDm--_", 
  "_oldRev" : "_ZiYaeDi--C" 
}
Hide execution results

Update a Vertex

Updates the data of a vertex in collection vertexCollectionName

graph.vertexCollectionName.update(vertexId, data, options)

  • vertexId (string): _id attribute of the vertex
  • data (object): JSON data of vertex.
  • options (object, optional): See collection documentation

Examples

arangosh> var examples = require("@arangodb/graph-examples/example-graph.js");
arangosh> var graph = examples.loadGraph("social");
arangosh> graph.female.save({name: "Lynda", _key: "linda"});
arangosh> graph.female.update("female/linda", {name: "Linda", _key: "linda"});
Show execution results
{ 
  "_id" : "female/linda", 
  "_key" : "linda", 
  "_rev" : "_ZiYaeFO--A" 
}
{ 
  "_id" : "female/linda", 
  "_key" : "linda", 
  "_rev" : "_ZiYaeFS--_", 
  "_oldRev" : "_ZiYaeFO--A" 
}
Hide execution results

Remove a Vertex

Removes a vertex in collection vertexCollectionName

graph.vertexCollectionName.remove(vertexId, options)

Additionally removes all ingoing and outgoing edges of the vertex recursively (see edge remove).

Examples

arangosh> var examples = require("@arangodb/graph-examples/example-graph.js");
arangosh> var graph = examples.loadGraph("social");
arangosh> graph.male.save({name: "Kermit", _key: "kermit"});
arangosh> db._exists("male/kermit")
arangosh> graph.male.remove("male/kermit")
arangosh> db._exists("male/kermit")
Show execution results
{ 
  "_id" : "male/kermit", 
  "_key" : "kermit", 
  "_rev" : "_ZiYaeCa--C" 
}
true
true
false
Hide execution results

Manipulating Edges

Save a new Edge

Creates an edge from vertex from to vertex to in collection edgeCollectionName

graph.edgeCollectionName.save(from, to, data, options)

  • from (string): _id attribute of the source vertex
  • to (string): _id attribute of the target vertex
  • data (object, optional): JSON data of the edge
  • options (object, optional): See collection documentation

Examples

arangosh> var examples = require("@arangodb/graph-examples/example-graph.js");
arangosh> var graph = examples.loadGraph("social");
arangosh> graph.relation.save("male/bob", "female/alice", {type: "married", _key: "bobAndAlice"});
Show execution results
{ 
  "_id" : "relation/bobAndAlice", 
  "_key" : "bobAndAlice", 
  "_rev" : "_ZiYadCu--A" 
}
Hide execution results

If the collections of from and to are not defined in an edge definition of the graph, the edge will not be stored.

arangosh> var examples = require("@arangodb/graph-examples/example-graph.js");
arangosh> var graph = examples.loadGraph("social");
arangosh> graph.relation.save(
........>  "relation/aliceAndBob",
........>   "female/alice",
........> {type: "married", _key: "bobAndAlice"});
Show execution results
[ArangoError 1906: invalid edge between relation/aliceAndBob and female/alice. Doesn't conform to any edge definition]
Hide execution results

Replace an Edge

Replaces the data of an edge in collection edgeCollectionName. Note that _from and _to are mandatory.

graph.edgeCollectionName.replace(edgeId, data, options)

  • edgeId (string): _id attribute of the edge
  • data (object, optional): JSON data of the edge
  • options (object, optional): See collection documentation

Examples

arangosh> var examples = require("@arangodb/graph-examples/example-graph.js");
arangosh> var graph = examples.loadGraph("social");
arangosh> graph.relation.save("female/alice", "female/diana", {typo: "nose", _key: "aliceAndDiana"});
arangosh> graph.relation.replace("relation/aliceAndDiana", {type: "knows", _from: "female/alice", _to: "female/diana"});
Show execution results
{ 
  "_id" : "relation/aliceAndDiana", 
  "_key" : "aliceAndDiana", 
  "_rev" : "_ZiYadB2--A" 
}
{ 
  "_id" : "relation/aliceAndDiana", 
  "_key" : "aliceAndDiana", 
  "_rev" : "_ZiYadB2--D", 
  "_oldRev" : "_ZiYadB2--A" 
}
Hide execution results

Update an Edge

Updates the data of an edge in collection edgeCollectionName

graph.edgeCollectionName.update(edgeId, data, options)

  • edgeId (string): _id attribute of the edge
  • data (object, optional): JSON data of the edge
  • options (object, optional): See collection documentation

Examples

arangosh> var examples = require("@arangodb/graph-examples/example-graph.js");
arangosh> var graph = examples.loadGraph("social");
arangosh> graph.relation.save("female/alice", "female/diana", {type: "knows", _key: "aliceAndDiana"});
arangosh> graph.relation.update("relation/aliceAndDiana", {type: "quarreled", _key: "aliceAndDiana"});
Show execution results
{ 
  "_id" : "relation/aliceAndDiana", 
  "_key" : "aliceAndDiana", 
  "_rev" : "_ZiYadES--C" 
}
{ 
  "_id" : "relation/aliceAndDiana", 
  "_key" : "aliceAndDiana", 
  "_rev" : "_ZiYadEW--_", 
  "_oldRev" : "_ZiYadES--C" 
}
Hide execution results

Remove an Edge

Removes an edge in collection edgeCollectionName

graph.edgeCollectionName.remove(edgeId, options)

If this edge is used as a vertex by another edge, the other edge will be removed (recursively).

Examples

arangosh> var examples = require("@arangodb/graph-examples/example-graph.js");
arangosh> var graph = examples.loadGraph("social");
arangosh> graph.relation.save("female/alice", "female/diana", {_key: "aliceAndDiana"});
arangosh> db._exists("relation/aliceAndDiana")
arangosh> graph.relation.remove("relation/aliceAndDiana")
arangosh> db._exists("relation/aliceAndDiana")
Show execution results
{ 
  "_id" : "relation/aliceAndDiana", 
  "_key" : "aliceAndDiana", 
  "_rev" : "_ZiYadAy--A" 
}
true
true
false
Hide execution results