aboutsummaryrefslogtreecommitdiff
path: root/src/blockchain_utilities/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'src/blockchain_utilities/README.md')
-rw-r--r--src/blockchain_utilities/README.md21
1 files changed, 13 insertions, 8 deletions
diff --git a/src/blockchain_utilities/README.md b/src/blockchain_utilities/README.md
index ecf8a7c42..9ac8c5dd8 100644
--- a/src/blockchain_utilities/README.md
+++ b/src/blockchain_utilities/README.md
@@ -1,3 +1,8 @@
+# Monero Blockchain Utilities
+
+Copyright (c) 2014-2015, The Monero Project
+
+## Introduction
For importing into the LMDB database, compile with `DATABASE=lmdb`
@@ -11,17 +16,17 @@ By default, the exporter will use the original in-memory database (blockchain.bi
This default is to make migrating to an LMDB database easy, without having to recompile anything.
To change the source, adjust `SOURCE_DB` in `src/blockchain_utilities/bootstrap_file.h` according to the comments.
-# Usage:
+## Usage:
See also each utility's "--help" option.
-## Export an existing in-memory database
+### Export an existing in-memory database
`$ blockchain_export`
This loads the existing blockchain, for whichever database type it was compiled for, and exports it to `$MONERO_DATA_DIR/export/blockchain.raw`
-## Import the exported file
+### Import the exported file
`$ blockchain_import`
@@ -34,19 +39,19 @@ Batch size refers to number of blocks and can be adjusted for performance based
Verification should only be turned off if importing from a trusted blockchain.
```bash
-# use default settings to import blockchain.raw into database
+## use default settings to import blockchain.raw into database
$ blockchain_import
-# fast import with large batch size, verification off
+## fast import with large batch size, verification off
$ blockchain_import --batch-size 100000 --verify off
-# LMDB flags can be set by appending them to the database type:
-# flags: nosync, nometasync, writemap, mapasync
+## LMDB flags can be set by appending them to the database type:
+## flags: nosync, nometasync, writemap, mapasync
$ blockchain_import --database lmdb#nosync
$ blockchain_import --database lmdb#nosync,nometasync
```
-## Blockchain converter with batching
+### Blockchain converter with batching
`blockchain_converter` has also been updated and includes batching for faster writes. However, on lower RAM systems, this will be slower than using the exporter and importer utilities. The converter needs to keep the blockchain in memory for the duration of the conversion, like the original bitmonerod, thus leaving less memory available to the destination database to operate.
```bash