Class GraphVertexCollection<EntryResultType, EntryInputType>

A collections.DocumentCollection instance for this vertex collection.

Database this vertex collection belongs to.

The Graph instance this vertex collection is bound to.

Name of the collection.

Removes an existing vertex from the collection.

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

Example

const graph = db.graph("some-graph");
const collection = graph.vertexCollection("vertices");
await collection.remove("abc123");
// document with key "abc123" deleted
Copy

Example

const graph = db.graph("some-graph");
const collection = graph.vertexCollection("vertices");
const doc = await collection.vertex("abc123");
await collection.remove(doc);
// document with key "abc123" deleted
Copy

Replaces an existing vertex in the collection.

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

Example

const graph = db.graph("some-graph");
const collection = graph.collection("vertices");
await collection.save({ _key: "a", color: "blue", count: 1 });
const result = await collection.replace(
  "a",
  { color: "red" },
  { returnNew: true }
);
console.log(result.new.color, result.new.count); // "red" undefined
Copy

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

Example

const graph = db.graph("some-graph");
const collection = graph.vertexCollection("friends");
const result = await collection.save(
  { _key: "a", color: "blue", count: 1 },
  { returnNew: true }
);
console.log(result.new.color, result.new.count); // "blue" 1
Copy

Updates an existing vertex in the collection.

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

Example

const graph = db.graph("some-graph");
const collection = graph.collection("vertices");
await collection.save({ _key: "a", color: "blue", count: 1 });
const result = await collection.update(
  "a",
  { count: 2 },
  { returnNew: true }
);
console.log(result.new.color, result.new.count); // "blue" 2
Copy

Retrieves the vertex matching the given key or id.

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

Example

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

Example

const graph = db.graph("some-graph");
const collection = graph.vertexCollection("vertices");
const vertex = await collection.vertex("abc123", { graceful: true });
if (vertex) {
  console.log(vertex);
} else {
  console.error("Could not find vertex");
}
Copy

Retrieves the vertex matching the given key or id.

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

Example

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

Example

const graph = db.graph("some-graph");
const collection = graph.vertexCollection("vertices");
const vertex = await collection.vertex("abc123", true);
if (vertex) {
  console.log(vertex);
} else {
  console.error("Could not find vertex");
}
Copy

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

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

Example

const graph = db.graph("some-graph");
const collection = graph.vertexCollection("vertices");
const exists = await collection.vertexExists("abc123");
if (!exists) {
  console.log("Vertex does not exist");
}
Copy