Docs menu · Reference

Reads the graph’s ontology annotated with per-type usage: a node count for each object type and an edge count for each link type. Returns no data before any type has been declared. Accepts as_of for time travel.

Optional reads distinguish present data from missing data. When version or timestamp facts exist on the executor output, SDK mappings should preserve them.

Examples

Summarize the ontology’s object types.

CLI

$ strata graph create g
$ strata graph ontology define-object-type g person
$ strata graph ontology summary g

Wire

{"graph":"g","type":"graph_create"}
{"graph":"g","name":"person","type":"graph_define_object_type"}
{"graph":"g","type":"graph_ontology_summary"}

Parameters

NameTypeRequiredDescription
as_ofintegernoOptional timestamp in microseconds. Reads the graph state visible at that instant.
graphstringyesGraph name.

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

Returns

Maybe<GraphOntologySummaryData> — a miss returns nothing rather than raising.

Errors

Invocation

  • CLI: strata graph ontology summary
  • Wire type: graph_ontology_summary

agents: this page as markdown → /docs/reference/graph/ontology/summary.md