[unomi] 01/02: UNOMI-249 New shell commands to make plugin development easier Updated documentation for the new commands.

[sh...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

shuber pushed a commit to branch UNOMI-249-new-shell-commands
in repository https://gitbox.apache.org/repos/asf/unomi.git

commit 0f8e769d458d7f4647c7bd8e5103146ac59c805b
Author: Serge Huber <sh...@apache.org>
AuthorDate: Thu Sep 26 07:52:51 2019 +0200

    UNOMI-249 New shell commands to make plugin development easier
    Updated documentation for the new commands.
    
    Signed-off-by: Serge Huber <sh...@apache.org>
---
 manual/src/main/asciidoc/shell-commands.adoc | 33 +++++++++++++++++++++++++---
 1 file changed, 30 insertions(+), 3 deletions(-)

diff --git a/manual/src/main/asciidoc/shell-commands.adoc b/manual/src/main/asciidoc/shell-commands.adoc
index e544436..3a30ab5 100644
--- a/manual/src/main/asciidoc/shell-commands.adoc
+++ b/manual/src/main/asciidoc/shell-commands.adoc
@@ -115,6 +115,14 @@ created, EXECUTE means the rule's actions are being executed.
 |event-view
 |event-id
 |Dumps a single event in JSON. The `event-id` can be retrieved from the event-tail command output.
+|event-list
+|max-entries,--csv
+|List the last events processed by Apache Unomi. The `max-entries` parameter can be used to control how many events are
+displayed (default is 100). The `--csv` argument is used to output the list as a CSV list instead of an ASCII table.
+|event-search
+|profile-id,event-type,max-entries
+|This command makes it possible to search for the last events by `profile-id` and by `event-type`. A `max-entries`
+parameter (with a default value of 100) is also accepted to control the number of results returned by the search.
 
 |action-list
 |[--csv]
@@ -137,13 +145,21 @@ check that everything is properly registered. If you add the "--csv" option the
 |profile-view
 |profile-id
 |Dumps a single profile in JSON. The profile-id argument can be retrieved from the `profile-list` command output.
+|profile-remove
+|profile-id
+|Removes a profile identified by `profile-id` argument. Warning: no confirmation is asked so be careful with this command!
+
 |segment-list
 |[--csv]
-|Lists all the segments registered in the Apache Unomi server. If you add the "--csv" option the list will be output
-                                                               as a CSV formatted table
+|Lists all the segments registered in the Apache Unomi server. If you add the "--csv" option the list will be output as a CSV formatted table
 |segment-view
 |segment-id
 |Dumps a single segment in JSON. The segment-id argument can be retrieved from the `segment-list` command output.
+|segment-remove
+|segment-id
+|Removes a single segment identified by the `segment-id` argument. Warning: no confirmation is asked so be careful with
+this command!
+
 |session-list
 |[--csv]
 |Lists the last 10 sessions by last event date. If you add the "--csv" option the list will be output
@@ -152,10 +168,21 @@ check that everything is properly registered. If you add the "--csv" option the
 |session-id
 |Dumps a single session in JSON. The session-id argument can be retrieved from the `session-list`, `profile-list` or
  `event-tail` command output.
+
 |deploy-definition
 |[bundleId] [type] [fileName]
 |This command can be used to force redeployment of definitions from bundles. By default existing definitions will not
 be overriden unless they come from SNAPSHOT bundles. Using this command you can override this mechanism. Here are some
-examples of using this command: `unomi:deploy-definition 175 rule *` will redeploy all the rules provided by bundle with id 175. If you launch the command without any arguments you will get prompts for what you want to deploy from which bundle
+examples of using this command: `unomi:deploy-definition 175 rule *` will redeploy all the rules provided by bundle with
+id 175. If you launch the command without any arguments you will get prompts for what you want to deploy from which bundle.
+If you want to deploy all the definitions of a bundle you can also use wildcards such as in the following example: `deploy-definition 175 * *`.
+It is also possible to give no argument to this command and it will then interactively request the definitions you want
+to deploy.
+|undeploy-definition
+|[bundleId] [type] [fileName]
+|This command does the opposite of the `deploy-definition` command and works exactly the same way in terms of arguments
+and interactive mode except that it undeploys definitions instead of deploying them. This command can be very useful when
+working on a plugin. For example to remove all the definitions deployed by a plugin you can simply use the following
+command: `undeploy-definition BUNDLE_ID * *` when `BUNDLE_ID` is the identifier of the bundle that contains your plugin.
 
 |===
\ No newline at end of file