Skip to content

Commit 556ea52

Browse files
committed
Mention snapshot-converter in o-c-cardano README
1 parent a957fd8 commit 556ea52

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

ouroboros-consensus-cardano/README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@ This package also contains a few executables:
2020

2121
* `app/immdb-server.hs`: serve an immutable DB via ChainSync and BlockFetch.
2222

23+
* `app/snapshot-converter.hs`: converts snapshots among different storage formats.
24+
2325
### Assertions
2426

2527
Our top level `cabal.project` enables assertions in both our local packages
@@ -378,3 +380,23 @@ To point a node to a running ImmDB server, use a topology file like
378380
]
379381
}
380382
```
383+
384+
385+
## snapshot-converter
386+
387+
## About
388+
389+
This tool converts snapshots among the different backends supported by the node.
390+
391+
## Running the tool
392+
393+
Invoking the tool follows the same simple pattern always:
394+
395+
```sh
396+
cabal run snapshot-converter -- <IN> <OUT> --config /path/to/cardano/config.json
397+
```
398+
399+
The `<IN>` and `<OUT>` parameters depend on the input and output format, receiving options:
400+
- `--mem-in PATH`/`--mem-out PATH` for InMemory
401+
- `--lmdb-in PATH`/`--lmdb-out PATH` for LMDB
402+
- `--lsm-database-in DB_PATH --lsm-snapshot-in PATH`/`--lsm-database-out DB_PATH --lsm-snapshot-out PATH` for LSM-trees.

0 commit comments

Comments
 (0)