aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBen Johnson <benbjohnson@yahoo.com>2014-09-15 11:09:55 -0600
committerBen Johnson <benbjohnson@yahoo.com>2014-09-15 11:09:55 -0600
commit7022ade6e6fc69d1b013e76bc97d298eca13a080 (patch)
tree560a4dfd9f1fa079b7b1e7362e136fe3d7ea7afc
parentMerge pull request #252 from extemporalgenome/patch-1 (diff)
downloaddedo-7022ade6e6fc69d1b013e76bc97d298eca13a080.tar.gz
dedo-7022ade6e6fc69d1b013e76bc97d298eca13a080.tar.xz
Add caveat for memory usage.
This commit adds a caveat for high memory usage shown by processes with large Bolt databases. This is expected behavior and is handled by the OS page cache.
-rw-r--r--README.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/README.md b/README.md
index 67efda9..bde7eac 100644
--- a/README.md
+++ b/README.md
@@ -429,6 +429,13 @@ Here are a few things to note when evaluating and using Bolt:
more than 100,000 key/value pairs into a single new bucket in a single
transaction is not advised.
+* Bolt uses a memory-mapped file so the underlying operating system handles the
+ caching of the data. Typically, the OS will cache as much of the file as it
+ can in memory and will release memory as needed to other processes. This means
+ that Bolt can show very high memory usage when working with large databases.
+ However, this is expected and the OS will release memory as needed. Bolt can
+ handle databases much larger than the available physical RAM.
+
## Other Projects Using Bolt