From 9e9158a33252c554d4d342c62d8051966d9ebe42 Mon Sep 17 00:00:00 2001 From: Manav Darji Date: Tue, 23 May 2023 11:21:46 +0530 Subject: [PATCH] docs/cli: update docs with inspect command Signed-off-by: jsvisa --- docs/cli/README.md | 4 ++-- docs/cli/snapshot_inspect-ancient-db.md | 19 +++++++++++++++++++ 2 files changed, 21 insertions(+), 2 deletions(-) create mode 100644 docs/cli/snapshot_inspect-ancient-db.md diff --git a/docs/cli/README.md b/docs/cli/README.md index 22dbe43bed..7b80c49420 100644 --- a/docs/cli/README.md +++ b/docs/cli/README.md @@ -30,8 +30,6 @@ - [```fingerprint```](./fingerprint.md) -- [```inspect-ancient-db```](./inspect-ancient-db.md) - - [```peers```](./peers.md) - [```peers add```](./peers_add.md) @@ -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) diff --git a/docs/cli/snapshot_inspect-ancient-db.md b/docs/cli/snapshot_inspect-ancient-db.md new file mode 100644 index 0000000000..838cfc5e9f --- /dev/null +++ b/docs/cli/snapshot_inspect-ancient-db.md @@ -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