SatelliteGraph Management

This chapter describes the satellite-graph module, the JavaScript API to create and modify your SatelliteGraphs in ArangoDB.

To generally understand the concept of the graph modules please see General Graph Management first. In the following only the overloaded functionality is described. Everything else works alike in both modules.

Create a Graph

In contrast to General Graphs and SmartGraphs, you do not need to take care of the sharding and replication properties. The properties distributeShardsLike, replicationFactor and numberOfShards will be set automatically (also see prototype collection).

The format of the relations is identical.

var graph_module = require("@arangodb/satellite-graph");
graph_module._create(graphName, edgeDefinitions, orphanCollections);
  • graphName (string): Unique identifier of the graph
  • edgeDefinitions (array): List of relation definition objects, may be empty
  • orphanCollections (array): List of additional vertex collection names, may be empty

Both edgeDefinitions and orphanCollections are optional. You can also add collections later, after the SatelliteGraph creation took place.

The edgeDefinitions can be created using the convenience method _relation() known from the general-graph module, which is also available here.

orphanCollections again is just a list of additional vertex collections which are not yet connected via edges but should follow the same sharding to be connected later on.

All collections used within the creation process are newly created or, if already available, checked against the collection properties. The process will fail if one of them already exists, unless they have the correct sharding already. All newly created collections will immediately be dropped again in the failure case.

Examples

Create a graph without relations. Edge definitions can be added later:

arangosh> var satelliteGraphModule = require("@arangodb/satellite-graph");
arangosh> var graph = satelliteGraphModule._create("satelliteGraph");
arangosh> satelliteGraphModule._graph("satelliteGraph");
Show execution results
Hide execution results
{[SatelliteGraph] 
}

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

arangosh> var graph_module = require("@arangodb/satellite-graph");
arangosh> var edgeDefinitions = [ graph_module._relation("edges", "vertices", "vertices") ];
arangosh> var graph = graph_module._create("myGraph", edgeDefinitions);
arangosh> graph_module._graph("myGraph");
Show execution results
Hide execution results
{[SatelliteGraph] 
  "edges" : [ArangoCollection 4000114, "edges" (type edge, status loaded)], 
  "vertices" : [ArangoCollection 4000112, "vertices" (type document, status loaded)] 
}

Create a graph with edge definitions and orphan collections:

arangosh> var graph_module = require("@arangodb/satellite-graph");
arangosh> var edgeDefinitions = [ graph_module._relation("myRelation", ["male", "female"], ["male", "female"]) ];
arangosh> var graph = graph_module._create("myGraph", edgeDefinitions, ["sessions"]);
arangosh> graph_module._graph("myGraph");
Show execution results
Hide execution results
{[SatelliteGraph] 
  "myRelation" : [ArangoCollection 4000120, "myRelation" (type edge, status loaded)], 
  "female" : [ArangoCollection 4000118, "female" (type document, status loaded)], 
  "male" : [ArangoCollection 4000119, "male" (type document, status loaded)], 
  "sessions" : [ArangoCollection 4000116, "sessions" (type document, status loaded)] 
}

Modify a SatelliteGraph definition at runtime

After you have created a SatelliteGraph its definition is not immutable. You can still add or remove relations. This is again identical to General Graphs.

However there is one important difference: You can only add collections that either do not exist, or that have been created with the correct collection properties (either through the graph module or manually).

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.

In most cases this function works identically to the General Graph one. But there is one special case: The first vertex collection added to the graph (either orphan or a vertex collection within a relation) defines the sharding for all collections within the graph. They have their distributeShardsLike attribute set to the name of the prototype collection This collection cannot be dropped as long as other collections follow its sharding (i.e. they need to be dropped first).

Examples

Create a SatelliteGraph and list its orphan collections:

arangosh> var graph_module = require("@arangodb/satellite-graph");
arangosh> var relation = graph_module._relation("edges", "vertices", "vertices");
arangosh> var graph = graph_module._create("myGraph", [relation], ["other"]);
arangosh> graph._orphanCollections();
Show execution results
Hide execution results
[ 
  "other" 
]

Remove the orphan collection from the SatelliteGraph and drop the collection:

arangosh> graph._removeVertexCollection("other", true);
arangosh> graph_module._graph("myGraph");
Show execution results
Hide execution results
{[SatelliteGraph] 
  "edges" : [ArangoCollection 4000133, "edges" (type edge, status loaded)], 
  "vertices" : [ArangoCollection 4000130, "vertices" (type document, status loaded)] 
}

Attempting to remove a non-orphan collection results in an error:

arangosh> graph._removeVertexCollection("vertices");
Show execution results
Hide execution results
[ArangoError 1928: collection is not in list of orphan collections]

You cannot drop the prototype collection (vertices) as long as it defines the sharding for other collections (edges).

arangosh> var graph_module = require("@arangodb/satellite-graph");
arangosh> var relation = graph_module._relation("edges", "vertices", "vertices");
arangosh> var graph = graph_module._create("myGraph", [relation], []);
arangosh> graph._deleteEdgeDefinition("edges");
arangosh> graph._removeVertexCollection("vertices");
arangosh> db._drop("vertices");
Show execution results
Hide execution results
[ArangoError 1485: Collection 'vertices' must not be dropped while 'edges' has distributeShardsLike set to 'vertices'.]

You may drop the complete graph, but remember to drop collections that you might have removed from the graph beforehand, as they will not be part of the graph definition anymore and thus not be dropped for you. Alternatively, you can truncate the graph if you just want to get rid of the data.

arangosh> var graph_module = require("@arangodb/satellite-graph");
arangosh> var relation = graph_module._relation("edges", "vertices", "vertices");
arangosh> var graph = graph_module._create("myGraph", [relation], []);
arangosh> graph._deleteEdgeDefinition("edges");
arangosh> graph._removeVertexCollection("vertices");
arangosh> graph_module._drop("myGraph", true); // does not drop any collections
arangosh> db._drop("edges"); // drop before sharding-defining 'vertices' collection
arangosh> db._drop("vertices");
Show execution results
Hide execution results

    

Remove an edge collection

Delete an edge definition from the graph:

graph._deleteEdgeDefinition(edgeCollectionName, dropCollection)

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

Examples

Create a SatelliteGraph, then delete the edge definition and drop the edge collection:

arangosh> var graph_module = require("@arangodb/satellite-graph");
arangosh> var relation = graph_module._relation("edges", "vertices", "vertices");
arangosh> var graph = graph_module._create("myGraph", [relation], []);
arangosh> graph._deleteEdgeDefinition("edges", true);
arangosh> graph_module._graph("myGraph");
Show execution results
Hide execution results
{[SatelliteGraph] 
  "vertices" : [ArangoCollection 4000148, "vertices" (type document, status loaded)] 
}

It is allowed to remove the vertex collection vertices if it is not used in any relation (i.e. after the deletion of the edge definition):

arangosh> graph._deleteEdgeDefinition("edges");
arangosh> graph._removeVertexCollection("vertices");
Show execution results
Hide execution results

    

Keep in mind that you can not drop the vertices collection until no other collection references it anymore (distributeShardsLike collection property).

Remove a Graph

Remove a SatelliteGraph:

graph_module._drop(graphName, dropCollections)

  • graphName (string): Name of the Graph.
  • dropCollections (bool, optional): Define if collections should be dropped. Default: false.

Examples

Delete a SatelliteGraph and drop its collections:

arangosh> graph_module._drop("myGraph", true);
Show execution results
Hide execution results

    

Note that removing a graph with the option to drop the collections fails if you removed collections from the graph but did not drop these collections. This is because their distributeShardsLike attribute still references collections that are part of the graph. Dropping collections while others point to them in this way is not allowed. Make sure to drop the referencing collections first.

arangosh> graph._removeVertexCollection("other");
arangosh> graph_module._drop("myGraph", true);
Show execution results
Hide execution results
[ArangoError 1485: Collection 'vertices' must not be dropped while 'other' has distributeShardsLike set to 'vertices'.]