You are viewing a plain text version of this content. The canonical link for it is here.
Posted to oak-issues@jackrabbit.apache.org by "Chetan Mehrotra (JIRA)" <ji...@apache.org> on 2017/05/18 12:03:04 UTC
[jira] [Commented] (OAK-6236) Improve the help output from oak-run
commands
[ https://issues.apache.org/jira/browse/OAK-6236?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16015643#comment-16015643 ]
Chetan Mehrotra commented on OAK-6236:
--------------------------------------
The help output is now like below
{noformat}
Apache Jackrabbit Oak 1.8-SNAPSHOT
index {<path-to-repository> | <mongodb-uri>} | <rdb-uri>}
Provides index management related operations
Index command supports following operations. Most operations are read only. For performing them BloStore related
options must be provided as they would access the binaries stored there
Option Description
------ -----------
--index-out-dir <File> Directory used for output files (default: .)
--index-paths <String> Comma separated list of index paths for which the selected operations need to be performed
--index-work-dir <File> Work directory used for storing temp files (default: target)
Operations Description
---------- -----------
--index-consistency-check [Integer] Performs consistency check for indexes as specified by --index-paths. If none
specified performs check for all indexes. Currently this is only supported for
Lucene indexes. Possible values 1 - Basic check, 2 - Full check (slower)
(default: 1)
--index-definitions Collects and dumps index definitions
--index-dump Dumps index content
--index-info Collects and dumps information related to the indexes
DocumentNodeStore Options
=========================
Options related to constructing DocumentNodeStore
Option Description
------ -----------
--cacheSize <Integer> cache size (default: 0)
--clusterId <Integer> MongoMK clusterId (default: 0)
--disableBranches disable branches
RDBDocumentStore Options
========================
Options related to configuring RDBDocumentStore for DocumentNodeStore based setups
Option Description
------ -----------
--rdbjdbcpasswd [String] RDB JDBC password (default: )
--rdbjdbcuser [String] RDB JDBC user (default: )
BlobStore Options
=================
Options related to configuring a BlobStore
Option Description
------ -----------
--azureblobds <String> AzureBlobStorageDataStore config
--fds <String> FileDataStore config
--fds-path <String> FileDataStore path
--s3ds <String> S3DataStore config
Option Description
------ -----------
-?, -h, --help show help
--read-write connect to repository in read-write mode
{noformat}
> Improve the help output from oak-run commands
> ---------------------------------------------
>
> Key: OAK-6236
> URL: https://issues.apache.org/jira/browse/OAK-6236
> Project: Jackrabbit Oak
> Issue Type: Technical task
> Components: run
> Reporter: Chetan Mehrotra
> Assignee: Chetan Mehrotra
> Fix For: 1.8
>
>
> Default help output dumps all options in shot. From the output its not clear which is relevant to what. For e.g output below does not make it clear which option is relevent when connecting to DocumentNodeStore, which is for BlobStore etc.
> This should be improved to have separate section for different category of options
> {noformat}
> Non-option arguments:
> [String] -- {<path-to-repository> | <mongodb-uri>}
> Option Description
> ------ -----------
> -?, -h, --help show help
> --azureblobds <String> AzureBlobStorageDataStore config
> --cacheSize <Integer> cache size (default: 0)
> --clusterId <Integer> MongoMK clusterId (default: 0)
> --disableBranches disable branches
> --fds <String> FileDataStore config
> --fds-path <String> FileDataStore path
> --index-consistency-check [Integer] Performs consistency check for indexes as specified by --index-paths. If none
> specified performs check for all indexes. Currently this is only supported for
> Lucene indexes. Possible values 1 - Basic check, 2 - Full check (slower)
> (default: 1)
> --index-definitions Collects and dumps index definitions
> --index-dump Dumps index content
> --index-info Collects and dumps information related to the indexes
> --index-out-dir <File> Directory used for output files (default: .)
> --index-paths <String> Comma separated list of index paths for which the selected operations need to be
> performed
> --index-work-dir <File> Work directory used for storing temp files (default: target)
> --rdbjdbcpasswd [String] RDB JDBC password (default: )
> --rdbjdbcuser [String] RDB JDBC user (default: )
> --read-write connect to repository in read-write mode
> --s3ds <String> S3DataStore config
> {noformat}
--
This message was sent by Atlassian JIRA
(v6.3.15#6346)