Graphs

This chapter describes the general-graph module. It allows you to define a graph that is spread across several edge and document collections. This allows you to structure your models in line with your domain and group them logically in collections giving you the power to query them in the same graph queries. There is no need to include the referenced collections within the query, this module will handle it for you.

Three Steps to create a graph

• Create a graph

arangosh> var graph_module = require("@arangodb/general-graph");
arangosh> var graph = graph_module._create("myGraph");
arangosh> graph;

[ Graph myGraph EdgeDefinitions: [ ] VertexCollections: [ ] ]

• Add some vertex collections

arangosh> graph._addVertexCollection("shop");
arangosh> graph._addVertexCollection("customer");
arangosh> graph._addVertexCollection("pet");
arangosh> graph;

[ Graph myGraph EdgeDefinitions: [ ] VertexCollections: [ 
  "shop", 
  "customer", 
  "pet" 
] ]

• Define relations on the

arangosh> var rel = graph_module._relation("isCustomer", ["shop"], ["customer"]);
arangosh> graph._extendEdgeDefinitions(rel);
arangosh> graph;

[ Graph myGraph EdgeDefinitions: [ 
  "isCustomer: [shop] -> [customer]" 
] VertexCollections: [ ] ]