chore: update changelog and config doc with more info about pebble (#10533)
* Update config doc with more info about Pebble Provide additional information about some key behaviors that may be useful for deciding what datastore to use.
Andrew Gillis committed
Oct 3, 2024 at 15:42 UTC
4566741b222a1dec8884080d7be3b3a9373f6956
1 file changed
+4
-3
docs/config.md
+4
-3
@@ -2426,10 +2426,11 @@ Pebble is a LevelDB/RocksDB inspired key-value store focused on performance and
2426
You should use this datastore if:
2427
2428
- You need a datastore that is focused on performance.
2429
+- You need a datastore that is good for multi-terrabyte data sets.
2430
- You need reliability by default, but may choose to disable WAL for maximum performance when reliability is not critical.
2430
-- This datastore is good for multi-terrabyte data sets.
2431
-- May benefit from tuning depending on read/write patterns and throughput.
2432
-- Performance is helped significantly by running on a system with plenty of memory.
2431
+- You want a datastore that does not need GC cycles and does not use more space than necessary
2432
+- You want a datastore that does not take several minutes to start with large repositories
2433
+- You want a datastore that performs well even with default settings, but can optimized by setting configuration to tune it for your specific needs.
2434
2435
> [!WARNING]
2436
> This profile may only be applied when first initializing the node via `ipfs init --profile pebbleds`