Options
All
  • Public
  • Public/Protected
  • All
Menu

Class GraphVertexCollection<T>

Represents a DocumentCollection of vertices in a Graph.

Type parameters

  • T: Record<string, any> = any

    Type to use for document data. Defaults to any.

Hierarchy

  • GraphVertexCollection

Implements

Index

Accessors

Methods

Accessors

collection

graph

  • The Graph instance this vertex collection is bound to.

    Returns Graph

isArangoCollection

  • get isArangoCollection(): true

name

  • get name(): string

Methods

remove

  • 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
    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

    Parameters

    Returns Promise<DocumentMetadata & { old?: Document<T> }>

replace

  • 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

    Parameters

    Returns Promise<DocumentMetadata & { new?: Document<T>; old?: Document<T> }>

save

  • 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

    Parameters

    Returns Promise<DocumentMetadata & { new?: Document<T> }>

update

  • 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

    Parameters

    Returns Promise<DocumentMetadata & { new?: Document<T>; old?: Document<T> }>

vertex

  • 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) {
  console.error("Could not find vertex");
}
    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");
}

    Parameters

    Returns Promise<Document<T>>

  • 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) {
  console.error("Could not find vertex");
}
    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");
}

    Parameters

    • selector: DocumentSelector

      Document _key, _id or object with either of those properties (e.g. a vertex from this collection).

    • graceful: boolean

      If set to true, null is returned instead of an exception being thrown if the vertex does not exist.

    Returns Promise<Document<T>>

vertexExists

  • 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");
}

    Parameters

    • selector: DocumentSelector

      Document _key, _id or object with either of those properties (e.g. a vertex from this collection).

    Returns Promise<boolean>

Generated using TypeDoc