aboutsummaryrefslogtreecommitdiff
path: root/src/blockchain_utilities/README.md
diff options
context:
space:
mode:
authorwarptangent <warptangent@tutanota.com>2016-03-05 12:54:31 -0800
committerHoward Chu <hyc@symas.com>2016-04-05 20:30:50 +0100
commit309f8f3d44ad5c1ca85751623f46fc1d676c9e36 (patch)
treea2c983215479696aaf5b39a23140cfe9bcf16fac /src/blockchain_utilities/README.md
parentget_payments short ID (diff)
downloadmonero-309f8f3d44ad5c1ca85751623f46fc1d676c9e36.tar.xz
blockchain_utilities: Update documentation
Diffstat (limited to '')
-rw-r--r--src/blockchain_utilities/README.md58
1 files changed, 54 insertions, 4 deletions
diff --git a/src/blockchain_utilities/README.md b/src/blockchain_utilities/README.md
index d763bc4dd..9c69647ad 100644
--- a/src/blockchain_utilities/README.md
+++ b/src/blockchain_utilities/README.md
@@ -52,18 +52,68 @@ the `blockchain_import` command again, and it will restart from where it left of
## use default settings to import blockchain.raw into database
$ blockchain_import
-## fast import with large batch size, verification off
-$ blockchain_import --batch-size 100000 --verify off
+## fast import with large batch size, database mode "fastest", verification off
+$ blockchain_import --batch-size 20000 --database lmdb#fastest --verify off
+
+```
+
+### Import options
+
+`--input-file`
+specifies input file path for importing
+
+default: `<data-dir>/export/blockchain.raw`
+
+`--output-file`
+specifies output file path to export to
+
+default: `<data-dir>/export/blockchain.raw`
+
+`--block-stop`
+stop at block number
+
+`--database <database type>`
+
+`--database <database type>#<flag(s)>`
+
+database type: `lmdb, berkeley, memory`
+
+flags:
+
+The flag after the # is interpreted as a composite mode/flag if there's only
+one (no comma separated arguments).
+
+The composite mode represents multiple DB flags and support different database types:
+
+`safe, fast, fastest`
+
+Database-specific flags can be set instead.
+
+LMDB flags (more than one may be specified):
+
+`nosync, nometasync, writemap, mapasync, nordahead`
+
+BerkeleyDB flags (takes one):
+
+`txn_write_nosync, txn_nosync, txn_sync`
+
+```
+## Examples:
+$ blockchain_import --database lmdb#fastest
+$ blockchain_import --database berkeley#fastest
-## 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_import --database berkeley#txn_nosync
```
+
### 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.
+Due to higher resource use, it is recommended to use the importer with an exported file instead of the converter.
+
```bash
$ blockchain_converter --batch on --batch-size 20000
```