diff --git a/oak-doc/src/site/markdown/command_line.md b/oak-doc/src/site/markdown/command_line.md index 716ef65..3ce1705 100644 --- a/oak-doc/src/site/markdown/command_line.md +++ b/oak-doc/src/site/markdown/command_line.md @@ -26,7 +26,7 @@ This tool supports maintenance operations such as backup and compaction. To back up a repository, use: java -mx4g -jar oak-run-*.jar backup - + When using the (default) Tar storage, the `` setting is the path to the directory that contains the segment (data*.tar) files. The `` option is the target directory. @@ -36,15 +36,30 @@ The `` option is the target directory. To list the checkpoints of a repository, use: java -mx4g -jar oak-run-*.jar checkpoint - + When using the (default) Tar storage, the `` setting is the path to the directory that contains the segment (data*.tar) files. -#### Using Memory Mapped Files +#### Compaction + +The oak-run compact operation may be used to perform an offline compaction: + + java -mx4g -jar oak-run-*.jar compact [--force] + +It makes sense to find and remove the old checkpoints, using the `checkpoint` +command described above. + +#### System properties supported by the oak-run + +When performing operations on the SegmentNodeStore (eg. backup, checkpoint, compact), it's +possible to tweak various system properties to get the optimal performance. These are: + +* `cache` - cache size for the SegmentNodeStore (default: `256`), +* `compaction-progress-log` - how many entries should be compacted between log messages (default: `150000`), +* `compress-interval` - number of map entries to keep until compressing this map (default: `100000`), +* `update.limit` - threshold for the flush of a temporary transaction to disk (default: `10000`), +* `tar.memoryMapped` - allow to use memory mapped files to reduce memory usage (default: `false`), -When using the Tar storage, some operations, for example backup and checkpoint, -allow to use memory mapped files to reduce memory usage. -To use this option, set the system property `tar.memoryMapped` to `true`. Example: java -Dtar.memoryMapped=true -mx4g -jar oak-run-*.jar checkpoint