Breadth-first traversal

Walks a relation breadth-first from a node and returns each node reached with its depth.

GET /v1/tenants/{tenant}/graph/{schema}/bfs

Explore connections one level at a timeDepth counts links followed from the start node.

Choose a starting recordSelect its relation and maximum depth.
Visit nearby levelsTraverse one hop, then the next.
Read keys and depthsEach result identifies a reached record and its distance.

Before you start

Use your database bearer token.

Register the schema and relation, then add their rows. The examples use demo.people, its bidirectional follows relation, and linked rows u1, u2 and u3.

Path parameters

Field	Type	Required
`tenant`	`string`	Required
`schema`	`string`	Required

Query parameters

Field	Type	Required
`rel`	`string`	Required
`pk`	`string`	Required
`max_depth`	`integer`	Optional

Headers

Field	Type	Required	Description
`x-oc-db-user`	`string`	Optional	Acting database user (role, grant and row-policy checks). Send with x-oc-db-key.
`x-oc-db-key`	`string`	Optional	API key of the x-oc-db-user user.

Read the result

Each result gives a reached node's primary key and hop depth from the start. max_depth limits traversal, not the total number of nodes in the graph.

Response statuses

HTTP status reference

Status	What to do
200	OK
400	Correct the request before retrying.
401	Check the credential and Authorization header.
402	Check feature access or available credits.
403	Check tenant access, roles and permissions.
404	Check the resource ID and API route.
408	Reduce query work or adjust the timeout.
429	Honor Retry-After when present; back off.
499	The client cancelled the request.
500	Check the outcome before retrying a write.
503	Honor Retry-After when present; check write outcomes.

Request example

curl --include --request GET "${OC_BASE_URL}/v1/tenants/${OC_TENANT}/graph/demo.people/bfs?rel=follows&pk=u1&max_depth=2" \
  --header "Authorization: Bearer ${OC_TOKEN}"

Response example

Examples use synthetic values to show the response format.

Response status

[
  {
    "depth": 1,
    "pk": "u2"
  },
  {
    "depth": 2,
    "pk": "u3"
  }
]

Illustrative traversal entries; the versioned canary proves u3 at depth 2, not this full response or its ordering.

Download the OpenAPI specification for the complete response schemas.

Before you startCopy Anchor Link

Path parametersCopy Anchor Link

Query parametersCopy Anchor Link

HeadersCopy Anchor Link