activemq-cli-tools git commit: Update README.md

Previous Topic Next Topic
 
classic Classic list List threaded Threaded
1 message Options
Reply | Threaded
Open this post in threaded view
|

activemq-cli-tools git commit: Update README.md

cshannon
Repository: activemq-cli-tools
Updated Branches:
  refs/heads/master e3066fda8 -> e872995ee


Update README.md

Updating README with usage instructions

Project: http://git-wip-us.apache.org/repos/asf/activemq-cli-tools/repo
Commit: http://git-wip-us.apache.org/repos/asf/activemq-cli-tools/commit/e872995e
Tree: http://git-wip-us.apache.org/repos/asf/activemq-cli-tools/tree/e872995e
Diff: http://git-wip-us.apache.org/repos/asf/activemq-cli-tools/diff/e872995e

Branch: refs/heads/master
Commit: e872995eed2c687c3651b8a7dad08f18550d973e
Parents: e3066fd
Author: Christopher L. Shannon <[hidden email]>
Authored: Mon Mar 13 07:56:12 2017 -0400
Committer: GitHub <[hidden email]>
Committed: Mon Mar 13 07:56:12 2017 -0400

----------------------------------------------------------------------
 README.md | 50 ++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 50 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/activemq-cli-tools/blob/e872995e/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index a843b8b..638460b 100644
--- a/README.md
+++ b/README.md
@@ -4,3 +4,53 @@ Apache ActiveMQ Command Line Tools
 The ActiveMQ Command Line Tools project is home to several CLI based projects
 useful for users of the ActiveMQ and ActiveMQ Artemis messaging brokers
 
+##ActiveMQ KahaDB Export Tool##
+
+This tool can be used to export a KahaDB or MultiKahaDB store to Artemis XML format.  The resulting XML document can then be imported into an Artemis broker using the Artemis CLI tool.  See [Artemis CLI tool](https://activemq.apache.org/artemis/docs/1.5.3/tools.html)
+
+###Usage###
+```
+$ ./bin/export help
+usage: export <command> [<args>]
+
+The most commonly used export commands are:
+    help      Display help information
+    kahadb    Export a KahaDb store to Artemis XML
+    mkahadb   Export a MultiKahaDb store to Artemis XML
+
+See 'export help <command>' for more information on a specific command.
+```
+```
+$ ./bin/export help kahadb
+NAME
+        export kahadb - Export a KahaDb store to Artemis XML
+
+SYNOPSIS
+        export kahadb [-c] [-f]
+                [(--qp <queuePattern> | --queuePattern <queuePattern>)]
+                (-s <source> | --source <source>) (-t <target> | --target <target>)
+                [(--tp <topicPattern> | --topicPattern <topicPattern>)]
+
+OPTIONS
+        -c
+            Compress output xml file using gzip
+
+        -f
+            Force XML output and overwrite existing file
+
+        --qp <queuePattern>, --queuePattern <queuePattern>
+            Queue Export Pattern
+
+        -s <source>, --source <source>
+            Data store directory location
+
+        -t <target>, --target <target>
+            Xml output file location
+
+        --tp <topicPattern>, --topicPattern <topicPattern>
+            Topic Export Pattern
+```
+
+###Example:###
+
+`./bin/export kahadb --source /some/directory/kahadb/ --target ~/some/directory/output.xml`