nanoreth/book/cli/db.md

reth db

Database debugging utilities

$ 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
  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')

Display:
  -v, --verbosity...
          Set the minimum log level.

          -v      Errors
          -vv     Warnings
          -vvv    Info
          -vvvv   Debug
          -vvvvv  Traces (warning: very verbose!)

reth db stats

$ reth db stats --help
Lists all the tables, their entry count and their size

Usage: reth db stats [OPTIONS]

Options:
  -h, --help

reth db list

$ reth db list --help
Lists the contents of a table

Usage: reth db list [OPTIONS] <TABLE>

Arguments:
  <TABLE>
          The table name

Options:
  -s, --skip <SKIP>
          Skip first N entries

          [default: 0]

  -r, --reverse <REVERSE>
          Reverse the order of the entries. If enabled last table entries are read.

          [default: false]

  -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')

reth db get

$ reth db get --help
Gets the content of a table for the given key

Usage: reth db get [OPTIONS] <TABLE>

Arguments:
  <TABLE>
          The table name

Options:
  --key
          The key to get content for

  -h, --help
          Print help (see a summary with '-h')

reth db drop

$ reth db drop --help
Deletes all database entries

Usage: reth db drop [OPTIONS]

Options:
  -h, --help
          Print help (see a summary with '-h')