Merge pull request #9695 from EOSIO/docs-dev-mb-update

halsaphi · web-flow · commit cddd47653a4d · 2020-12-10T13:23:35.000+08:00
[docs] update docs to reflect updated code using 128MiB
diff --git a/docs/01_nodeos/02_usage/60_how-to-guides/10_how-to-configure-state-storage.md b/docs/01_nodeos/02_usage/60_how-to-guides/10_how-to-configure-state-storage.md
@@ -7,22 +7,28 @@ Version 2.1 or above of the EOSIO development environment.
 # Parameter Definitions 
 Specify which backing store to use with the `chain_plugin` `--backing-store` argument. This argument sets state storage to either `chainbase`, the default, or `rocksdb`.
 
+```console
 Config Options for eosio::chain_plugin:
 
   --backing-store arg (=chainbase)      The storage for state, chainbase or 
                                         rocksdb
-  --rocksdb-threads arg 	            Number of rocksdb threads for flush and
-                                        compaction. Defaults to the number of available cores. 
-  --rocksdb-files arg (=-1)             Max number of rocksdb files to keep 
+  --persistent-storage-num-threads arg 	Number of rocksdb threads for flush and
+                                        compaction.   
+  --persistent-storage-max-num-files arg (=-1)
+  										Max number of rocksdb files to keep 
                                         open. -1 = unlimited.
-  --rocksdb-write-buffer-size-mb arg (=134217728)
-                                        Size of a single rocksdb memtable
- 
+  --persistent-storage-write-buffer-size-mb arg (=128)
+                                        Size of a single rocksdb memtable (in MiB).
+  --persistent-storage-bytes-per-sync   Rocksdb write rate of flushes and compactions.
+  --persistent-storage-mbytes-snapshot-batch
+										Rocksdb batch size threshold before writing read in snapshot data to database.
+``` 
+
 # Procedure
 To use `rocksdb` for state storage:
 
 ```shell
-nodeos -e -p eosio --plugin eosio::producer_plugin --plugin eosio::producer_api_plugin --plugin eosio::chain_api_plugin --backing-store=’rocksdb’ --rocksdb-threads=’2’ --rocksdb-files=’2’ --rocksdb-write-buffer-size-mb=’134217728’  --plugin eosio::http_plugin 
+nodeos -e -p eosio --plugin eosio::producer_plugin --plugin eosio::producer_api_plugin --plugin eosio::chain_api_plugin --backing-store=’rocksdb’ --persistent-storage-num-threads=’2’ --persistent-storage-max-num-files=’2’ --persistent-storage-write-buffer-size-mb=’128’  --plugin eosio::http_plugin 
 ```
 
 To use `chainbase` for state storage:
@@ -37,4 +43,3 @@ or
 nodeos -e -p eosio --plugin eosio::producer_plugin --plugin eosio::producer_api_plugin --plugin eosio::chain_api_plugin --plugin eosio::http_plugin 
 ```
 
-# Next Steps
diff --git a/docs/01_nodeos/02_usage/index.md b/docs/01_nodeos/02_usage/index.md
@@ -8,3 +8,4 @@ This section explains how to use `nodeos`, lists its configuration options, desc
 * [Configuration](01_nodeos-configuration.md) - CLI vs. `config.ini` options; `nodeos` example.
 * [Node Setups](02_node-setups/index.md) - Producing vs. non-producing nodes setup.
 * [Development Environment](03_development-environment/index.md) - Setting up a development/test environment.
+* [How to Configure State Storage](60_how-to-guides/10_how-to-configure-state-storage.md) - How to configure  the `nodeos` `backing store`.
diff --git a/docs/01_nodeos/03_plugins/chain_plugin/index.md b/docs/01_nodeos/03_plugins/chain_plugin/index.md
@@ -115,13 +115,16 @@ Config Options for eosio::chain_plugin:
                                         drops below this size (in MiB).
   --backing-store arg (=chainbase)      The storage for state, chainbase or 
                                         rocksdb
-  --rocksdb-threads arg 	            Number of rocksdb threads for flush and
-                                        compaction.  Defaults to the number of 
-										available cores.  
-  --rocksdb-files arg (=-1)             Max number of rocksdb files to keep 
+  --persistent-storage-num-threads arg 	Number of rocksdb threads for flush and
+                                        compaction.
+  --persistent-storage-max-num-files arg (=-1)
+  										Max number of rocksdb files to keep 
                                         open. -1 = unlimited.
-  --rocksdb-write-buffer-size-mb arg (=134217728)
-                                        Size of a single rocksdb memtable
+  --persistent-storage-write-buffer-size-mb arg (=128)
+                                        Size of a single rocksdb memtable (in MiB).
+  --persistent-storage-bytes-per-sync   Rocksdb write rate of flushes and compactions.
+  --persistent-storage-mbytes-snapshot-batch
+										Rocksdb batch size threshold before writing read in snapshot data to database.
   --reversible-blocks-db-size-mb arg (=340)
                                         Maximum size (in MiB) of the reversible
                                         blocks database
