Jackrabbit Oak 是一个可扩展的高性能分层内容存储库，旨在用作现代世界级网站和其他要求苛刻的内容应用程序的基础

Oak Runnable Jar ================ This jar contains everything you need for a simple Oak installation. The following runmodes are currently available: * backup : Backup an existing Oak repository * check : Check the FileStore for inconsistencies * checkpoints : Manage checkpoints * clusternodes : Display DocumentMK cluster node information * compact : Segment compaction on a TarMK repository * console : Start an interactive console * datastorecacheupgrade : Upgrades the JR2 DataStore cache * datastorecheck : Consistency checker for data store * datastore : Maintenance operations for the for data store * debug : Print status information about an Oak repository * documentstore-check : Check a DocumentStore for inconsistencies * explore : Starts a GUI browser based on java swing * export : Export repository content as json * frozennoderefsbyscanning : Scan for nt:frozenNode references via query * frozennoderefsusingindex : Scan for nt:frozenNode references via /oak:index * garbage : Identifies blob garbage on a DocumentMK repository * help : Print a list of available runmodes * history : Trace the history of a node * iotrace : Collect a trace of segment store read accesses * recovery : Run a _lastRev recovery on a DocumentMK repository * resetclusterid : Resets the cluster id * restore : Restore a backup of an Oak repository * revisions : Revision GC on a DocumentMK * server : Run the Oak Server * tarmkdiff : Show changes between revisions on TarMk * tika : Performs text extraction * unlockUpgrade : Unlock a DocumentMK upgrade to a newer version * upgrade : Migrate existing Jackrabbit 2.x repository to Oak Some of the features related to Jackrabbit 2.x are provided by oak-run-jr2 jar. See the [Oak Runnable JR2](#jr2) section for more details. Logging ------- Oak run uses [Logback](https://logback.qos.ch/) for logging. To customize the logging you can specify a custom logback config file via `logback.configurationFile` system property java -Dlogback.configurationFile=./logback.xml -jar oak-run-*.jar console /path/to/oak/repository See [here](https://github.com/apache/jackrabbit-oak/blob/trunk/oak-run/src/main/resources/logback.xml) for the default logback config file used Command Line Format ------------------- Oak run uses [joptsimple](http://jopt-simple.github.io/jopt-simple/) library for parsing the command line options. * A option's argument can occur: * `--foo=bar` - right up against the option separated by an equals sign (=) * `--foo bar` - in the position on the command line after the option * `--foo=bar,baz` - Sets multiple values for option `foo` separated by `,` * `--foo` - Enables `foo` option where foo is a boolean option. * Most commands provide help via `-h` option * An argument consisting only of two hyphens (--) signals that the remaining arguments are to be treated as non-options. Refer to [examples](http://jopt-simple.github.io/jopt-simple/examples.html) for more details ---- See the subsections below for more details on how to use these modes. Backup ------ See the [official documentation](http://jackrabbit.apache.org/oak/docs/nodestore/segment/overview.html#backup). Restore ------- See the [official documentation](http://jackrabbit.apache.org/oak/docs/nodestore/segment/overview.html#restore). Debug ----- See the [official documentation](http://jackrabbit.apache.org/oak/docs/nodestore/segment/overview.html#debug). IOTrace ----- See the [official documentation](http://jackrabbit.apache.org/oak/docs/nodestore/segment/overview.html#iotrace). Console ------- The 'console' mode allows to work with an interactive console and browse an existing oak repository. Type ':help' within the console to get a list of all supported commands. The console currently supports TarMK and MongoMK. To start the console for a TarMK repository, use: $ java -jar oak-run-*.jar console /path/to/oak/repository To start the console for a DocumentMK/Mongo repository, use: $ java -jar oak-run-*.jar console mongodb://host To start the console for a DocumentMK/RDB repository, see the [documention for oak-run on RDB](https://jackrabbit.apache.org/oak/docs/nodestore/document/rdb-document-store.html#oak-run). To start the console connecting to a repository in read-write mode, use either of: $ java -jar oak-run-*.jar console --read-write /path/to/oak/repository $ java -jar oak-run-*.jar console --read-write mongodb://host $ java -jar oak-run-*.jar console --read-write --rdbjdbcuser username --rdbjdbcpasswd password console jdbc:... To specify FDS path while connecting to a repository, use `--fds-path` option (valid for segment and document repos): $ java -jar oak-run-*.jar console --fds-path /path/to-data/store /path/to/oak/repository Console is based on [Groovy Shell](http://groovy.codehaus.org/Groovy+Shell) and hence one can use all Groovy constructs. It also exposes the `org.apache.jackrabbit.oak.console.ConsoleSession` instance as through `session` variable. For example when using SegmentNodeStore you can dump the current segment info to a file > new File("segment.txt") << session.workingNode.segment.toString() In above case the `workingNode` captures the current `NodeState` which in case of Segment/TarMK is `SegmentNodeState` You can also load external script at launch time via passing an extra argument as shown below $ java -jar oak-run-*.jar console mongodb://host ":load /path/to/script.groovy" DocumentStore Check ------------------- The `documentstore-check` command runs a consistency check on a DocumentStore based repository. It can be invoked like this: $ java -jar oak-run-*.jar documentstore-check [options] mongodb://host:port/database (or, for RDBMK instances, use "jdbc:..."). The following options are currently supported: Option Description ------ ----------- -?, -h, --help show help --baseVersion [Boolean] Check base version reference (default: true) --cacheSize <Integer> cache size (default: 0) --numThreads <Integer> Use this number of threads to check consistency (default: 12) --orphan [Boolean] Check for orphaned nodes (default: true) --out <String> Write output to this file --progress [Boolean] Write periodic progress messages (default: true) --rdbjdbcpasswd [String] RDB JDBC password (default: ) --rdbjdbcuser [String] RDB JDBC user (default: ) --rdbtableprefix [String] RDB table prefix --silent Do not write output to stdout --summary [Boolean] Write a summary message at the end (default: true) --versionHistory [Boolean] Check version history reference (default: true) The command uses a pool of threads to check consistency of the repository. The size of the pool is determined by the number of available cores, unless specified explicitly with the `--numThreads` option. Explore ------- The 'explore' mode starts a desktop browser GUI based on java swing which allows for read-only browsing of an existing oak repository. $ java -jar oak-run-*.jar explore /path/to/oak/repository [--skip-size-check] Microsoft Azure node stores are also supported using the following command. The secret key must be supplied as an environment variable `AZURE_SECRET_KEY`. $ java -jar oak-run-*.jar explore az:https://myaccount.blob.core.windows.net/container/repository [--skip-size-check] If using a Shared Access Signature, the SAS token has to be appended to the azure URI. $ java -jar oak-run-*.jar explore az:https://myaccount.blob.core