mirror of
https://github.com/paradigmxyz/reth.git
synced 2026-01-31 01:58:17 -05:00
601 lines
14 KiB
Markdown
601 lines
14 KiB
Markdown
# `reth db`
|
|
|
|
Database debugging utilities
|
|
|
|
```bash
|
|
$ reth db --help
|
|
|
|
Usage: reth db [OPTIONS] <COMMAND>
|
|
|
|
Commands:
|
|
stats
|
|
Lists all the tables, their entry count and their size
|
|
list
|
|
Lists the contents of a table
|
|
get
|
|
Gets the content of a table for the given key
|
|
drop
|
|
Deletes all database entries
|
|
clear
|
|
Deletes all table entries
|
|
version
|
|
Lists current and local database versions
|
|
path
|
|
Returns the full database path
|
|
help
|
|
Print this message or the help of the given subcommand(s)
|
|
|
|
Options:
|
|
--datadir <DATA_DIR>
|
|
The path to the data dir for all reth files and subdirectories.
|
|
|
|
Defaults to the OS-specific data directory:
|
|
|
|
- Linux: `$XDG_DATA_HOME/reth/` or `$HOME/.local/share/reth/`
|
|
- Windows: `{FOLDERID_RoamingAppData}/reth/`
|
|
- macOS: `$HOME/Library/Application Support/reth/`
|
|
|
|
[default: default]
|
|
|
|
--chain <CHAIN_OR_PATH>
|
|
The chain this node is running.
|
|
|
|
Possible values are either a built-in chain or the path to a chain specification file.
|
|
|
|
Built-in chains:
|
|
- mainnet
|
|
- goerli
|
|
- sepolia
|
|
|
|
[default: mainnet]
|
|
|
|
-h, --help
|
|
Print help (see a summary with '-h')
|
|
|
|
Database:
|
|
--db.log-level <LOG_LEVEL>
|
|
Database logging level. Levels higher than "notice" require a debug build
|
|
|
|
Possible values:
|
|
- fatal: Enables logging for critical conditions, i.e. assertion failures
|
|
- error: Enables logging for error conditions
|
|
- warn: Enables logging for warning conditions
|
|
- notice: Enables logging for normal but significant condition
|
|
- verbose: Enables logging for verbose informational
|
|
- debug: Enables logging for debug-level messages
|
|
- trace: Enables logging for trace debug-level messages
|
|
- extra: Enables logging for extra debug-level messages
|
|
|
|
Logging:
|
|
--log.persistent
|
|
The flag to enable persistent logs
|
|
|
|
--log.directory <PATH>
|
|
The path to put log files in
|
|
|
|
[default: /reth/logs]
|
|
|
|
--log.journald
|
|
Log events to journald
|
|
|
|
--log.filter <FILTER>
|
|
The filter to use for logs written to the log file
|
|
|
|
[default: error]
|
|
|
|
Display:
|
|
-v, --verbosity...
|
|
Set the minimum log level.
|
|
|
|
-v Errors
|
|
-vv Warnings
|
|
-vvv Info
|
|
-vvvv Debug
|
|
-vvvvv Traces (warning: very verbose!)
|
|
|
|
-q, --quiet
|
|
Silence all log output
|
|
```
|
|
|
|
## `reth db stats`
|
|
|
|
Lists all the tables, their entry count and their size
|
|
|
|
```bash
|
|
$ reth db stats --help
|
|
|
|
Usage: reth db stats [OPTIONS]
|
|
|
|
Options:
|
|
--datadir <DATA_DIR>
|
|
The path to the data dir for all reth files and subdirectories.
|
|
|
|
Defaults to the OS-specific data directory:
|
|
|
|
- Linux: `$XDG_DATA_HOME/reth/` or `$HOME/.local/share/reth/`
|
|
- Windows: `{FOLDERID_RoamingAppData}/reth/`
|
|
- macOS: `$HOME/Library/Application Support/reth/`
|
|
|
|
[default: default]
|
|
|
|
--chain <CHAIN_OR_PATH>
|
|
The chain this node is running.
|
|
|
|
Possible values are either a built-in chain or the path to a chain specification file.
|
|
|
|
Built-in chains:
|
|
- mainnet
|
|
- goerli
|
|
- sepolia
|
|
|
|
[default: mainnet]
|
|
|
|
-h, --help
|
|
Print help (see a summary with '-h')
|
|
|
|
Logging:
|
|
--log.persistent
|
|
The flag to enable persistent logs
|
|
|
|
--log.directory <PATH>
|
|
The path to put log files in
|
|
|
|
[default: /reth/logs]
|
|
|
|
--log.journald
|
|
Log events to journald
|
|
|
|
--log.filter <FILTER>
|
|
The filter to use for logs written to the log file
|
|
|
|
[default: error]
|
|
|
|
Display:
|
|
-v, --verbosity...
|
|
Set the minimum log level.
|
|
|
|
-v Errors
|
|
-vv Warnings
|
|
-vvv Info
|
|
-vvvv Debug
|
|
-vvvvv Traces (warning: very verbose!)
|
|
|
|
-q, --quiet
|
|
Silence all log output
|
|
```
|
|
|
|
## `reth db list`
|
|
|
|
Lists the contents of a table
|
|
|
|
```bash
|
|
$ reth db list --help
|
|
|
|
Usage: reth db list [OPTIONS] <TABLE>
|
|
|
|
Arguments:
|
|
<TABLE>
|
|
The table name
|
|
|
|
Options:
|
|
--datadir <DATA_DIR>
|
|
The path to the data dir for all reth files and subdirectories.
|
|
|
|
Defaults to the OS-specific data directory:
|
|
|
|
- Linux: `$XDG_DATA_HOME/reth/` or `$HOME/.local/share/reth/`
|
|
- Windows: `{FOLDERID_RoamingAppData}/reth/`
|
|
- macOS: `$HOME/Library/Application Support/reth/`
|
|
|
|
[default: default]
|
|
|
|
-s, --skip <SKIP>
|
|
Skip first N entries
|
|
|
|
[default: 0]
|
|
|
|
--chain <CHAIN_OR_PATH>
|
|
The chain this node is running.
|
|
|
|
Possible values are either a built-in chain or the path to a chain specification file.
|
|
|
|
Built-in chains:
|
|
- mainnet
|
|
- goerli
|
|
- sepolia
|
|
|
|
[default: mainnet]
|
|
|
|
-r, --reverse
|
|
Reverse the order of the entries. If enabled last table entries are read
|
|
|
|
-l, --len <LEN>
|
|
How many items to take from the walker
|
|
|
|
[default: 5]
|
|
|
|
-j, --json
|
|
Dump as JSON instead of using TUI
|
|
|
|
-h, --help
|
|
Print help (see a summary with '-h')
|
|
|
|
Logging:
|
|
--log.persistent
|
|
The flag to enable persistent logs
|
|
|
|
--log.directory <PATH>
|
|
The path to put log files in
|
|
|
|
[default: /reth/logs]
|
|
|
|
--log.journald
|
|
Log events to journald
|
|
|
|
--log.filter <FILTER>
|
|
The filter to use for logs written to the log file
|
|
|
|
[default: error]
|
|
|
|
Display:
|
|
-v, --verbosity...
|
|
Set the minimum log level.
|
|
|
|
-v Errors
|
|
-vv Warnings
|
|
-vvv Info
|
|
-vvvv Debug
|
|
-vvvvv Traces (warning: very verbose!)
|
|
|
|
-q, --quiet
|
|
Silence all log output
|
|
```
|
|
|
|
## `reth db get`
|
|
|
|
Gets the content of a table for the given key
|
|
|
|
```bash
|
|
$ reth db get --help
|
|
|
|
Usage: reth db get [OPTIONS] <TABLE> <KEY>
|
|
|
|
Arguments:
|
|
<TABLE>
|
|
The table name
|
|
|
|
NOTE: The dupsort tables are not supported now.
|
|
|
|
<KEY>
|
|
The key to get content for
|
|
|
|
Options:
|
|
--datadir <DATA_DIR>
|
|
The path to the data dir for all reth files and subdirectories.
|
|
|
|
Defaults to the OS-specific data directory:
|
|
|
|
- Linux: `$XDG_DATA_HOME/reth/` or `$HOME/.local/share/reth/`
|
|
- Windows: `{FOLDERID_RoamingAppData}/reth/`
|
|
- macOS: `$HOME/Library/Application Support/reth/`
|
|
|
|
[default: default]
|
|
|
|
--chain <CHAIN_OR_PATH>
|
|
The chain this node is running.
|
|
|
|
Possible values are either a built-in chain or the path to a chain specification file.
|
|
|
|
Built-in chains:
|
|
- mainnet
|
|
- goerli
|
|
- sepolia
|
|
|
|
[default: mainnet]
|
|
|
|
-h, --help
|
|
Print help (see a summary with '-h')
|
|
|
|
Logging:
|
|
--log.persistent
|
|
The flag to enable persistent logs
|
|
|
|
--log.directory <PATH>
|
|
The path to put log files in
|
|
|
|
[default: /reth/logs]
|
|
|
|
--log.journald
|
|
Log events to journald
|
|
|
|
--log.filter <FILTER>
|
|
The filter to use for logs written to the log file
|
|
|
|
[default: error]
|
|
|
|
Display:
|
|
-v, --verbosity...
|
|
Set the minimum log level.
|
|
|
|
-v Errors
|
|
-vv Warnings
|
|
-vvv Info
|
|
-vvvv Debug
|
|
-vvvvv Traces (warning: very verbose!)
|
|
|
|
-q, --quiet
|
|
Silence all log output
|
|
```
|
|
|
|
## `reth db drop`
|
|
|
|
Deletes all database entries
|
|
|
|
```bash
|
|
$ reth db drop --help
|
|
|
|
Usage: reth db drop [OPTIONS]
|
|
|
|
Options:
|
|
--datadir <DATA_DIR>
|
|
The path to the data dir for all reth files and subdirectories.
|
|
|
|
Defaults to the OS-specific data directory:
|
|
|
|
- Linux: `$XDG_DATA_HOME/reth/` or `$HOME/.local/share/reth/`
|
|
- Windows: `{FOLDERID_RoamingAppData}/reth/`
|
|
- macOS: `$HOME/Library/Application Support/reth/`
|
|
|
|
[default: default]
|
|
|
|
--chain <CHAIN_OR_PATH>
|
|
The chain this node is running.
|
|
|
|
Possible values are either a built-in chain or the path to a chain specification file.
|
|
|
|
Built-in chains:
|
|
- mainnet
|
|
- goerli
|
|
- sepolia
|
|
|
|
[default: mainnet]
|
|
|
|
-h, --help
|
|
Print help (see a summary with '-h')
|
|
|
|
Logging:
|
|
--log.persistent
|
|
The flag to enable persistent logs
|
|
|
|
--log.directory <PATH>
|
|
The path to put log files in
|
|
|
|
[default: /reth/logs]
|
|
|
|
--log.journald
|
|
Log events to journald
|
|
|
|
--log.filter <FILTER>
|
|
The filter to use for logs written to the log file
|
|
|
|
[default: error]
|
|
|
|
Display:
|
|
-v, --verbosity...
|
|
Set the minimum log level.
|
|
|
|
-v Errors
|
|
-vv Warnings
|
|
-vvv Info
|
|
-vvvv Debug
|
|
-vvvvv Traces (warning: very verbose!)
|
|
|
|
-q, --quiet
|
|
Silence all log output
|
|
```
|
|
|
|
## `reth db clear`
|
|
|
|
Deletes all table entries
|
|
|
|
```bash
|
|
$ reth db clear --help
|
|
|
|
Usage: reth db clear [OPTIONS] <TABLE>
|
|
|
|
Arguments:
|
|
<TABLE>
|
|
Table name
|
|
|
|
Options:
|
|
--datadir <DATA_DIR>
|
|
The path to the data dir for all reth files and subdirectories.
|
|
|
|
Defaults to the OS-specific data directory:
|
|
|
|
- Linux: `$XDG_DATA_HOME/reth/` or `$HOME/.local/share/reth/`
|
|
- Windows: `{FOLDERID_RoamingAppData}/reth/`
|
|
- macOS: `$HOME/Library/Application Support/reth/`
|
|
|
|
[default: default]
|
|
|
|
--chain <CHAIN_OR_PATH>
|
|
The chain this node is running.
|
|
|
|
Possible values are either a built-in chain or the path to a chain specification file.
|
|
|
|
Built-in chains:
|
|
- mainnet
|
|
- goerli
|
|
- sepolia
|
|
|
|
[default: mainnet]
|
|
|
|
-h, --help
|
|
Print help (see a summary with '-h')
|
|
|
|
Logging:
|
|
--log.persistent
|
|
The flag to enable persistent logs
|
|
|
|
--log.directory <PATH>
|
|
The path to put log files in
|
|
|
|
[default: /reth/logs]
|
|
|
|
--log.journald
|
|
Log events to journald
|
|
|
|
--log.filter <FILTER>
|
|
The filter to use for logs written to the log file
|
|
|
|
[default: error]
|
|
|
|
Display:
|
|
-v, --verbosity...
|
|
Set the minimum log level.
|
|
|
|
-v Errors
|
|
-vv Warnings
|
|
-vvv Info
|
|
-vvvv Debug
|
|
-vvvvv Traces (warning: very verbose!)
|
|
|
|
-q, --quiet
|
|
Silence all log output
|
|
```
|
|
|
|
## `reth db version`
|
|
|
|
Lists current and local database versions
|
|
|
|
```bash
|
|
$ reth db version --help
|
|
|
|
Usage: reth db version [OPTIONS]
|
|
|
|
Options:
|
|
--datadir <DATA_DIR>
|
|
The path to the data dir for all reth files and subdirectories.
|
|
|
|
Defaults to the OS-specific data directory:
|
|
|
|
- Linux: `$XDG_DATA_HOME/reth/` or `$HOME/.local/share/reth/`
|
|
- Windows: `{FOLDERID_RoamingAppData}/reth/`
|
|
- macOS: `$HOME/Library/Application Support/reth/`
|
|
|
|
[default: default]
|
|
|
|
--chain <CHAIN_OR_PATH>
|
|
The chain this node is running.
|
|
|
|
Possible values are either a built-in chain or the path to a chain specification file.
|
|
|
|
Built-in chains:
|
|
- mainnet
|
|
- goerli
|
|
- sepolia
|
|
|
|
[default: mainnet]
|
|
|
|
-h, --help
|
|
Print help (see a summary with '-h')
|
|
|
|
Logging:
|
|
--log.persistent
|
|
The flag to enable persistent logs
|
|
|
|
--log.directory <PATH>
|
|
The path to put log files in
|
|
|
|
[default: /reth/logs]
|
|
|
|
--log.journald
|
|
Log events to journald
|
|
|
|
--log.filter <FILTER>
|
|
The filter to use for logs written to the log file
|
|
|
|
[default: error]
|
|
|
|
Display:
|
|
-v, --verbosity...
|
|
Set the minimum log level.
|
|
|
|
-v Errors
|
|
-vv Warnings
|
|
-vvv Info
|
|
-vvvv Debug
|
|
-vvvvv Traces (warning: very verbose!)
|
|
|
|
-q, --quiet
|
|
Silence all log output
|
|
```
|
|
|
|
## `reth db path`
|
|
|
|
Returns the full database path
|
|
|
|
```bash
|
|
$ reth db path --help
|
|
|
|
Usage: reth db path [OPTIONS]
|
|
|
|
Options:
|
|
--datadir <DATA_DIR>
|
|
The path to the data dir for all reth files and subdirectories.
|
|
|
|
Defaults to the OS-specific data directory:
|
|
|
|
- Linux: `$XDG_DATA_HOME/reth/` or `$HOME/.local/share/reth/`
|
|
- Windows: `{FOLDERID_RoamingAppData}/reth/`
|
|
- macOS: `$HOME/Library/Application Support/reth/`
|
|
|
|
[default: default]
|
|
|
|
--chain <CHAIN_OR_PATH>
|
|
The chain this node is running.
|
|
|
|
Possible values are either a built-in chain or the path to a chain specification file.
|
|
|
|
Built-in chains:
|
|
- mainnet
|
|
- goerli
|
|
- sepolia
|
|
|
|
[default: mainnet]
|
|
|
|
-h, --help
|
|
Print help (see a summary with '-h')
|
|
|
|
Logging:
|
|
--log.persistent
|
|
The flag to enable persistent logs
|
|
|
|
--log.directory <PATH>
|
|
The path to put log files in
|
|
|
|
[default: /reth/logs]
|
|
|
|
--log.journald
|
|
Log events to journald
|
|
|
|
--log.filter <FILTER>
|
|
The filter to use for logs written to the log file
|
|
|
|
[default: error]
|
|
|
|
Display:
|
|
-v, --verbosity...
|
|
Set the minimum log level.
|
|
|
|
-v Errors
|
|
-vv Warnings
|
|
-vvv Info
|
|
-vvvv Debug
|
|
-vvvvv Traces (warning: very verbose!)
|
|
|
|
-q, --quiet
|
|
Silence all log output
|
|
```
|