Skip to content

Commit 08e8f6c

Browse files
committed
docs/oasis-node/cli: Document prune command
1 parent 7f4ef10 commit 08e8f6c

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

docs/oasis-node/cli.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -364,3 +364,27 @@ may stay constant or not be reclaimed for a very long time.
364364

365365
This command gives operators manual control to release disk space during
366366
maintenance periods.
367+
368+
### prune-experimental
369+
370+
371+
Run
372+
373+
```sh
374+
oasis-node storage prune-experimental --config /path/to/config/file
375+
```
376+
377+
to trigger manual pruning of consensus database instances:
378+
379+
```sh
380+
{"caller":"storage.go:433","level":"info","module":"cmd/storage", \
381+
"msg":"Starting consensus databases pruning. This may take a while...", \
382+
"ts":"2025-10-23T11:02:11.129822974Z"}
383+
```
384+
385+
Operatos should run this whenever they change pruning configuration, e.g. when
386+
enabling it for the first time, or later changing it to retain less data. This
387+
way they guaranteed the node is healthy when it starts.
388+
389+
Following successful pruning, to release disk space, they are encouraged to run
390+
[the compaction command](#compact-experimental).

0 commit comments

Comments
 (0)