Docs menu · Reference

Returns a compact description of the database for one branch: engine version, open target, the default and described branches, all active branches, the registered product spaces, per-primitive counts (KV, JSON, event, plus vector-collection and graph summaries), the sanitized config, and the available capabilities. The branch defaults to the handle branch when omitted.

Status commands return a scalar or compact status payload and do not mutate database state.

Examples

Describe the database.

CLI

$ strata describe

Wire

{"type":"describe"}

Parameters

No parameters.

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

Returns

StatusResponse<AdminDescribe>.

Errors

Invocation

  • CLI: strata describe
  • Wire type: describe

agents: this page as markdown → /docs/reference/admin/describe.md