Admin commands

config

Read sanitized configuration facts.

Returns sanitized configuration facts: the open target, whether this open created the database, durability, and the default branch. Only allowlisted, non-sensitive facts are exposed; no filesystem paths, credentials, or provider keys are ever returned.

To see the complete help for this command, run:

strata config get --help

Example

strata config get

db.admin.config().default_branch

config_key

Read one sanitized configuration value by key.

Returns one sanitized configuration value from the allowlist by key, or a null value when the key is not recognized. Only allowlisted, non-sensitive keys are served; an empty key is rejected with `invalid_argument.engine.config_key`.

To see the complete help for this command, run:

strata config get-key --help

Example

strata config get-key missing

db.admin.config_value("missing") is None

describe

Read a compact description of the database.

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.

To see the complete help for this command, run:

strata describe --help

Example

strata describe

db.admin.describe().default_branch

health

Read control-plane health facts.

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.

To see the complete help for this command, run:

strata health --help

Example

strata health

db.admin.health().status.value

hub_clone

Clone a dataset from a hub into a new local database.

Clones a dataset from a hub into a new local database directory. Resolution, download, verification, reconstitution, and origin recording run once behind this command; the session database is not touched. The destination directory must not exist or must be empty. When the hub URL is not given, the layered resolver selects it from the flag, environment, and config layers.

To see the complete help for this command, run:

strata clone --help

info

Read database identity and a catalog summary.

Returns database identity and a catalog summary for one branch: engine version, open target, whether this open created the database, durability, the default branch, the active branch count, the registered space count for the selected branch, and the resolved storage `memory_budget` (its `total_bytes` and its `source` - `explicit`, `derived_from_host`, or `fixed_default`). When no budget is set, the engine derives the default from host memory at open - 25% of usable memory, clamped to a ceiling - so `memory_budget` reveals what the database is actually sized to. The branch defaults to the handle branch when omitted.

To see the complete help for this command, run:

strata info --help

Example

strata info

db.admin.info().branch_count

ipc_status

Report this process's multi-process IPC state.

Reports the same-machine multi-process state for this handle: whether this process owns the store (holds the writer lock) or is a client of another owner, whether it is hosting a broker socket, the socket path and owning process id when one exists, and the number of clients currently connected to the host. A single-process open (cache, or a durable open with IPC off) reports `is_owner: true`, `hosting: false`, and no socket.

To see the complete help for this command, run:

strata ipc status --help

Example

strata ipc status

db.admin.ipc_status().hosting

ipc_stop

Stop hosting the multi-process broker socket.

Stops hosting the same-machine broker socket for this store: the listener stops accepting connections and the store is no longer reachable by new clients. Run from a client, it forwards to the owner, which stops hosting (ending that client's own connection). The store stays open in this process; the socket files are unlinked when the owner closes. Idempotent - a process that was not hosting reports `stopped: false`.

To see the complete help for this command, run:

strata ipc stop --help

Example

strata ipc stop

db.admin.ipc_stop().stopped

metrics

Read lightweight database metrics.

Returns lightweight database metrics: the open target, durability, whether the handle is open, the active branch count, the registered space count for the selected branch, and the control-plane health status. The branch defaults to the handle branch when omitted.

To see the complete help for this command, run:

strata metrics --help

Example

strata metrics

db.admin.metrics().branch_count

ping

Check that the database handle is live.

Lightweight liveness check. Returns the engine package version without touching branches, spaces, or primitive data. Use it to confirm the handle is open and responsive before issuing heavier commands.

To see the complete help for this command, run:

strata ping --help

Example

strata ping

isinstance(db.admin.ping().version, str)

remote

Read where this database was cloned from.

Reads the remote origin recorded when this database was cloned from a hub: the remote URL, dataset, branch, manifest hash, fetch time, and per-branch base frontier. Returns a null origin when the database was created locally and never cloned.

To see the complete help for this command, run:

strata remote --help

Example

strata remote