Merge pull request #1804 from richardkchapman/PackageCommandsinECL

gh#1579 --  Add sections for ecl package commands

Reviewed-By: Richard Chapman <rchapman@hpccsystems.com>

docs/CT_ECL_CLI.xml

@@ -67,7 +67,7 @@
               <row>
                 <entry>unpublish</entry>
 
-                <entry>Remove a query from a query set </entry>
+                <entry>Remove a query from a query set</entry>
               </row>
 
               <row>
@@ -86,14 +86,20 @@
               <row>
                 <entry>deactivate</entry>
 
-                <entry>Deactivate the given query alias name </entry>
+                <entry>Deactivate the given query alias name</entry>
               </row>
 
               <row>
-                <entry>queries </entry>
+                <entry>queries</entry>
 
                 <entry>List or manipulate queries and querysets</entry>
               </row>
+
+              <row>
+                <entry>package</entry>
+
+                <entry>execute package commands (for Roxie)</entry>
+              </row>
             </tbody>
           </tgroup>
         </informaltable>
@@ -119,7 +125,7 @@ ecl deploy --cluster=roxie --name=FindPersonService libW20120224-125557.so
 </programlisting>
 
         <para>A hyphen (-) specifies that the object should be read from
-        stdin. </para>
+        stdin.</para>
 
         <para><informaltable colsep="0" frame="none" rowsep="0">
             <tgroup cols="2">
@@ -189,7 +195,7 @@ ecl deploy --cluster=roxie --name=FindPersonService libW20120224-125557.so
                 <row>
                   <entry>--port</entry>
 
-                  <entry>The eclwatch services port</entry>
+                  <entry>The eclwatch services port (Default is 8010)</entry>
                 </row>
 
                 <row>
@@ -228,15 +234,15 @@ ecl deploy --cluster=roxie --name=FindPersonService libW20120224-125557.so
                 <row>
                   <entry>-Ipath</entry>
 
-                  <entry>Add path to locations to search for ecl imports
-                  </entry>
+                  <entry>Add path to locations to search for ecl
+                  imports</entry>
                 </row>
 
                 <row>
                   <entry>-Lpath</entry>
 
-                  <entry>Add path to locations to search for system libraries
-                  </entry>
+                  <entry>Add path to locations to search for system
+                  libraries</entry>
                 </row>
 
                 <row>
@@ -256,8 +262,8 @@ ecl deploy --cluster=roxie --name=FindPersonService libW20120224-125557.so
         [--name=&lt;val&gt;] [--activate] &lt;wuid&gt; </emphasis></para>
 
         <para><emphasis role="bold">ecl publish [--cluster=&lt;val&gt;]
-        [--name=&lt;val&gt;] [--activate] &lt;so | dll | - &gt;</emphasis>
-        </para>
+        [--name=&lt;val&gt;] [--activate] &lt;so | dll | -
+        &gt;</emphasis></para>
 
         <para><emphasis role="bold">ecl publish --cluster=&lt;val&gt;
         --name=&lt;val&gt; [--activate] &lt;archive | - &gt;
@@ -276,7 +282,7 @@ ecl publish --cluster=roxie --name=FindPersonService --activate findperson.ecl
 </programlisting>
 
         <para>A hyphen (-) specifies that the object should be read from
-        stdin. </para>
+        stdin.</para>
 
         <para><informaltable colsep="0" frame="none" rowsep="0">
             <tgroup cols="2">
@@ -365,7 +371,7 @@ ecl publish --cluster=roxie --name=FindPersonService --activate findperson.ecl
                 <row>
                   <entry>--port</entry>
 
-                  <entry>The eclwatch services port</entry>
+                  <entry>The eclwatch services port (Default is 8010)</entry>
                 </row>
 
                 <row>
@@ -487,7 +493,7 @@ ecl publish --cluster=roxie --name=FindPersonService --activate findperson.ecl
                 <row>
                   <entry>--port</entry>
 
-                  <entry>The eclwatch services port</entry>
+                  <entry>The eclwatch services port (Default is 8010)</entry>
                 </row>
 
                 <row>
@@ -539,7 +545,7 @@ ecl run --cluster=thor --input="&lt;request&gt;&lt;LName&gt;JONES&lt;/LName&gt;&
 </programlisting>
 
         <para>A hyphen (-) specifies that the object should be read from
-        stdin. </para>
+        stdin.</para>
 
         <para><informaltable colsep="0" frame="none" rowsep="0">
             <tgroup cols="2">
@@ -628,7 +634,7 @@ ecl run --cluster=thor --input="&lt;request&gt;&lt;LName&gt;JONES&lt;/LName&gt;&
                 <row>
                   <entry>--port</entry>
 
-                  <entry>The eclwatch services port</entry>
+                  <entry>The eclwatch services port (Default is 8010)</entry>
                 </row>
 
                 <row>
@@ -750,7 +756,7 @@ ecl run --cluster=thor --input="&lt;request&gt;&lt;LName&gt;JONES&lt;/LName&gt;&
                 <row>
                   <entry>--port</entry>
 
-                  <entry>The eclwatch services port</entry>
+                  <entry>The eclwatch services port (Default is 8010)</entry>
                 </row>
 
                 <row>
@@ -831,7 +837,7 @@ ecl run --cluster=thor --input="&lt;request&gt;&lt;LName&gt;JONES&lt;/LName&gt;&
                 <row>
                   <entry>--port</entry>
 
-                  <entry>The eclwatch services port</entry>
+                  <entry>The eclwatch services port (Default is 8010)</entry>
                 </row>
 
                 <row>
@@ -895,8 +901,8 @@ ecl queries list roxie myroxie --show=A </programlisting>
                 <row>
                   <entry>queryset</entry>
 
-                  <entry>The name of queryset from which to list queries
-                  </entry>
+                  <entry>The name of queryset from which to list
+                  queries</entry>
                 </row>
 
                 <row>
@@ -925,7 +931,7 @@ ecl queries list roxie myroxie --show=A </programlisting>
                 <row>
                   <entry>A</entry>
 
-                  <entry>Active </entry>
+                  <entry>Active</entry>
                 </row>
 
                 <row>
@@ -960,7 +966,7 @@ ecl queries list roxie myroxie --show=A </programlisting>
                 <row>
                   <entry>--port</entry>
 
-                  <entry>The eclwatch services port</entry>
+                  <entry>The eclwatch services port (Default is 8010)</entry>
                 </row>
 
                 <row>
@@ -991,7 +997,7 @@ ecl queries list roxie myroxie --show=A </programlisting>
 ecl queries copy //192.168.1.10:8010/thor/findperson thor
 </programlisting>
 
-        <para>Provides usage options for ecl queries command.</para>
+        <para></para>
 
         <para><informaltable colsep="0" frame="none" rowsep="0">
             <tgroup cols="2">
@@ -1013,7 +1019,7 @@ ecl queries copy //192.168.1.10:8010/thor/findperson thor
                 <row>
                   <entry>copy</entry>
 
-                  <entry>Copy a query from one queryset to another </entry>
+                  <entry>Copy a query from one queryset to another</entry>
                 </row>
 
                 <row>
@@ -1049,10 +1055,609 @@ ecl queries copy //192.168.1.10:8010/thor/findperson thor
                 </row>
 
                 <row>
+                  <entry>-v, --verbose</entry>
+
+                  <entry>Output additional tracing information</entry>
+                </row>
+
+                <row>
+                  <entry>-s, --server</entry>
+
+                  <entry>The IP Address of ESP server running eclwatch
+                  services</entry>
+                </row>
+
+                <row>
+                  <entry>--port</entry>
+
+                  <entry>The eclwatch services port (Default is 8010)</entry>
+                </row>
+
+                <row>
+                  <entry>-u, --username</entry>
+
+                  <entry>The username (if necessary)</entry>
+                </row>
+
+                <row>
+                  <entry>-pw, --password</entry>
+
+                  <entry>The password (if necessary)</entry>
+                </row>
+              </tbody>
+            </tgroup>
+          </informaltable></para>
+      </sect2>
+
+      <sect2 role="brk">
+        <title>ecl package add</title>
+
+        <para><emphasis role="bold">ecl package add [options]
+        [&lt;filename&gt;]</emphasis></para>
+
+        <para>Examples:</para>
+
+        <programlisting>ecl package add --queryset=roxie mypackage.pkg -s=192.168.1.10
+ecl package add --queryset=roxie mypkg.pkg --overwritename=false
+</programlisting>
+
+        <para></para>
+
+        <para><informaltable colsep="0" frame="none" rowsep="0">
+            <tgroup cols="2">
+              <colspec align="left" colwidth="125.55pt" />
+
+              <colspec colwidth="384.85pt" />
+
+              <tbody>
+                <row>
+                  <entry>ecl package add</entry>
+
+                  <entry>Calls the package add command</entry>
+                </row>
+
+                <row>
+                  <entry><emphasis role="bold">Actions</emphasis></entry>
+                </row>
+
+                <row>
+                  <entry>add</entry>
+
+                  <entry>Adds a package to the environment</entry>
+                </row>
+
+                <row>
+                  <entry><emphasis role="bold">Options</emphasis></entry>
+                </row>
+
+                <row>
+                  <entry>--queryset</entry>
+
+                  <entry>The name of the queryset to which the information
+                  should be associated</entry>
+                </row>
+
+                <row>
+                  <entry>--overwritename</entry>
+
+                  <entry>[true | false] Whether to overwrite existing
+                  information - defaults to true</entry>
+                </row>
+
+                <row>
+                  <entry>-v, --verbose</entry>
+
+                  <entry>Output additional tracing information</entry>
+                </row>
+
+                <row>
+                  <entry>-s, --server</entry>
+
+                  <entry>The IP Address of ESP server running eclwatch
+                  services</entry>
+                </row>
+
+                <row>
+                  <entry>--port</entry>
+
+                  <entry>The eclwatch services port (Default is 8010)</entry>
+                </row>
+
+                <row>
+                  <entry>-u, --username</entry>
+
+                  <entry>The username (if necessary)</entry>
+                </row>
+
+                <row>
+                  <entry>-pw, --password</entry>
+
+                  <entry>The password (if necessary)</entry>
+                </row>
+              </tbody>
+            </tgroup>
+          </informaltable></para>
+      </sect2>
+
+      <sect2 role="brk">
+        <title>ecl package copyFiles</title>
+
+        <para><emphasis role="bold">ecl package copyFiles [options]
+        [&lt;filename&gt;]</emphasis></para>
+
+        <para>Examples:</para>
+
+        <programlisting>ecl package copyFiles  --process=myroxie  --daliip=192.168.1.10
+ecl package copyFiles 
+</programlisting>
+
+        <para></para>
+
+        <para><informaltable colsep="0" frame="none" rowsep="0">
+            <tgroup cols="2">
+              <colspec align="left" colwidth="125.55pt" />
+
+              <colspec colwidth="384.85pt" />
+
+              <tbody>
+                <row>
+                  <entry>ecl package copyFiles</entry>
+
+                  <entry>Calls the package copyFiles command</entry>
+                </row>
+
+                <row>
+                  <entry><emphasis role="bold">Actions</emphasis></entry>
+                </row>
+
+                <row>
+                  <entry>copyFiles</entry>
+
+                  <entry>Copy missing data files to the appropriate
+                  cluster</entry>
+                </row>
+
+                <row>
                   <entry><emphasis role="bold">Options</emphasis></entry>
                 </row>
 
                 <row>
+                  <entry>--process</entry>
+
+                  <entry>The process name of the cluster to which to copy
+                  files</entry>
+                </row>
+
+                <row>
+                  <entry>--daliip</entry>
+
+                  <entry>IP Address of of the source Dali to use for file
+                  lookups</entry>
+                </row>
+
+                <row>
+                  <entry>-v, --verbose</entry>
+
+                  <entry>Output additional tracing information</entry>
+                </row>
+
+                <row>
+                  <entry>-s, --server</entry>
+
+                  <entry>The IP Address of ESP server running eclwatch
+                  services</entry>
+                </row>
+
+                <row>
+                  <entry>--port</entry>
+
+                  <entry>The eclwatch services port (Default is 8010)</entry>
+                </row>
+
+                <row>
+                  <entry>-u, --username</entry>
+
+                  <entry>The username (if necessary)</entry>
+                </row>
+
+                <row>
+                  <entry>-pw, --password</entry>
+
+                  <entry>The password (if necessary)</entry>
+                </row>
+              </tbody>
+            </tgroup>
+          </informaltable></para>
+      </sect2>
+
+      <sect2 role="brk">
+        <title>ecl package delete</title>
+
+        <para><emphasis role="bold">ecl package delete [options]
+        [&lt;filename&gt;]</emphasis></para>
+
+        <para>Examples:</para>
+
+        <programlisting>ecl package delete --queryset=roxie mypackage.pkg -s=192.168.1.10
+ecl package delete --queryset=roxie mypkg.pkg --overwritename=false
+</programlisting>
+
+        <para></para>
+
+        <para><informaltable colsep="0" frame="none" rowsep="0">
+            <tgroup cols="2">
+              <colspec align="left" colwidth="125.55pt" />
+
+              <colspec colwidth="384.85pt" />
+
+              <tbody>
+                <row>
+                  <entry>ecl package delete</entry>
+
+                  <entry>Calls the package delete command</entry>
+                </row>
+
+                <row>
+                  <entry><emphasis role="bold">Actions</emphasis></entry>
+                </row>
+
+                <row>
+                  <entry>delete</entry>
+
+                  <entry>Deletes a package</entry>
+                </row>
+
+                <row>
+                  <entry><emphasis role="bold">Options</emphasis></entry>
+                </row>
+
+                <row>
+                  <entry>--queryset</entry>
+
+                  <entry>The name of the queryset to which the information is
+                  associated</entry>
+                </row>
+
+                <row>
+                  <entry>-v, --verbose</entry>
+
+                  <entry>Output additional tracing information</entry>
+                </row>
+
+                <row>
+                  <entry>-s, --server</entry>
+
+                  <entry>The IP Address of ESP server running eclwatch
+                  services</entry>
+                </row>
+
+                <row>
+                  <entry>--port</entry>
+
+                  <entry>The eclwatch services port (Default is 8010)</entry>
+                </row>
+
+                <row>
+                  <entry>-u, --username</entry>
+
+                  <entry>The username (if necessary)</entry>
+                </row>
+
+                <row>
+                  <entry>-pw, --password</entry>
+
+                  <entry>The password (if necessary)</entry>
+                </row>
+              </tbody>
+            </tgroup>
+          </informaltable></para>
+      </sect2>
+
+      <sect2 role="brk">
+        <title>ecl package activate</title>
+
+        <para><emphasis role="bold">ecl package activate [options]
+        &lt;querySetName&gt; </emphasis></para>
+
+        <para><emphasis role="bold">Example:</emphasis></para>
+
+        <programlisting>ecl package activate --packagemap=mypkg.pkg roxie</programlisting>
+
+        <para></para>
+
+        <para><informaltable colsep="0" frame="none" rowsep="0">
+            <tgroup cols="2">
+              <colspec align="left" colwidth="125.55pt" />
+
+              <colspec colwidth="384.85pt" />
+
+              <tbody>
+                <row>
+                  <entry>ecl package activate</entry>
+
+                  <entry>Activates a package</entry>
+                </row>
+
+                <row>
+                  <entry><emphasis role="bold">Arguments</emphasis></entry>
+                </row>
+
+                <row>
+                  <entry>querySetName</entry>
+
+                  <entry>The name of queryset referred to in the
+                  package</entry>
+                </row>
+
+                <row>
+                  <entry><emphasis role="bold">Options</emphasis></entry>
+                </row>
+
+                <row>
+                  <entry>--packagemap</entry>
+
+                  <entry>name of packagemap to update</entry>
+                </row>
+
+                <row>
+                  <entry>-v, --verbose</entry>
+
+                  <entry>Output additional tracing information</entry>
+                </row>
+
+                <row>
+                  <entry>-s, --server</entry>
+
+                  <entry>The IP Address of ESP server running eclwatch
+                  services</entry>
+                </row>
+
+                <row>
+                  <entry>--port</entry>
+
+                  <entry>The eclwatch services port (Default is 8010)</entry>
+                </row>
+
+                <row>
+                  <entry>-u, --username</entry>
+
+                  <entry>The username (if necessary)</entry>
+                </row>
+
+                <row>
+                  <entry>-pw, --password</entry>
+
+                  <entry>The password (if necessary)</entry>
+                </row>
+              </tbody>
+            </tgroup>
+          </informaltable></para>
+      </sect2>
+
+      <sect2 role="brk">
+        <title>ecl package deactivate</title>
+
+        <para><emphasis role="bold">ecl package deactivate [options]
+        &lt;querySetName&gt; </emphasis></para>
+
+        <para><emphasis role="bold">Example:</emphasis></para>
+
+        <programlisting>ecl package deactivate --packagemap=mypkg.pkg roxie</programlisting>
+
+        <para></para>
+
+        <para><informaltable colsep="0" frame="none" rowsep="0">
+            <tgroup cols="2">
+              <colspec align="left" colwidth="125.55pt" />
+
+              <colspec colwidth="384.85pt" />
+
+              <tbody>
+                <row>
+                  <entry>ecl package deactivate</entry>
+
+                  <entry>Deactivates a package</entry>
+                </row>
+
+                <row>
+                  <entry><emphasis role="bold">Arguments</emphasis></entry>
+                </row>
+
+                <row>
+                  <entry>querySetName</entry>
+
+                  <entry>The name of queryset referred to in the
+                  package</entry>
+                </row>
+
+                <row>
+                  <entry><emphasis role="bold">Options</emphasis></entry>
+                </row>
+
+                <row>
+                  <entry>--packagemap</entry>
+
+                  <entry>name of packagemap to update</entry>
+                </row>
+
+                <row>
+                  <entry>-v, --verbose</entry>
+
+                  <entry>Output additional tracing information</entry>
+                </row>
+
+                <row>
+                  <entry>-s, --server</entry>
+
+                  <entry>The IP Address of ESP server running eclwatch
+                  services</entry>
+                </row>
+
+                <row>
+                  <entry>--port</entry>
+
+                  <entry>The eclwatch services port (Default is 8010)</entry>
+                </row>
+
+                <row>
+                  <entry>-u, --username</entry>
+
+                  <entry>The username (if necessary)</entry>
+                </row>
+
+                <row>
+                  <entry>-pw, --password</entry>
+
+                  <entry>The password (if necessary)</entry>
+                </row>
+              </tbody>
+            </tgroup>
+          </informaltable></para>
+      </sect2>
+
+      <sect2 role="brk">
+        <title>ecl package list</title>
+
+        <para><emphasis role="bold">ecl package list
+        [options]</emphasis></para>
+
+        <para>Examples:</para>
+
+        <programlisting>ecl package list
+ecl package list --cluster=roxie
+</programlisting>
+
+        <para></para>
+
+        <para><informaltable colsep="0" frame="none" rowsep="0">
+            <tgroup cols="2">
+              <colspec align="left" colwidth="125.55pt" />
+
+              <colspec colwidth="384.85pt" />
+
+              <tbody>
+                <row>
+                  <entry>ecl package list</entry>
+
+                  <entry>Calls the package list command</entry>
+                </row>
+
+                <row>
+                  <entry><emphasis role="bold">Actions</emphasis></entry>
+                </row>
+
+                <row>
+                  <entry>list</entry>
+
+                  <entry>Lists loaded package names</entry>
+                </row>
+
+                <row>
+                  <entry><emphasis role="bold">Options</emphasis></entry>
+                </row>
+
+                <row>
+                  <entry>--cluster</entry>
+
+                  <entry>The name of the cluster from which to list
+                  information. Default is all clusters associated with the
+                  Dali server.</entry>
+                </row>
+
+                <row>
+                  <entry>-v, --verbose</entry>
+
+                  <entry>Output additional tracing information</entry>
+                </row>
+
+                <row>
+                  <entry>-s, --server</entry>
+
+                  <entry>The IP Address of ESP server running eclwatch
+                  services</entry>
+                </row>
+
+                <row>
+                  <entry>--port</entry>
+
+                  <entry>The eclwatch services port (Default is 8010)</entry>
+                </row>
+
+                <row>
+                  <entry>-u, --username</entry>
+
+                  <entry>The username (if necessary)</entry>
+                </row>
+
+                <row>
+                  <entry>-pw, --password</entry>
+
+                  <entry>The password (if necessary)</entry>
+                </row>
+              </tbody>
+            </tgroup>
+          </informaltable></para>
+      </sect2>
+
+      <sect2 role="brk">
+        <title>ecl package info</title>
+
+        <para><emphasis role="bold">ecl package info [options]
+        [--cluster=&lt;clusterName&gt; |
+        --packageName=MyPackage]</emphasis></para>
+
+        <para>Examples:</para>
+
+        <programlisting>ecl package info --packageName=mypackage
+ecl package list --cluster=roxie
+</programlisting>
+
+        <para>Specify either --cluster or packageName.</para>
+
+        <para><informaltable colsep="0" frame="none" rowsep="0">
+            <tgroup cols="2">
+              <colspec align="left" colwidth="125.55pt" />
+
+              <colspec colwidth="384.85pt" />
+
+              <tbody>
+                <row>
+                  <entry>ecl package list</entry>
+
+                  <entry>Calls the package list command</entry>
+                </row>
+
+                <row>
+                  <entry><emphasis role="bold">Actions</emphasis></entry>
+                </row>
+
+                <row>
+                  <entry>list</entry>
+
+                  <entry>Lists loaded package names</entry>
+                </row>
+
+                <row>
+                  <entry><emphasis role="bold">Options</emphasis></entry>
+                </row>
+
+                <row>
+                  <entry>--packageName</entry>
+
+                  <entry>The name of the package from which to list
+                  information. (Specify either --cluster or
+                  packageName)</entry>
+                </row>
+
+                <row>
+                  <entry>--cluster</entry>
+
+                  <entry>The name of the cluster from which to list
+                  information. (Specify either --cluster or
+                  packageName)</entry>
+                </row>
+
+                <row>
                   <entry>-v, --verbose</entry>
 
                   <entry>Output additional tracing information</entry>
@@ -1068,7 +1673,7 @@ ecl queries copy //192.168.1.10:8010/thor/findperson thor
                 <row>
                   <entry>--port</entry>
 
-                  <entry>The eclwatch services port</entry>
+                  <entry>The eclwatch services port (Default is 8010)</entry>
                 </row>
 
                 <row>