Docs menu · Reference

Runs a breadth-first traversal from a start node over a consistent snapshot, bounded by max_depth (default 100) and max_nodes (default 10000). Returns visited node ids in traversal order, a depth per node, and the tree edges in discovery order. Direction defaults to outgoing; an optional edge-type list restricts every hop. The start node must exist (not_found.engine.graph_node).

Analytics commands compute over a consistent snapshot of the visible graph and return a complete result payload in one response. They accept optional snapshot budgets and an as_of timestamp for time travel; results are deterministic for a fixed graph state.

Examples

Breadth-first traversal from a start node.

CLI

$ strata graph create g
$ strata graph add-node g a
$ strata graph add-node g b
$ strata graph add-node g c
$ strata graph add-edge g a knows b
$ strata graph add-edge g b knows c
$ strata graph bfs g a

Wire

{"graph":"g","type":"graph_create"}
{"graph":"g","node_id":"a","type":"graph_add_node"}
{"graph":"g","node_id":"b","type":"graph_add_node"}
{"graph":"g","node_id":"c","type":"graph_add_node"}
{"dst":"b","edge_type":"knows","graph":"g","src":"a","type":"graph_add_edge"}
{"dst":"c","edge_type":"knows","graph":"g","src":"b","type":"graph_add_edge"}
{"graph":"g","start":"a","type":"graph_bfs"}

Parameters

NameTypeRequiredDescription
as_ofintegernoOptional timestamp in microseconds. Reads the graph state visible at that instant.
budgetGraphAnalyticsBudgetnoOptional snapshot size bounds. Defaults to the engine limits.
directionGraphDirectionnoOptional traversal direction. Defaults to outgoing.
edge_typesstring[]noOptional edge-type restriction applied at every hop.
graphstringyesGraph name.
max_depthintegernoOptional depth bound. Defaults to 100.
max_nodesintegernoOptional visited-node bound. Defaults to 10000.
startstringyesStart node id.

Plus the optional scope: branch and space (default to the session branch and the "default" space).

Returns

AnalyticsResult<GraphBfsData>.

Errors

Invocation

  • CLI: strata graph bfs
  • Wire type: graph_bfs

agents: this page as markdown → /docs/reference/graph/analytics/bfs.md