Find connected components

Labels every node in a graph schema with its connected component, treating a self-relation as undirected.

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

Find groups that have no connecting linksThis calculation treats the self-relation as undirected.

Select a self-relationChoose the graph's schema and relation.
Group connected nodesFind records reachable within each connected component.
Compare component labelsMatching labels identify membership, not importance.

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
`include_rows`	`boolean`	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

Nodes with the same _component value belong to the same connected component. The self-relation is treated as undirected; the component label is an identifier, not a score.

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.
413	Split or reduce the request body.
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/components?rel=follows" \
  --header "Authorization: Bearer ${OC_TOKEN}"

Response example

Examples use synthetic values to show the response format.

Response status

[
  {
    "pk": [
      "u1"
    ],
    "_component": "[\"u1\"]"
  },
  {
    "pk": [
      "u2"
    ],
    "_component": "[\"u1\"]"
  },
  {
    "pk": [
      "u3"
    ],
    "_component": "[\"u1\"]"
  }
]

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