You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.rst
+17-5
Original file line number
Diff line number
Diff line change
@@ -130,11 +130,23 @@ The general synopsis is as follows:
130
130
131
131
* ``--validate-db`` - Flag to revalidate all on-disk database files
132
132
133
-
* ``--in-memory-ledger-db-backend`` - Optionally use the in-memory backend of the UTxO HD feature: store the complete ledger state in memory. Incompatible with ``--lmdb-ledger-db-backend``.
134
-
135
-
* ``--lmdb-ledger-db-backend`` - Optionally use the LMDB backend of the UTxO HD feature: store parts of the ledger state on disk. Incompatible with ``--in-memory-ledger-db-backend``. The node uses the LMDB backend by default if no ``--*-db-backend`` flags are set.
136
-
137
-
* ``--lmdb-mapsize`` - Optionally set the mapsize (maximum database size) for the LMDB backend. By default, the mapsize (maximum database size) of the backend is set to 16 Gigabytes. Warning: if the database size exceeds the given mapsize, the node will abort. Therefore, the mapsize should be set to a value high enough to guarantee that the maximum database size will not be reached during the expected node uptime.
133
+
* ``--in-memory-ledger-db-backend`` - Use the in-memory backend to store the
134
+
UTxO portion of the ledger state in memory. As a result, the whole ledger
135
+
state will be stored in memory. Incompatible with
136
+
``--lmdb-ledger-db-backend``.
137
+
* ``--lmdb-ledger-db-backend`` - Use the LMDB backend to store the UTxO portion
138
+
of the ledger state on disk. The remainder of the ledger state will still be
139
+
stored in memory. Incompatible with ``--in-memory-ledger-db-backend``. The
140
+
node uses the LMDB backend by default if no ``--*-db-backend`` flags are set.
141
+
142
+
* ``--lmdb-mapsize`` - Set the maximum database size (mapsize) for the LMDB
143
+
backend. By default, the mapsize of the backend is set to 16 Gigabytes.
144
+
Warning: if the database size exceeds the given mapsize, the node will
145
+
abort. Therefore, the mapsize should be set to a value high enough to
146
+
guarantee that the maximum database size will not be reached during the
147
+
expected node uptime. The current default value is sufficient to offer this
148
+
guarantee, and setting the mapsize to anything less is therefore not
Copy file name to clipboardExpand all lines: doc/getting-started/understanding-config-files.md
+20-6
Original file line number
Diff line number
Diff line change
@@ -356,11 +356,22 @@ It is also possible to have more fine grained control over filtering of trace ou
356
356
}
357
357
```
358
358
359
-
#### UTxO HD
360
-
361
-
The UTxO HD feature of the consensus layer allows parts of the ledger state to be stored on-disk, whereas consensus previously kept the whole ledger state in memory. The node can be configured to use any of two *backends*:
362
-
363
-
* The *LMDB backend*, which is built around a Lightning Memory-Mapped Database (LMDB), stores parts of the ledger state on disk. Optionally, a configuration can be included that sets the mapsize (maximum size) of the on-disk database that is used to store parts of the ledger state. By default, the mapsize is set to 16 Gigabytes. **Warning**: if the database size exceeds the given mapsize, the node will abort. Therefore, the mapsize should be set to a value high enough to guarantee that the maximum database size will not be reached during the expected node uptime.
359
+
#### Ledger state on disk
360
+
361
+
The UTxO HD feature of the consensus layer allows parts of the ledger state
362
+
to be stored on disk, as opposed to keeping the whole ledger state in memory.
363
+
The node can be configured to use any of two *backends*:
364
+
365
+
* The *LMDB backend*, which is built around a [Lightning Memory-Mapped Database
366
+
(LMDB)](http://www.lmdb.tech/doc/index.html), stores parts of the ledger state
367
+
on disk. Optionally, a configuration can be included that sets the maximum
368
+
database size (mapsize) of the on-disk database that is used to store parts of
369
+
the ledger state. By default, the mapsize is set to 16 Gigabytes. **Warning**:
370
+
if the database size exceeds the given mapsize, the node will abort. Therefore,
371
+
the mapsize should be set to a value high enough to guarantee that the maximum
372
+
database size will not be reached during the expected node uptime. The current
373
+
default value is sufficient to offer this guarantee, and setting the mapsize
374
+
to anything less is therefore not recommended.
364
375
```json
365
376
"LedgerDBBackend": "LMDB",
366
377
"LMDBMapSize": "16G",
@@ -370,4 +381,7 @@ The UTxO HD feature of the consensus layer allows parts of the ledger state to b
370
381
"LedgerDBBackend": "InMemory",
371
382
```
372
383
373
-
If no choice of backend is configured, then the node defaults to using the LMDB backend with the *default* mapsize. It is recommended not to opt for the in-memory backend if the machine that is running the node is constrained by the amount of available memory.
384
+
If no choice of backend is given, then the node defaults to using the LMDB
385
+
backend with the *default* mapsize. It is recommended not to opt for the
386
+
in-memory backend if the machine that is running the node is memory
0 commit comments