HyperspaceDB icon

HyperspaceDB

Interact with the HyperspaceDB gRPC API

Actions13

Graph → Traverse

AI-generated

Summary

Perform a graph traversal starting from a specified node ID, retrieving connected nodes up to a given maximum depth and node limit in a specified collection.

Inputs

  • collectionName (required) — The name of the Graph collection to traverse.
  • startId — The ID of the starting node for traversal. Defaults to 0.
  • maxDepth — The maximum depth of traversal. Defaults to 3.
  • maxNodes — The maximum number of nodes to return during traversal. Defaults to 256.

Output shape

a single record containing a JSON object with a nodes array representing the traversed graph nodes

The returned data includes up to maxNodes nodes reachable within maxDepth from startId in the specified collection. There is no indication of pagination or partial results.

Links

Discussion