Class GraphEdgeCollection<T>

A collection.EdgeCollection instance for this edge collection.

The graph.Graph instance this edge collection is bound to.

Name of the collection.

Retrieves the edge matching the given key or id.

Throws an exception when passed a edge or _id from a different collection, or if the edge does not exist.

Example

const graph = db.graph("some-graph");
const collection = graph.edgeCollection("friends")
try {
  const edge = await collection.edge("abc123");
  console.log(edge);
} catch (e: any) {
  console.error("Could not find edge");
}
Copy

Example

const graph = db.graph("some-graph");
const collection = graph.edgeCollection("friends")
const edge = await collection.edge("abc123", { graceful: true });
if (edge) {
  console.log(edge);
} else {
  console.error("Edge does not exist");
}
Copy

Retrieves the edge matching the given key or id.

Throws an exception when passed a edge or _id from a different collection, or if the edge does not exist.

Example

const graph = db.graph("some-graph");
const collection = graph.edgeCollection("friends")
try {
  const edge = await collection.edge("abc123", false);
  console.log(edge);
} catch (e: any) {
  console.error("Could not find edge");
}
Copy

Example

const graph = db.graph("some-graph");
const collection = graph.edgeCollection("friends")
const edge = await collection.edge("abc123", true);
if (edge) {
  console.log(edge);
} else {
  console.error("Edge does not exist");
}
Copy

Checks whether a edge matching the given key or id exists in this collection.

Throws an exception when passed a edge or _id from a different collection.

Example

const graph = db.graph("some-graph");
const collection = graph.edgeCollection("friends")
const exists = await collection.edgeExists("abc123");
if (!exists) {
  console.log("Edge does not exist");
}
Copy

Removes an existing edge from the collection.

Throws an exception when passed a edge or _id from a different collection.

Example

const db = new Database();
const collection = db.collection("friends");
const doc = await collection.edge("musadir");
await collection.remove(doc);
// edge with key "musadir" deleted
Copy

Replaces an existing edge in the collection.

Throws an exception when passed a edge or _id from a different collection.

Example

const db = new Database();
const collection = db.collection("friends");
await collection.save(
  {
    _key: "musadir",
    _from: "users/rana",
    _to: "users/mudasir",
    active: true,
    best: true
  }
);
const result = await collection.replace(
  "musadir",
  { active: false },
  { returnNew: true }
);
console.log(result.new.active, result.new.best); // false undefined
Copy

Inserts a new edge with the given data into the collection.

Example

const db = new Database();
const collection = db.collection("friends");
const result = await collection.save(
  { _from: "users/rana", _to: "users/mudasir", active: false },
  { returnNew: true }
);
Copy

Updates an existing edge in the collection.

Throws an exception when passed a edge or _id from a different collection.

Example

const db = new Database();
const collection = db.collection("friends");
await collection.save(
  {
    _key: "musadir",
    _from: "users/rana",
    _to: "users/mudasir",
    active: true,
    best: true
  }
);
const result = await collection.update(
  "musadir",
  { active: false },
  { returnNew: true }
);
console.log(result.new.active, result.new.best); // false true
Copy