Skip to main content

Module db_shell

Module db_shell 

Source
Expand description

Interactive database shell for the Sui validator database.

Two operating modes:

Direct mode (--db-path): opens RocksDB files directly. Requires the node to be stopped. Read-only by default; pass --allow-writes to enable rm.

Proxy mode (--admin-url): delegates all operations to the running sui-node admin API. Allows write operations because the node owns the DB lock.

Modules§

backend
completion
Tab completion for the db-shell.
direct
Direct RocksDB backend for the db-shell. Used when sui-node is not running and the database files can be opened directly.
proxy
HTTP proxy backend for the db-shell. Delegates all operations to the running sui-node admin API.
shell
Interactive shell loop for the db-shell command.
vfs
Virtual filesystem path types for the db-shell.

Structs§

DbShellArgs

Functions§

run