Skip to content

Commit

Permalink
docs/cli: update docs with inspect command
Browse files Browse the repository at this point in the history
Signed-off-by: jsvisa <delweng@gmail.com>
  • Loading branch information
manav2401 authored and jsvisa committed Jun 28, 2023
1 parent 800734f commit 9e9158a
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,6 @@

- [```fingerprint```](./fingerprint.md)

- [```inspect-ancient-db```](./inspect-ancient-db.md)

- [```peers```](./peers.md)

- [```peers add```](./peers_add.md)
Expand All @@ -48,6 +46,8 @@

- [```snapshot```](./snapshot.md)

- [```snapshot inspect-ancient-db```](./snapshot_inspect-ancient-db.md)

- [```snapshot prune-block```](./snapshot_prune-block.md)

- [```snapshot prune-state```](./snapshot_prune-state.md)
Expand Down
19 changes: 19 additions & 0 deletions docs/cli/snapshot_inspect-ancient-db.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Inspect ancient DB for block pruning

The ```bor snapshot inspect-ancient-db``` command will inspect few fields in the ancient datastore using the given datadir location.


This command prints the following information which is useful for block-pruning rounds:

1. Offset / Start block number (from kvDB).
2. Amount of items in the ancientdb.
3. Last block number written in ancientdb.


## Options

- ```datadir```: Path of the data directory to store information

- ```keystore```: Path of the data directory to store keys

- ```datadir.ancient```: Path of the old ancient data directory

0 comments on commit 9e9158a

Please sign in to comment.