Class Graph

Name of the graph.

Adds an edge definition to this graph.

Example

const db = new Database();
const graph = db.graph("some-graph");
await graph.addEdgeDefinition({
  collection: "edges",
  from: ["start-vertices"],
  to: ["end-vertices"],
});
// The edge definition has been added to the graph
Copy

Adds the given collection to this graph as a vertex collection.

Example

const db = new Database();
const graph = db.graph("some-graph");
await graph.addVertexCollection("more-vertices");
// The collection "more-vertices" has been added to the graph
const extra = db.collection("extra-vertices");
await graph.addVertexCollection(extra);
// The collection "extra-vertices" has been added to the graph
Copy

Creates a graph with the given edgeDefinitions and options for this graph's name.

Example

const db = new Database();
const graph = db.graph("some-graph");
const info = await graph.create([
  {
    collection: "edges",
    from: ["start-vertices"],
    to: ["end-vertices"],
  },
]);
// graph now exists
Copy

Deletes the graph from the database.

Example

const db = new Database();
const graph = db.graph("some-graph");
await graph.drop();
// the graph "some-graph" no longer exists
Copy

Returns a graph.GraphEdgeCollection instance for the given collection name representing the collection in this graph.

Example

const db = new Database();
const graph = db.graph("some-graph");
const info = await graph.create([
  {
    collection: "edges",
    from: ["start-vertices"],
    to: ["end-vertices"],
  },
]);
const graphEdgeCollection = graph.edgeCollection("edges");
// Access the underlying EdgeCollection API:
const edgeCollection = graphEdgeCollection.collection;
Copy

Fetches all edge collections of this graph from the database and returns an array of graph.GraphEdgeCollection instances.

See also graph.Graph#listEdgeCollections.

Example

const db = new Database();
const graph = db.graph("some-graph");
const info = await graph.create([
  {
    collection: "edges",
    from: ["start-vertices"],
    to: ["end-vertices"],
  },
]);
const graphEdgeCollections = await graph.edgeCollections();
for (const collection of graphEdgeCollection) {
  console.log(collection.name);
  // "edges"
}
Copy

Checks whether the graph exists.

Example

const db = new Database();
const graph = db.graph("some-graph");
const result = await graph.exists();
// result indicates whether the graph exists
Copy

Retrieves general information about the graph.

Example

const db = new Database();
const graph = db.graph("some-graph");
const data = await graph.get();
// data contains general information about the graph
Copy

Fetches all edge collections of this graph from the database and returns an array of their names.

See also graph.Graph#edgeCollections.

Example

const db = new Database();
const graph = db.graph("some-graph");
const info = await graph.create([
  {
    collection: "edges",
    from: ["start-vertices"],
    to: ["end-vertices"],
  },
]);
const edgeCollectionNames = await graph.listEdgeCollections();
// ["edges"]
Copy

Fetches all vertex collections of this graph from the database and returns an array of their names.

See also graph.Graph#vertexCollections.

Example

const db = new Database();
const graph = db.graph("some-graph");
const info = await graph.create([
  {
    collection: "edges",
    from: ["start-vertices"],
    to: ["end-vertices"],
  },
]);
const vertexCollectionNames = await graph.listVertexCollections();
// ["start-vertices", "end-vertices"]
Copy

Removes the edge definition for the given edge collection from this graph.

Example

const db = new Database();
const graph = db.graph("some-graph");
const info = await graph.create([
  {
    collection: "edges",
    from: ["start-vertices"],
    to: ["end-vertices"],
  },
]);
await graph.removeEdgeDefinition("edges");
// The edge definition for "edges" has been replaced
Copy

Removes the given collection from this graph as a vertex collection.

Example

const db = new Database();
const graph = db.graph("some-graph");
const info = await graph.create([
  {
    collection: "edges",
    from: ["start-vertices"],
    to: ["end-vertices"],
  },
]);
await graph.removeVertexCollection("start-vertices");
// The collection "start-vertices" is no longer part of the graph.
Copy

Replaces an edge definition in this graph. The existing edge definition for the given edge collection will be overwritten.

Example

const db = new Database();
const graph = db.graph("some-graph");
const info = await graph.create([
  {
    collection: "edges",
    from: ["start-vertices"],
    to: ["end-vertices"],
  },
]);
await graph.replaceEdgeDefinition({
  collection: "edges",
  from: ["start-vertices"],
  to: ["other-vertices"],
});
// The edge definition for "edges" has been replaced
Copy

Replaces an edge definition in this graph. The existing edge definition for the given edge collection will be overwritten.

Example

const db = new Database();
const graph = db.graph("some-graph");
const info = await graph.create([
  {
    collection: "edges",
    from: ["start-vertices"],
    to: ["end-vertices"],
  },
]);
await graph.replaceEdgeDefinition("edges", {
  collection: "edges",
  from: ["start-vertices"],
  to: ["other-vertices"],
});
// The edge definition for "edges" has been replaced
Copy

Returns a graph.GraphVertexCollection instance for the given collection name representing the collection in this graph.

Fetches all vertex collections of this graph from the database and returns an array of graph.GraphVertexCollection instances.

See also graph.Graph#listVertexCollections.

Example

const db = new Database();
const graph = db.graph("some-graph");
const info = await graph.create([
  {
    collection: "edges",
    from: ["start-vertices"],
    to: ["end-vertices"],
  },
]);
const vertexCollections = await graph.vertexCollections();
for (const vertexCollection of vertexCollections) {
  console.log(vertexCollection.name);
  // "start-vertices"
  // "end-vertices"
}
Copy