admin
describe
Read a compact description of the database.
strata describedb.admin.describe(*, space: 'Optional[str]' = None) -> 'Any'wire describe
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.
To see the complete help for this command, run:
strata describe --helphelp(db.admin.describe)
Example
Describe the database.
strata describeStrataDB … · cachebranch default · branches: default · spaces: defaultcapabilities: arrow event graph_core inference json kv vector vector_indexkv 0 · json 0 · events 0
db.admin.describe().default_branchParameters
| Name | Type | Required | Description |
|---|---|---|---|
| branch | string or null | no | Branch whose primitive data should be described. Defaults to the executor handle branch. |
| space | string or null | no | Space whose primitive counts should be described. Defaults to the default space. |
Returns
StatusResponse<AdminDescribe>
- dataAdminDescribe
- 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 |