admin
health
Read control-plane health facts.
strata healthdb.admin.health() -> 'Any'wire health
Returns control-plane health facts: the worst overall status plus per-subsystem status for identity, registry, branch catalog, and the optional branch-local space catalog. Also reports the default branch and active branch count. A healthy result means every required control-plane fact is present and readable.
Status commands return a scalar or compact status payload and do not mutate database state.
To see the complete help for this command, run:
strata health --helphelp(db.admin.health)
Example
Read control-plane health.
strata healthdb.admin.health().status.valueParameters
| Name | Type | Required | Description |
|---|---|---|---|
| branch | string or null | no | Branch whose space catalog should be checked. Defaults to the executor handle branch. |
Returns
StatusResponse<AdminHealth>
- dataAdminHealth
- typestring
Errors
Recover by code. Retry policy and commit outcome come from the shipped error registry.
| Code | Retry | Commit outcome |
|---|---|---|
| failed_precondition.engine.runtime_closed | never | not_started |
| not_found.engine.branch | never | not_applicable |
| invalid_argument.engine.branch_name | never | not_started |