Author: mreutegg
Date: Wed Oct 19 08:43:28 2016
New Revision: 1765557
URL: http://svn.apache.org/viewvc?rev=1765557&view=rev
Log:
OAK-4900: Enable persistent caches by default
Update documentation
Modified:
jackrabbit/oak/trunk/oak-doc/src/site/markdown/nodestore/persistent-cache.md
jackrabbit/oak/trunk/oak-doc/src/site/markdown/osgi_config.md
Modified:
jackrabbit/oak/trunk/oak-doc/src/site/markdown/nodestore/persistent-cache.md
URL:
http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-doc/src/site/markdown/nodestore/persistent-cache.md?rev=1765557&r1=1765556&r2=1765557&view=diff
==============================================================================
---
jackrabbit/oak/trunk/oak-doc/src/site/markdown/nodestore/persistent-cache.md
(original)
+++
jackrabbit/oak/trunk/oak-doc/src/site/markdown/nodestore/persistent-cache.md
Wed Oct 19 08:43:28 2016
@@ -27,19 +27,17 @@ the load on the storage backend.
###Â OSGi Configuration
-The OSGi configuration of the persistent cache is:
+The default OSGi configuration of the persistent cache is:
org.apache.jackrabbit.oak.plugins.document.DocumentNodeStoreService
- persistentCache=./cache
+ persistentCache=cache,binary=0
-This will enable the persistent cache, and set the configuration option to
"./cache".
-
-### Configuration Options
+### Configuration Options
The persistent cache configuration setting is string with a number of comma
separated elements.
The first element is the directory where the cache is stored. Example:
- ./cache
+ cache
In this case, the data is stored in the directory "cache",
relative to the `repository.home` directory. If no repository home directory is
@@ -85,20 +83,29 @@ To disable this option, use "-compress".
Those setting can be appended to the persistent cache configuration string.
An example configuration is:
- ./cache,size=2048,binary=0,-compact,-compress
+ cache,size=2048,binary=0,-compact,-compress
+
+To disable the persistent cache entirely, use the following configuration:
+
+ org.apache.jackrabbit.oak.plugins.document.DocumentNodeStoreService
+ persistentCache=-
### Journal cache
-Diff cache entries can also be stored in a separate persistent cache and
-configured independently if needed. This can be enabled in the OSGi
+Since Oak 1.6.
+
+Diff cache entries can also are stored in a separate persistent cache and
+configured independently if needed. This can be done in the OSGi
configuration like in the following example:
org.apache.jackrabbit.oak.plugins.document.DocumentNodeStoreService
- persistentCache=./cache,size=2048
- journalCache=./journal,size=1024
+ persistentCache=cache,size=2048
+ journalCache=diff-cache,size=1024
The configuration options are the same as for the `persistentCache`, but
options
-unrelated to the diff cache type are ignored.
+unrelated to the diff cache type are ignored. The default configuration is
+`journalCache=diff-cache` and can be disabled the same way as the
+regular persistent cache with a dash: `journalCache=-`.
###Â Dependencies
Modified: jackrabbit/oak/trunk/oak-doc/src/site/markdown/osgi_config.md
URL:
http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-doc/src/site/markdown/osgi_config.md?rev=1765557&r1=1765556&r2=1765557&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-doc/src/site/markdown/osgi_config.md (original)
+++ jackrabbit/oak/trunk/oak-doc/src/site/markdown/osgi_config.md Wed Oct 19
08:43:28 2016
@@ -111,7 +111,7 @@ blobCacheSize
`blobCacheSize`.
persistentCache
-: Default "" (an empty string, meaning disabled)
+: Default "cache,binary=0" (prior to 1.6, the persistent cache was disabled by
default)
: The [persistent cache][persistent-cache], which is stored in the local file
system.
<a name="cache-allocation"></a>
