sqoop-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jar...@apache.org
Subject svn commit: r1662605 [1/10] - in /sqoop/site/trunk/content/resources/docs/1.99.5: ./ _sources/ _static/ css/ images/ images/logos/
Date Fri, 27 Feb 2015 00:59:17 GMT
Author: jarcec
Date: Fri Feb 27 00:59:16 2015
New Revision: 1662605

URL: http://svn.apache.org/r1662605
Log:
Add documentation for 1.99.5

Added:
    sqoop/site/trunk/content/resources/docs/1.99.5/
    sqoop/site/trunk/content/resources/docs/1.99.5/BuildingSqoop2.html
    sqoop/site/trunk/content/resources/docs/1.99.5/ClientAPI.html
    sqoop/site/trunk/content/resources/docs/1.99.5/CommandLineClient.html
    sqoop/site/trunk/content/resources/docs/1.99.5/ConnectorDevelopment.html
    sqoop/site/trunk/content/resources/docs/1.99.5/Connectors.html
    sqoop/site/trunk/content/resources/docs/1.99.5/DevEnv.html
    sqoop/site/trunk/content/resources/docs/1.99.5/Installation.html
    sqoop/site/trunk/content/resources/docs/1.99.5/RESTAPI.html
    sqoop/site/trunk/content/resources/docs/1.99.5/SecurityGuideOnSqoop2.html
    sqoop/site/trunk/content/resources/docs/1.99.5/Sqoop5MinutesDemo.html
    sqoop/site/trunk/content/resources/docs/1.99.5/Tools.html
    sqoop/site/trunk/content/resources/docs/1.99.5/Upgrade.html
    sqoop/site/trunk/content/resources/docs/1.99.5/_sources/
    sqoop/site/trunk/content/resources/docs/1.99.5/_sources/BuildingSqoop2.txt
    sqoop/site/trunk/content/resources/docs/1.99.5/_sources/ClientAPI.txt
    sqoop/site/trunk/content/resources/docs/1.99.5/_sources/CommandLineClient.txt
    sqoop/site/trunk/content/resources/docs/1.99.5/_sources/ConnectorDevelopment.txt
    sqoop/site/trunk/content/resources/docs/1.99.5/_sources/Connectors.txt
    sqoop/site/trunk/content/resources/docs/1.99.5/_sources/DevEnv.txt
    sqoop/site/trunk/content/resources/docs/1.99.5/_sources/Installation.txt
    sqoop/site/trunk/content/resources/docs/1.99.5/_sources/RESTAPI.txt
    sqoop/site/trunk/content/resources/docs/1.99.5/_sources/SecurityGuideOnSqoop2.txt
    sqoop/site/trunk/content/resources/docs/1.99.5/_sources/Sqoop5MinutesDemo.txt
    sqoop/site/trunk/content/resources/docs/1.99.5/_sources/Tools.txt
    sqoop/site/trunk/content/resources/docs/1.99.5/_sources/Upgrade.txt
    sqoop/site/trunk/content/resources/docs/1.99.5/_sources/index.txt
    sqoop/site/trunk/content/resources/docs/1.99.5/_static/
    sqoop/site/trunk/content/resources/docs/1.99.5/_static/ajax-loader.gif   (with props)
    sqoop/site/trunk/content/resources/docs/1.99.5/_static/alert_info_32.png   (with props)
    sqoop/site/trunk/content/resources/docs/1.99.5/_static/alert_warning_32.png   (with props)
    sqoop/site/trunk/content/resources/docs/1.99.5/_static/basic.css
    sqoop/site/trunk/content/resources/docs/1.99.5/_static/bg-page.png   (with props)
    sqoop/site/trunk/content/resources/docs/1.99.5/_static/bullet_orange.png   (with props)
    sqoop/site/trunk/content/resources/docs/1.99.5/_static/comment-bright.png   (with props)
    sqoop/site/trunk/content/resources/docs/1.99.5/_static/comment-close.png   (with props)
    sqoop/site/trunk/content/resources/docs/1.99.5/_static/comment.png   (with props)
    sqoop/site/trunk/content/resources/docs/1.99.5/_static/doctools.js
    sqoop/site/trunk/content/resources/docs/1.99.5/_static/down-pressed.png   (with props)
    sqoop/site/trunk/content/resources/docs/1.99.5/_static/down.png   (with props)
    sqoop/site/trunk/content/resources/docs/1.99.5/_static/file.png   (with props)
    sqoop/site/trunk/content/resources/docs/1.99.5/_static/haiku.css
    sqoop/site/trunk/content/resources/docs/1.99.5/_static/jquery.js
    sqoop/site/trunk/content/resources/docs/1.99.5/_static/minus.png   (with props)
    sqoop/site/trunk/content/resources/docs/1.99.5/_static/plus.png   (with props)
    sqoop/site/trunk/content/resources/docs/1.99.5/_static/pygments.css
    sqoop/site/trunk/content/resources/docs/1.99.5/_static/searchtools.js
    sqoop/site/trunk/content/resources/docs/1.99.5/_static/sqoop-logo.png   (with props)
    sqoop/site/trunk/content/resources/docs/1.99.5/_static/underscore.js
    sqoop/site/trunk/content/resources/docs/1.99.5/_static/up-pressed.png   (with props)
    sqoop/site/trunk/content/resources/docs/1.99.5/_static/up.png   (with props)
    sqoop/site/trunk/content/resources/docs/1.99.5/_static/websupport.js
    sqoop/site/trunk/content/resources/docs/1.99.5/css/
    sqoop/site/trunk/content/resources/docs/1.99.5/css/maven-base.css
    sqoop/site/trunk/content/resources/docs/1.99.5/css/maven-theme.css
    sqoop/site/trunk/content/resources/docs/1.99.5/css/print.css
    sqoop/site/trunk/content/resources/docs/1.99.5/css/site.css
    sqoop/site/trunk/content/resources/docs/1.99.5/genindex.html
    sqoop/site/trunk/content/resources/docs/1.99.5/images/
    sqoop/site/trunk/content/resources/docs/1.99.5/images/collapsed.gif   (with props)
    sqoop/site/trunk/content/resources/docs/1.99.5/images/expanded.gif   (with props)
    sqoop/site/trunk/content/resources/docs/1.99.5/images/external.png   (with props)
    sqoop/site/trunk/content/resources/docs/1.99.5/images/icon_error_sml.gif   (with props)
    sqoop/site/trunk/content/resources/docs/1.99.5/images/icon_info_sml.gif   (with props)
    sqoop/site/trunk/content/resources/docs/1.99.5/images/icon_success_sml.gif   (with props)
    sqoop/site/trunk/content/resources/docs/1.99.5/images/icon_warning_sml.gif   (with props)
    sqoop/site/trunk/content/resources/docs/1.99.5/images/logos/
    sqoop/site/trunk/content/resources/docs/1.99.5/images/logos/build-by-maven-black.png   (with props)
    sqoop/site/trunk/content/resources/docs/1.99.5/images/logos/build-by-maven-white.png   (with props)
    sqoop/site/trunk/content/resources/docs/1.99.5/images/logos/maven-feather.png   (with props)
    sqoop/site/trunk/content/resources/docs/1.99.5/images/newwindow.png   (with props)
    sqoop/site/trunk/content/resources/docs/1.99.5/index.html
    sqoop/site/trunk/content/resources/docs/1.99.5/objects.inv   (with props)
    sqoop/site/trunk/content/resources/docs/1.99.5/pom.xml
    sqoop/site/trunk/content/resources/docs/1.99.5/project-reports.html
    sqoop/site/trunk/content/resources/docs/1.99.5/search.html
    sqoop/site/trunk/content/resources/docs/1.99.5/searchindex.js

Added: sqoop/site/trunk/content/resources/docs/1.99.5/BuildingSqoop2.html
URL: http://svn.apache.org/viewvc/sqoop/site/trunk/content/resources/docs/1.99.5/BuildingSqoop2.html?rev=1662605&view=auto
==============================================================================
--- sqoop/site/trunk/content/resources/docs/1.99.5/BuildingSqoop2.html (added)
+++ sqoop/site/trunk/content/resources/docs/1.99.5/BuildingSqoop2.html Fri Feb 27 00:59:16 2015
@@ -0,0 +1,106 @@
+
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    
+    <title>Building Sqoop2 from source code &mdash; Apache Sqoop  documentation</title>
+    
+    <link rel="stylesheet" href="_static/haiku.css" type="text/css" />
+    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
+    <link rel="stylesheet" href="_static/print.css" type="text/css" />
+    
+    <script type="text/javascript">
+      var DOCUMENTATION_OPTIONS = {
+        URL_ROOT:    '',
+        VERSION:     '',
+        COLLAPSE_INDEX: false,
+        FILE_SUFFIX: '.html',
+        HAS_SOURCE:  true
+      };
+    </script>
+    <script type="text/javascript" src="_static/jquery.js"></script>
+    <script type="text/javascript" src="_static/underscore.js"></script>
+    <script type="text/javascript" src="_static/doctools.js"></script>
+    <script type="text/javascript" src="_static/theme_extras.js"></script>
+    <link rel="top" title="Apache Sqoop  documentation" href="index.html" /> 
+  </head>
+  <body>
+      <div class="header"><img class="rightlogo" src="_static/sqoop-logo.png" alt="Logo"/><h1 class="heading"><a href="index.html">
+          <span>Apache Sqoop  documentation</span></a></h1>
+        <h2 class="heading"><span>Building Sqoop2 from source code</span></h2>
+      </div>
+      <div class="topnav">
+      
+        <p>
+        <a class="uplink" href="index.html">Contents</a>
+        </p>
+
+      </div>
+      <div class="content">
+        
+        
+  <div class="section" id="building-sqoop2-from-source-code">
+<h1>Building Sqoop2 from source code<a class="headerlink" href="#building-sqoop2-from-source-code" title="Permalink to this headline">¶</a></h1>
+<p>This guide will show you how to build Sqoop2 from source code. Sqoop is using <a class="reference external" href="http://maven.apache.org/">maven</a> as build system. You you will need to use at least version 3.0 as older versions will not work correctly. All other dependencies will be downloaded by maven automatically. With exception of special JDBC drivers that are needed only for advanced integration tests.</p>
+<div class="section" id="downloading-source-code">
+<h2>Downloading source code<a class="headerlink" href="#downloading-source-code" title="Permalink to this headline">¶</a></h2>
+<p>Sqoop project is using git as a revision control system hosted at Apache Software Foundation. You can clone entire repository using following command:</p>
+<div class="highlight-none"><div class="highlight"><pre>git clone https://git-wip-us.apache.org/repos/asf/sqoop.git sqoop2
+</pre></div>
+</div>
+<p>Sqoop2 is currently developed in special branch <tt class="docutils literal"><span class="pre">sqoop2</span></tt> that you need to check out after clone:</p>
+<div class="highlight-none"><div class="highlight"><pre>cd sqoop2
+git checkout sqoop2
+</pre></div>
+</div>
+</div>
+<div class="section" id="building-project">
+<h2>Building project<a class="headerlink" href="#building-project" title="Permalink to this headline">¶</a></h2>
+<p>You can use usual maven targets like <tt class="docutils literal"><span class="pre">compile</span></tt> or <tt class="docutils literal"><span class="pre">package</span></tt> to build the project. Sqoop supports one major Hadoop revision at the moment - 2.x. As compiled code for one Hadoop major version can&#8217;t be used on another, you must compile Sqoop against appropriate Hadoop version.</p>
+<div class="highlight-none"><div class="highlight"><pre>mvn compile
+</pre></div>
+</div>
+<p>Maven target <tt class="docutils literal"><span class="pre">package</span></tt> can be used to create Sqoop packages similar to the ones that are officially available for download. Sqoop will build only source tarball by default. You need to specify <tt class="docutils literal"><span class="pre">-Pbinary</span></tt> to build binary distribution.</p>
+<div class="highlight-none"><div class="highlight"><pre>mvn package -Pbinary
+</pre></div>
+</div>
+</div>
+<div class="section" id="running-tests">
+<h2>Running tests<a class="headerlink" href="#running-tests" title="Permalink to this headline">¶</a></h2>
+<p>Sqoop supports two different sets of tests. First smaller and much faster set is called <strong>unit tests</strong> and will be executed on maven target <tt class="docutils literal"><span class="pre">test</span></tt>. Second larger set of <strong>integration tests</strong> will be executed on maven target <tt class="docutils literal"><span class="pre">integration-test</span></tt>. Please note that integration tests might require manual steps for installing various JDBC drivers into your local maven cache.</p>
+<p>Example for running unit tests:</p>
+<div class="highlight-none"><div class="highlight"><pre>mvn test
+</pre></div>
+</div>
+<p>Example for running integration tests:</p>
+<div class="highlight-none"><div class="highlight"><pre>mvn integration-test
+</pre></div>
+</div>
+<p>For the <strong>unit tests</strong>, there are two helpful profiles: <strong>fast</strong> and <strong>slow</strong>. The <strong>fast</strong> unit tests do not start or use any services. The <strong>slow</strong> unit tests, may start services or use an external service (ie. MySQL).</p>
+<div class="highlight-none"><div class="highlight"><pre>mvn test -Pfast,hadoop200
+mvn test -Pslow,hadoop200
+</pre></div>
+</div>
+</div>
+</div>
+
+
+      </div>
+      <div class="bottomnav">
+      
+        <p>
+        <a class="uplink" href="index.html">Contents</a>
+        </p>
+
+      </div>
+
+    <div class="footer">
+        &copy; Copyright 2009-2013 The Apache Software Foundation.
+    </div>
+  </body>
+</html>
\ No newline at end of file

Added: sqoop/site/trunk/content/resources/docs/1.99.5/ClientAPI.html
URL: http://svn.apache.org/viewvc/sqoop/site/trunk/content/resources/docs/1.99.5/ClientAPI.html?rev=1662605&view=auto
==============================================================================
--- sqoop/site/trunk/content/resources/docs/1.99.5/ClientAPI.html (added)
+++ sqoop/site/trunk/content/resources/docs/1.99.5/ClientAPI.html Fri Feb 27 00:59:16 2015
@@ -0,0 +1,370 @@
+
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    
+    <title>Sqoop Java Client API Guide &mdash; Apache Sqoop  documentation</title>
+    
+    <link rel="stylesheet" href="_static/haiku.css" type="text/css" />
+    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
+    <link rel="stylesheet" href="_static/print.css" type="text/css" />
+    
+    <script type="text/javascript">
+      var DOCUMENTATION_OPTIONS = {
+        URL_ROOT:    '',
+        VERSION:     '',
+        COLLAPSE_INDEX: false,
+        FILE_SUFFIX: '.html',
+        HAS_SOURCE:  true
+      };
+    </script>
+    <script type="text/javascript" src="_static/jquery.js"></script>
+    <script type="text/javascript" src="_static/underscore.js"></script>
+    <script type="text/javascript" src="_static/doctools.js"></script>
+    <script type="text/javascript" src="_static/theme_extras.js"></script>
+    <link rel="top" title="Apache Sqoop  documentation" href="index.html" /> 
+  </head>
+  <body>
+      <div class="header"><img class="rightlogo" src="_static/sqoop-logo.png" alt="Logo"/><h1 class="heading"><a href="index.html">
+          <span>Apache Sqoop  documentation</span></a></h1>
+        <h2 class="heading"><span>Sqoop Java Client API Guide</span></h2>
+      </div>
+      <div class="topnav">
+      
+        <p>
+        <a class="uplink" href="index.html">Contents</a>
+        </p>
+
+      </div>
+      <div class="content">
+        
+        
+  <div class="section" id="sqoop-java-client-api-guide">
+<h1>Sqoop Java Client API Guide<a class="headerlink" href="#sqoop-java-client-api-guide" title="Permalink to this headline">¶</a></h1>
+<p>This document will explain how to use Sqoop Java Client API with external application. Client API allows you to execute the functions of sqoop commands. It requires Sqoop Client JAR and its dependencies.</p>
+<p>The main class that provides wrapper methods for all the supported operations is the</p>
+<div class="highlight-none"><div class="highlight"><pre>public class SqoopClient {
+  ...
+}
+</pre></div>
+</div>
+<p>Java Client API is explained using Generic JDBC Connector example. Before executing the application using the sqoop client API, check whether sqoop server is running.</p>
+<div class="section" id="workflow">
+<h2>Workflow<a class="headerlink" href="#workflow" title="Permalink to this headline">¶</a></h2>
+<p>Given workflow has to be followed for executing a sqoop job in Sqoop server.</p>
+<blockquote>
+<div><ol class="arabic simple">
+<li>Create LINK object for a given connectorId             - Creates Link object and returns linkId (lid)</li>
+<li>Create a JOB for a given &#8220;from&#8221; and &#8220;to&#8221; linkId            - Create Job object and returns jobId (jid)</li>
+<li>Start the JOB for a given jobId                        - Start Job on the server and creates a submission record</li>
+</ol>
+</div></blockquote>
+</div>
+<div class="section" id="project-dependencies">
+<h2>Project Dependencies<a class="headerlink" href="#project-dependencies" title="Permalink to this headline">¶</a></h2>
+<p>Here given maven dependency</p>
+<div class="highlight-none"><div class="highlight"><pre>&lt;dependency&gt;
+  &lt;groupId&gt;org.apache.sqoop&lt;/groupId&gt;
+    &lt;artifactId&gt;sqoop-client&lt;/artifactId&gt;
+    &lt;version&gt;${requestedVersion}&lt;/version&gt;
+&lt;/dependency&gt;
+</pre></div>
+</div>
+</div>
+<div class="section" id="initialization">
+<h2>Initialization<a class="headerlink" href="#initialization" title="Permalink to this headline">¶</a></h2>
+<p>First initialize the SqoopClient class with server URL as argument.</p>
+<div class="highlight-none"><div class="highlight"><pre>String url = &quot;http://localhost:12000/sqoop/&quot;;
+SqoopClient client = new SqoopClient(url);
+</pre></div>
+</div>
+<p>Server URL value can be modfied by setting value to setServerUrl(String) method</p>
+<div class="highlight-none"><div class="highlight"><pre>client.setServerUrl(newUrl);
+</pre></div>
+</div>
+</div>
+<div class="section" id="link">
+<h2>Link<a class="headerlink" href="#link" title="Permalink to this headline">¶</a></h2>
+<p>Connectors provide the facility to interact with many data sources and thus can be used as a means to transfer data between them in Sqoop. The registered connector implementation will provide logic to read from and/or write to a data source that it represents. A connector can have one or more links associated with it. The java client API allows you to create, update and delete a link for any registered connector. Creating or updating a link requires you to populate the Link Config for that particular connector. Hence the first thing to do is get the list of registered connectors and select the connector for which you would like to create a link. Then
+you can get the list of all the config/inputs using <a class="reference internal" href="#display-config-and-input-names-for-connector">Display Config and Input Names For Connector</a> for that connector.</p>
+<div class="section" id="save-link">
+<h3>Save Link<a class="headerlink" href="#save-link" title="Permalink to this headline">¶</a></h3>
+<p>First create a new link by invoking <tt class="docutils literal"><span class="pre">createLink(cid)</span></tt> method with connector Id and it returns a MLink object with dummy id and the unfilled link config inputs for that connector. Then fill the config inputs with relevant values. Invoke <tt class="docutils literal"><span class="pre">saveLink</span></tt> passing it the filled MLink object.</p>
+<div class="highlight-none"><div class="highlight"><pre>// create a placeholder for link
+long connectorId = 1;
+MLink link = client.createLink(connectorId);
+link.setName(&quot;Vampire&quot;);
+link.setCreationUser(&quot;Buffy&quot;);
+MLinkConfig linkConfig = link.getConnectorLinkConfig();
+// fill in the link config values
+linkConfig.getStringInput(&quot;linkConfig.connectionString&quot;).setValue(&quot;jdbc:mysql://localhost/my&quot;);
+linkConfig.getStringInput(&quot;linkConfig.jdbcDriver&quot;).setValue(&quot;com.mysql.jdbc.Driver&quot;);
+linkConfig.getStringInput(&quot;linkConfig.username&quot;).setValue(&quot;root&quot;);
+linkConfig.getStringInput(&quot;linkConfig.password&quot;).setValue(&quot;root&quot;);
+// save the link object that was filled
+Status status = client.saveLink(link);
+if(status.canProceed()) {
+ System.out.println(&quot;Created Link with Link Id : &quot; + link.getPersistenceId());
+} else {
+ System.out.println(&quot;Something went wrong creating the link&quot;);
+}
+</pre></div>
+</div>
+<p><tt class="docutils literal"><span class="pre">status.canProceed()</span></tt> returns true if status is OK or a WARNING. Before sending the status, the link config values are validated using the corresponding validator associated with th link config inputs.</p>
+<p>On successful execution of the saveLink method, new link Id is assigned to the link object else an exception is thrown. <tt class="docutils literal"><span class="pre">link.getPersistenceId()</span></tt> method returns the unique Id for this object persisted in the sqoop repository.</p>
+<p>User can retrieve a link using the following methods</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="42%" />
+<col width="58%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Method</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><tt class="docutils literal"><span class="pre">getLink(lid)</span></tt></td>
+<td>Returns a link by id</td>
+</tr>
+<tr class="row-odd"><td><tt class="docutils literal"><span class="pre">getLinks()</span></tt></td>
+<td>Returns list of links in the sqoop</td>
+</tr>
+</tbody>
+</table>
+</div>
+</div>
+<div class="section" id="job">
+<h2>Job<a class="headerlink" href="#job" title="Permalink to this headline">¶</a></h2>
+<p>A sqoop job holds the <tt class="docutils literal"><span class="pre">From</span></tt> and <tt class="docutils literal"><span class="pre">To</span></tt> parts for transferring data from the <tt class="docutils literal"><span class="pre">From</span></tt> data source to the <tt class="docutils literal"><span class="pre">To</span></tt> data source. Both the <tt class="docutils literal"><span class="pre">From</span></tt> and the <tt class="docutils literal"><span class="pre">To</span></tt> are uniquely identified by their corresponding connector Link Ids. i.e when creating a job we have to specifiy the <tt class="docutils literal"><span class="pre">FromLinkId</span></tt> and the <tt class="docutils literal"><span class="pre">ToLinkId</span></tt>. Thus the pre-requisite for creating a job is to first create the links as described above.</p>
+<p>Once the linkIds for the <tt class="docutils literal"><span class="pre">From</span></tt> and <tt class="docutils literal"><span class="pre">To</span></tt> are given, then the job configs for the associated connector for the link object have to be filled. You can get the list of all the from and to job config/inputs using <a class="reference internal" href="#display-config-and-input-names-for-connector">Display Config and Input Names For Connector</a> for that connector. A connector can have one or more links. We then use the links in the <tt class="docutils literal"><span class="pre">From</span></tt> and <tt class="docutils literal"><span class="pre">To</span></tt> direction to populate the corresponding <tt class="docutils literal"><span class="pre">MFromConfig</span></tt> and <tt class="docutils literal"><span class="pre">MToConfig</span></tt> respectively.</p>
+<p>In addition to filling the job configs for the <tt class="docutils literal"><span class="pre">From</span></tt> and the <tt class="docutils literal"><span class="pre">To</span></tt> representing the link, we also need to fill the driver configs that control the job execution engine environment. For example, if the job execution engine happens to be the MapReduce we will specifiy the number of mappers to be used in reading data from the <tt class="docutils literal"><span class="pre">From</span></tt> data source.</p>
+<div class="section" id="save-job">
+<h3>Save Job<a class="headerlink" href="#save-job" title="Permalink to this headline">¶</a></h3>
+<p>Here is the code to create and then save a job</p>
+<div class="highlight-none"><div class="highlight"><pre>String url = &quot;http://localhost:12000/sqoop/&quot;;
+SqoopClient client = new SqoopClient(url);
+//Creating dummy job object
+long fromLinkId = 1;// for jdbc connector
+long toLinkId = 2; // for HDFS connector
+MJob job = client.createJob(fromLinkId, toLinkId);
+job.setName(&quot;Vampire&quot;);
+job.setCreationUser(&quot;Buffy&quot;);
+// set the &quot;FROM&quot; link job config values
+MFromConfig fromJobConfig = job.getFromJobConfig();
+fromJobConfig.getStringInput(&quot;fromJobConfig.schemaName&quot;).setValue(&quot;sqoop&quot;);
+fromJobConfig.getStringInput(&quot;fromJobConfig.tableName&quot;).setValue(&quot;sqoop&quot;);
+fromJobConfig.getStringInput(&quot;fromJobConfig.partitionColumn&quot;).setValue(&quot;id&quot;);
+// set the &quot;TO&quot; link job config values
+MToConfig toJobConfig = job.getToJobConfig();
+toJobConfig.getStringInput(&quot;toJobConfig.outputDirectory&quot;).setValue(&quot;/usr/tmp&quot;);
+// set the driver config values
+MDriverConfig driverConfig = job.getDriverConfig();
+driverConfig.getStringInput(&quot;throttlingConfig.numExtractors&quot;).setValue(&quot;3&quot;);
+
+Status status = client.saveJob(job);
+if(status.canProceed()) {
+ System.out.println(&quot;Created Job with Job Id: &quot;+ job.getPersistenceId());
+} else {
+ System.out.println(&quot;Something went wrong creating the job&quot;);
+}
+</pre></div>
+</div>
+<p>User can retrieve a job using the following methods</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="42%" />
+<col width="58%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Method</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><tt class="docutils literal"><span class="pre">getJob(jid)</span></tt></td>
+<td>Returns a job by id</td>
+</tr>
+<tr class="row-odd"><td><tt class="docutils literal"><span class="pre">getJobs()</span></tt></td>
+<td>Returns list of jobs in the sqoop</td>
+</tr>
+</tbody>
+</table>
+</div>
+<div class="section" id="list-of-status-codes">
+<h3>List of status codes<a class="headerlink" href="#list-of-status-codes" title="Permalink to this headline">¶</a></h3>
+<table border="1" class="docutils">
+<colgroup>
+<col width="14%" />
+<col width="86%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Function</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><tt class="docutils literal"><span class="pre">OK</span></tt></td>
+<td>There are no issues, no warnings.</td>
+</tr>
+<tr class="row-odd"><td><tt class="docutils literal"><span class="pre">WARNING</span></tt></td>
+<td>Validated entity is correct enough to be proceed. Not a fatal error</td>
+</tr>
+<tr class="row-even"><td><tt class="docutils literal"><span class="pre">ERROR</span></tt></td>
+<td>There are serious issues with validated entity. We can&#8217;t proceed until reported issues will be resolved.</td>
+</tr>
+</tbody>
+</table>
+</div>
+<div class="section" id="view-error-or-warning-valdiation-message">
+<h3>View Error or Warning valdiation message<a class="headerlink" href="#view-error-or-warning-valdiation-message" title="Permalink to this headline">¶</a></h3>
+<p>In case of any WARNING AND ERROR status, user has to iterate the list of validation messages.</p>
+<div class="highlight-none"><div class="highlight"><pre>printMessage(link.getConnectorLinkConfig().getConfigs());
+
+private static void printMessage(List&lt;MConfig&gt; configs) {
+  for(MConfig config : configs) {
+    List&lt;MInput&lt;?&gt;&gt; inputlist = config.getInputs();
+    if (config.getValidationMessages() != null) {
+     // print every validation message
+     for(Message message : config.getValidationMessages()) {
+      System.out.println(&quot;Config validation message: &quot; + message.getMessage());
+     }
+    }
+    for (MInput minput : inputlist) {
+      if (minput.getValidationStatus() == Status.WARNING) {
+       for(Message message : config.getValidationMessages()) {
+        System.out.println(&quot;Config Input Validation Warning: &quot; + message.getMessage());
+      }
+    }
+    else if (minput.getValidationStatus() == Status.ERROR) {
+      for(Message message : config.getValidationMessages()) {
+       System.out.println(&quot;Config Input Validation Error: &quot; + message.getMessage());
+      }
+     }
+    }
+   }
+</pre></div>
+</div>
+</div>
+<div class="section" id="updating-link-and-job">
+<h3>Updating link and job<a class="headerlink" href="#updating-link-and-job" title="Permalink to this headline">¶</a></h3>
+<p>After creating link or job in the repository, you can update or delete a link or job using the following functions</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="29%" />
+<col width="71%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Method</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><tt class="docutils literal"><span class="pre">updateLink(link)</span></tt></td>
+<td>Invoke update with link and check status for any errors or warnings</td>
+</tr>
+<tr class="row-odd"><td><tt class="docutils literal"><span class="pre">deleteLink(lid)</span></tt></td>
+<td>Delete link. Deletes only if specified link is not used by any job</td>
+</tr>
+<tr class="row-even"><td><tt class="docutils literal"><span class="pre">updateJob(job)</span></tt></td>
+<td>Invoke update with job and check status for any errors or warnings</td>
+</tr>
+<tr class="row-odd"><td><tt class="docutils literal"><span class="pre">deleteJob(jid)</span></tt></td>
+<td>Delete job</td>
+</tr>
+</tbody>
+</table>
+</div>
+</div>
+<div class="section" id="job-start">
+<h2>Job Start<a class="headerlink" href="#job-start" title="Permalink to this headline">¶</a></h2>
+<p>Starting a job requires a job id. On successful start, getStatus() method returns &#8220;BOOTING&#8221; or &#8220;RUNNING&#8221;.</p>
+<div class="highlight-none"><div class="highlight"><pre>//Job start
+long jobId = 1;
+MSubmission submission = client.startJob(jobId);
+System.out.println(&quot;Job Submission Status : &quot; + submission.getStatus());
+if(submission.getStatus().isRunning() &amp;&amp; submission.getProgress() != -1) {
+  System.out.println(&quot;Progress : &quot; + String.format(&quot;%.2f %%&quot;, submission.getProgress() * 100));
+}
+System.out.println(&quot;Hadoop job id :&quot; + submission.getExternalId());
+System.out.println(&quot;Job link : &quot; + submission.getExternalLink());
+Counters counters = submission.getCounters();
+if(counters != null) {
+  System.out.println(&quot;Counters:&quot;);
+  for(CounterGroup group : counters) {
+    System.out.print(&quot;\t&quot;);
+    System.out.println(group.getName());
+    for(Counter counter : group) {
+      System.out.print(&quot;\t\t&quot;);
+      System.out.print(counter.getName());
+      System.out.print(&quot;: &quot;);
+      System.out.println(counter.getValue());
+    }
+  }
+}
+if(submission.getExceptionInfo() != null) {
+  System.out.println(&quot;Exception info : &quot; +submission.getExceptionInfo());
+}
+
+
+//Check job status for a running job
+MSubmission submission = client.getJobStatus(jobId);
+if(submission.getStatus().isRunning() &amp;&amp; submission.getProgress() != -1) {
+  System.out.println(&quot;Progress : &quot; + String.format(&quot;%.2f %%&quot;, submission.getProgress() * 100));
+}
+
+//Stop a running job
+submission.stopJob(jobId);
+</pre></div>
+</div>
+<p>Above code block, job start is asynchronous. For synchronous job start, use <tt class="docutils literal"><span class="pre">startJob(jid,</span> <span class="pre">callback,</span> <span class="pre">pollTime)</span></tt> method. If you are not interested in getting the job status, then invoke the same method with &#8220;null&#8221; as the value for the callback parameter and this returns the final job status. <tt class="docutils literal"><span class="pre">pollTime</span></tt> is the request interval for getting the job status from sqoop server and the value should be greater than zero. We will frequently hit the sqoop server if a low value is given for the <tt class="docutils literal"><span class="pre">pollTime</span></tt>. When a synchronous job is started with a non null callback, it first invokes the callback&#8217;s <tt class="docutils literal"><span class="pre">submitted(MSubmission)</span></tt> method on successful start, after every poll time interval, it then invokes the <t
 t class="docutils literal"><span class="pre">updated(MSubmission)</span></tt> method on the callback API and finally on finishing the job executuon it invokes the <tt class="docutils literal"><span class="pre">finished(MSubmission)</span></tt> method on the callback API.</p>
+</div>
+<div class="section" id="display-config-and-input-names-for-connector">
+<h2>Display Config and Input Names For Connector<a class="headerlink" href="#display-config-and-input-names-for-connector" title="Permalink to this headline">¶</a></h2>
+<p>You can view the config/input names for the link and job config types per connector</p>
+<div class="highlight-none"><div class="highlight"><pre>String url = &quot;http://localhost:12000/sqoop/&quot;;
+SqoopClient client = new SqoopClient(url);
+long connectorId = 1;
+// link config for connector
+describe(client.getConnector(connectorId).getLinkConfig().getConfigs(), client.getConnectorConfigBundle(connectorId));
+// from job config for connector
+describe(client.getConnector(connectorId).getFromConfig().getConfigs(), client.getConnectorConfigBundle(connectorId));
+// to job config for the connector
+describe(client.getConnector(connectorId).getToConfig().getConfigs(), client.getConnectorConfigBundle(connectorId));
+
+void describe(List&lt;MConfig&gt; configs, ResourceBundle resource) {
+  for (MConfig config : configs) {
+    System.out.println(resource.getString(config.getLabelKey())+&quot;:&quot;);
+    List&lt;MInput&lt;?&gt;&gt; inputs = config.getInputs();
+    for (MInput input : inputs) {
+      System.out.println(resource.getString(input.getLabelKey()) + &quot; : &quot; + input.getValue());
+    }
+    System.out.println();
+  }
+}
+</pre></div>
+</div>
+<p>Above Sqoop 2 Client API tutorial explained how to create a link, create job and and then start the job.</p>
+</div>
+</div>
+
+
+      </div>
+      <div class="bottomnav">
+      
+        <p>
+        <a class="uplink" href="index.html">Contents</a>
+        </p>
+
+      </div>
+
+    <div class="footer">
+        &copy; Copyright 2009-2013 The Apache Software Foundation.
+    </div>
+  </body>
+</html>
\ No newline at end of file

Added: sqoop/site/trunk/content/resources/docs/1.99.5/CommandLineClient.html
URL: http://svn.apache.org/viewvc/sqoop/site/trunk/content/resources/docs/1.99.5/CommandLineClient.html?rev=1662605&view=auto
==============================================================================
--- sqoop/site/trunk/content/resources/docs/1.99.5/CommandLineClient.html (added)
+++ sqoop/site/trunk/content/resources/docs/1.99.5/CommandLineClient.html Fri Feb 27 00:59:16 2015
@@ -0,0 +1,856 @@
+
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    
+    <title>Command Line Shell &mdash; Apache Sqoop  documentation</title>
+    
+    <link rel="stylesheet" href="_static/haiku.css" type="text/css" />
+    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
+    <link rel="stylesheet" href="_static/print.css" type="text/css" />
+    
+    <script type="text/javascript">
+      var DOCUMENTATION_OPTIONS = {
+        URL_ROOT:    '',
+        VERSION:     '',
+        COLLAPSE_INDEX: false,
+        FILE_SUFFIX: '.html',
+        HAS_SOURCE:  true
+      };
+    </script>
+    <script type="text/javascript" src="_static/jquery.js"></script>
+    <script type="text/javascript" src="_static/underscore.js"></script>
+    <script type="text/javascript" src="_static/doctools.js"></script>
+    <script type="text/javascript" src="_static/theme_extras.js"></script>
+    <link rel="top" title="Apache Sqoop  documentation" href="index.html" /> 
+  </head>
+  <body>
+      <div class="header"><img class="rightlogo" src="_static/sqoop-logo.png" alt="Logo"/><h1 class="heading"><a href="index.html">
+          <span>Apache Sqoop  documentation</span></a></h1>
+        <h2 class="heading"><span>Command Line Shell</span></h2>
+      </div>
+      <div class="topnav">
+      
+        <p>
+        <a class="uplink" href="index.html">Contents</a>
+        </p>
+
+      </div>
+      <div class="content">
+        
+        
+  <div class="section" id="command-line-shell">
+<h1><a class="toc-backref" href="#id1">Command Line Shell</a><a class="headerlink" href="#command-line-shell" title="Permalink to this headline">¶</a></h1>
+<p>Sqoop 2 provides command line shell that is capable of communicating with Sqoop 2 server using REST interface. Client is able to run in two modes - interactive and batch mode. Commands <tt class="docutils literal"><span class="pre">create</span></tt>, <tt class="docutils literal"><span class="pre">update</span></tt> and <tt class="docutils literal"><span class="pre">clone</span></tt> are not currently supported in batch mode. Interactive mode supports all available commands.</p>
+<p>You can start Sqoop 2 client in interactive mode using command <tt class="docutils literal"><span class="pre">sqoop2-shell</span></tt>:</p>
+<div class="highlight-none"><div class="highlight"><pre>sqoop2-shell
+</pre></div>
+</div>
+<p>Batch mode can be started by adding additional argument representing path to your Sqoop client script:</p>
+<div class="highlight-none"><div class="highlight"><pre>sqoop2-shell /path/to/your/script.sqoop
+</pre></div>
+</div>
+<p>Sqoop client script is expected to contain valid Sqoop client commands, empty lines and lines starting with <tt class="docutils literal"><span class="pre">#</span></tt> that are denoting comment lines. Comments and empty lines are ignored, all other lines are interpreted. Example script:</p>
+<div class="highlight-none"><div class="highlight"><pre># Specify company server
+set server --host sqoop2.company.net
+
+# Executing given job
+start job  --jid 1
+</pre></div>
+</div>
+<div class="contents topic" id="table-of-contents">
+<p class="topic-title first">Table of Contents</p>
+<ul class="simple">
+<li><a class="reference internal" href="#command-line-shell" id="id1">Command Line Shell</a><ul>
+<li><a class="reference internal" href="#resource-file" id="id2">Resource file</a></li>
+<li><a class="reference internal" href="#commands" id="id3">Commands</a><ul>
+<li><a class="reference internal" href="#auxiliary-commands" id="id4">Auxiliary Commands</a></li>
+<li><a class="reference internal" href="#set-command" id="id5">Set Command</a><ul>
+<li><a class="reference internal" href="#set-server-function" id="id6">Set Server Function</a></li>
+<li><a class="reference internal" href="#set-option-function" id="id7">Set Option Function</a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#show-command" id="id8">Show Command</a><ul>
+<li><a class="reference internal" href="#show-server-function" id="id9">Show Server Function</a></li>
+<li><a class="reference internal" href="#show-option-function" id="id10">Show Option Function</a></li>
+<li><a class="reference internal" href="#show-version-function" id="id11">Show Version Function</a></li>
+<li><a class="reference internal" href="#show-connector-function" id="id12">Show Connector Function</a></li>
+<li><a class="reference internal" href="#show-driver-function" id="id13">Show Driver Function</a></li>
+<li><a class="reference internal" href="#show-link-function" id="id14">Show Link Function</a></li>
+<li><a class="reference internal" href="#show-job-function" id="id15">Show Job Function</a></li>
+<li><a class="reference internal" href="#show-submission-function" id="id16">Show Submission Function</a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#create-command" id="id17">Create Command</a><ul>
+<li><a class="reference internal" href="#create-link-function" id="id18">Create Link Function</a></li>
+<li><a class="reference internal" href="#create-job-function" id="id19">Create Job Function</a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#update-command" id="id20">Update Command</a><ul>
+<li><a class="reference internal" href="#update-link-function" id="id21">Update Link Function</a></li>
+<li><a class="reference internal" href="#update-job-function" id="id22">Update Job Function</a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#delete-command" id="id23">Delete Command</a><ul>
+<li><a class="reference internal" href="#delete-link-function" id="id24">Delete Link Function</a></li>
+<li><a class="reference internal" href="#delete-job-function" id="id25">Delete Job Function</a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#clone-command" id="id26">Clone Command</a><ul>
+<li><a class="reference internal" href="#clone-link-function" id="id27">Clone Link Function</a></li>
+<li><a class="reference internal" href="#clone-job-function" id="id28">Clone Job Function</a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#start-command" id="id29">Start Command</a><ul>
+<li><a class="reference internal" href="#start-job-function" id="id30">Start Job Function</a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#stop-command" id="id31">Stop Command</a><ul>
+<li><a class="reference internal" href="#stop-job-function" id="id32">Stop Job Function</a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#status-command" id="id33">Status Command</a><ul>
+<li><a class="reference internal" href="#status-job-function" id="id34">Status Job Function</a></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="section" id="resource-file">
+<h2><a class="toc-backref" href="#id2">Resource file</a><a class="headerlink" href="#resource-file" title="Permalink to this headline">¶</a></h2>
+<p>Sqoop 2 client have ability to load resource files similarly as other command line tools. At the beginning of execution Sqoop client will check existence of file <tt class="docutils literal"><span class="pre">.sqoop2rc</span></tt> in home directory of currently logged user. If such file exists, it will be interpreted before any additional actions. This file is loaded in both interactive and batch mode. It can be used to execute any batch compatible commands.</p>
+<p>Example resource file:</p>
+<div class="highlight-none"><div class="highlight"><pre># Configure our Sqoop 2 server automatically
+set server --host sqoop2.company.net
+
+# Run in verbose mode by default
+set option --name verbose --value true
+</pre></div>
+</div>
+</div>
+<div class="section" id="commands">
+<h2><a class="toc-backref" href="#id3">Commands</a><a class="headerlink" href="#commands" title="Permalink to this headline">¶</a></h2>
+<p>Sqoop 2 contains several commands that will be documented in this section. Each command have one more functions that are accepting various arguments. Not all commands are supported in both interactive and batch mode.</p>
+<div class="section" id="auxiliary-commands">
+<h3><a class="toc-backref" href="#id4">Auxiliary Commands</a><a class="headerlink" href="#auxiliary-commands" title="Permalink to this headline">¶</a></h3>
+<p>Auxiliary commands are commands that are improving user experience and are running purely on client side. Thus they do not need working connection to the server.</p>
+<ul class="simple">
+<li><tt class="docutils literal"><span class="pre">exit</span></tt> Exit client immediately. This command can be also executed by sending EOT (end of transmission) character. It&#8217;s CTRL+D on most common Linux shells like Bash or Zsh.</li>
+<li><tt class="docutils literal"><span class="pre">history</span></tt> Print out command history. Please note that Sqoop client is saving history from previous executions and thus you might see commands that you&#8217;ve executed in previous runs.</li>
+<li><tt class="docutils literal"><span class="pre">help</span></tt> Show all available commands with short in-shell documentation.</li>
+</ul>
+<div class="highlight-none"><div class="highlight"><pre>sqoop:000&gt; help
+For information about Sqoop, visit: http://sqoop.apache.org/
+
+Available commands:
+  exit    (\x  ) Exit the shell
+  history (\H  ) Display, manage and recall edit-line history
+  help    (\h  ) Display this help message
+  set     (\st ) Configure various client options and settings
+  show    (\sh ) Display various objects and configuration options
+  create  (\cr ) Create new object in Sqoop repository
+  delete  (\d  ) Delete existing object in Sqoop repository
+  update  (\up ) Update objects in Sqoop repository
+  clone   (\cl ) Create new object based on existing one
+  start   (\sta) Start job
+  stop    (\stp) Stop job
+  status  (\stu) Display status of a job
+  enable  (\en ) Enable object in Sqoop repository
+  disable (\di ) Disable object in Sqoop repository
+</pre></div>
+</div>
+</div>
+<div class="section" id="set-command">
+<h3><a class="toc-backref" href="#id5">Set Command</a><a class="headerlink" href="#set-command" title="Permalink to this headline">¶</a></h3>
+<p>Set command allows to set various properties of the client. Similarly as auxiliary commands, set do not require connection to Sqoop server. Set commands is not used to reconfigure Sqoop server.</p>
+<p>Available functions:</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="26%" />
+<col width="74%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Function</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><tt class="docutils literal"><span class="pre">server</span></tt></td>
+<td>Set connection configuration for server</td>
+</tr>
+<tr class="row-odd"><td><tt class="docutils literal"><span class="pre">option</span></tt></td>
+<td>Set various client side options</td>
+</tr>
+</tbody>
+</table>
+<div class="section" id="set-server-function">
+<h4><a class="toc-backref" href="#id6">Set Server Function</a><a class="headerlink" href="#set-server-function" title="Permalink to this headline">¶</a></h4>
+<p>Configure connection to Sqoop server - host port and web application name. Available arguments:</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="26%" />
+<col width="17%" />
+<col width="57%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Argument</th>
+<th class="head">Default value</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><tt class="docutils literal"><span class="pre">-h</span></tt>, <tt class="docutils literal"><span class="pre">--host</span></tt></td>
+<td>localhost</td>
+<td>Server name (FQDN) where Sqoop server is running</td>
+</tr>
+<tr class="row-odd"><td><tt class="docutils literal"><span class="pre">-p</span></tt>, <tt class="docutils literal"><span class="pre">--port</span></tt></td>
+<td>12000</td>
+<td>TCP Port</td>
+</tr>
+<tr class="row-even"><td><tt class="docutils literal"><span class="pre">-w</span></tt>, <tt class="docutils literal"><span class="pre">--webapp</span></tt></td>
+<td>sqoop</td>
+<td>Tomcat&#8217;s web application name</td>
+</tr>
+<tr class="row-odd"><td><tt class="docutils literal"><span class="pre">-u</span></tt>, <tt class="docutils literal"><span class="pre">--url</span></tt></td>
+<td>&nbsp;</td>
+<td>Sqoop Server in url format</td>
+</tr>
+</tbody>
+</table>
+<p>Example:</p>
+<div class="highlight-none"><div class="highlight"><pre>set server --host sqoop2.company.net --port 80 --webapp sqoop
+</pre></div>
+</div>
+<p>or</p>
+<div class="highlight-none"><div class="highlight"><pre>set server --url http://sqoop2.company.net:80/sqoop
+</pre></div>
+</div>
+<p>Note: When <tt class="docutils literal"><span class="pre">--url</span></tt> option is given, <tt class="docutils literal"><span class="pre">--host</span></tt>, <tt class="docutils literal"><span class="pre">--port</span></tt> or <tt class="docutils literal"><span class="pre">--webapp</span></tt> option will be ignored.</p>
+</div>
+<div class="section" id="set-option-function">
+<h4><a class="toc-backref" href="#id7">Set Option Function</a><a class="headerlink" href="#set-option-function" title="Permalink to this headline">¶</a></h4>
+<p>Configure Sqoop client related options. This function have two required arguments <tt class="docutils literal"><span class="pre">name</span></tt> and <tt class="docutils literal"><span class="pre">value</span></tt>. Name represents internal property name and value holds new value that should be set. List of available option names follows:</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="18%" />
+<col width="15%" />
+<col width="67%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Option name</th>
+<th class="head">Default value</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><tt class="docutils literal"><span class="pre">verbose</span></tt></td>
+<td>false</td>
+<td>Client will print additional information if verbose mode is enabled</td>
+</tr>
+<tr class="row-odd"><td><tt class="docutils literal"><span class="pre">poll-timeout</span></tt></td>
+<td>10000</td>
+<td>Server poll timeout in milliseconds</td>
+</tr>
+</tbody>
+</table>
+<p>Example:</p>
+<div class="highlight-none"><div class="highlight"><pre>set option --name verbose --value true
+set option --name poll-timeout --value 20000
+</pre></div>
+</div>
+</div>
+</div>
+<div class="section" id="show-command">
+<h3><a class="toc-backref" href="#id8">Show Command</a><a class="headerlink" href="#show-command" title="Permalink to this headline">¶</a></h3>
+<p>Show commands displays various information as described below.</p>
+<p>Available functions:</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="13%" />
+<col width="87%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Function</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><tt class="docutils literal"><span class="pre">server</span></tt></td>
+<td>Display connection information to the sqoop server (host, port, webapp)</td>
+</tr>
+<tr class="row-odd"><td><tt class="docutils literal"><span class="pre">option</span></tt></td>
+<td>Display various client side options</td>
+</tr>
+<tr class="row-even"><td><tt class="docutils literal"><span class="pre">version</span></tt></td>
+<td>Show client build version, with an option -all it shows server build version and supported api versions</td>
+</tr>
+<tr class="row-odd"><td><tt class="docutils literal"><span class="pre">connector</span></tt></td>
+<td>Show connector configurable and its related configs</td>
+</tr>
+<tr class="row-even"><td><tt class="docutils literal"><span class="pre">driver</span></tt></td>
+<td>Show driver configurable and its related configs</td>
+</tr>
+<tr class="row-odd"><td><tt class="docutils literal"><span class="pre">link</span></tt></td>
+<td>Show links in sqoop</td>
+</tr>
+<tr class="row-even"><td><tt class="docutils literal"><span class="pre">job</span></tt></td>
+<td>Show jobs in sqoop</td>
+</tr>
+</tbody>
+</table>
+<div class="section" id="show-server-function">
+<h4><a class="toc-backref" href="#id9">Show Server Function</a><a class="headerlink" href="#show-server-function" title="Permalink to this headline">¶</a></h4>
+<p>Show details about connection to Sqoop server.</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="27%" />
+<col width="73%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Argument</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><tt class="docutils literal"><span class="pre">-a</span></tt>, <tt class="docutils literal"><span class="pre">--all</span></tt></td>
+<td>Show all connection related information (host, port, webapp)</td>
+</tr>
+<tr class="row-odd"><td><tt class="docutils literal"><span class="pre">-h</span></tt>, <tt class="docutils literal"><span class="pre">--host</span></tt></td>
+<td>Show host</td>
+</tr>
+<tr class="row-even"><td><tt class="docutils literal"><span class="pre">-p</span></tt>, <tt class="docutils literal"><span class="pre">--port</span></tt></td>
+<td>Show port</td>
+</tr>
+<tr class="row-odd"><td><tt class="docutils literal"><span class="pre">-w</span></tt>, <tt class="docutils literal"><span class="pre">--webapp</span></tt></td>
+<td>Show web application name</td>
+</tr>
+</tbody>
+</table>
+<p>Example:</p>
+<div class="highlight-none"><div class="highlight"><pre>show server --all
+</pre></div>
+</div>
+</div>
+<div class="section" id="show-option-function">
+<h4><a class="toc-backref" href="#id10">Show Option Function</a><a class="headerlink" href="#show-option-function" title="Permalink to this headline">¶</a></h4>
+<p>Show values of various client side options. This function will show all client options when called without arguments.</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="27%" />
+<col width="73%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Argument</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><tt class="docutils literal"><span class="pre">-n</span></tt>, <tt class="docutils literal"><span class="pre">--name</span></tt></td>
+<td>Show client option value with given name</td>
+</tr>
+</tbody>
+</table>
+<p>Please check table in <a class="reference internal" href="#set-option-function">Set Option Function</a> section to get a list of all supported option names.</p>
+<p>Example:</p>
+<div class="highlight-none"><div class="highlight"><pre>show option --name verbose
+</pre></div>
+</div>
+</div>
+<div class="section" id="show-version-function">
+<h4><a class="toc-backref" href="#id11">Show Version Function</a><a class="headerlink" href="#show-version-function" title="Permalink to this headline">¶</a></h4>
+<p>Show build versions of both client and server as well as the supported rest api versions.</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="34%" />
+<col width="66%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Argument</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><tt class="docutils literal"><span class="pre">-a</span></tt>, <tt class="docutils literal"><span class="pre">--all</span></tt></td>
+<td>Show all versions (server, client, api)</td>
+</tr>
+<tr class="row-odd"><td><tt class="docutils literal"><span class="pre">-c</span></tt>, <tt class="docutils literal"><span class="pre">--client</span></tt></td>
+<td>Show client build version</td>
+</tr>
+<tr class="row-even"><td><tt class="docutils literal"><span class="pre">-s</span></tt>, <tt class="docutils literal"><span class="pre">--server</span></tt></td>
+<td>Show server build version</td>
+</tr>
+<tr class="row-odd"><td><tt class="docutils literal"><span class="pre">-p</span></tt>, <tt class="docutils literal"><span class="pre">--api</span></tt></td>
+<td>Show supported api versions</td>
+</tr>
+</tbody>
+</table>
+<p>Example:</p>
+<div class="highlight-none"><div class="highlight"><pre>show version --all
+</pre></div>
+</div>
+</div>
+<div class="section" id="show-connector-function">
+<h4><a class="toc-backref" href="#id12">Show Connector Function</a><a class="headerlink" href="#show-connector-function" title="Permalink to this headline">¶</a></h4>
+<p>Show persisted connector configurable and its related configs used in creating associated link and job objects</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="32%" />
+<col width="68%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Argument</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><tt class="docutils literal"><span class="pre">-a</span></tt>, <tt class="docutils literal"><span class="pre">--all</span></tt></td>
+<td>Show information for all connectors</td>
+</tr>
+<tr class="row-odd"><td><tt class="docutils literal"><span class="pre">-c</span></tt>, <tt class="docutils literal"><span class="pre">--cid</span> <span class="pre">&lt;x&gt;</span></tt></td>
+<td>Show information for connector with id <tt class="docutils literal"><span class="pre">&lt;x&gt;</span></tt></td>
+</tr>
+</tbody>
+</table>
+<p>Example:</p>
+<div class="highlight-none"><div class="highlight"><pre>show connector --all or show connector
+</pre></div>
+</div>
+</div>
+<div class="section" id="show-driver-function">
+<h4><a class="toc-backref" href="#id13">Show Driver Function</a><a class="headerlink" href="#show-driver-function" title="Permalink to this headline">¶</a></h4>
+<p>Show persisted driver configurable and its related configs used in creating job objects</p>
+<p>This function do not have any extra arguments. There is only one registered driver in sqoop</p>
+<p>Example:</p>
+<div class="highlight-none"><div class="highlight"><pre>show driver
+</pre></div>
+</div>
+</div>
+<div class="section" id="show-link-function">
+<h4><a class="toc-backref" href="#id14">Show Link Function</a><a class="headerlink" href="#show-link-function" title="Permalink to this headline">¶</a></h4>
+<p>Show persisted link objects.</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="30%" />
+<col width="70%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Argument</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><tt class="docutils literal"><span class="pre">-a</span></tt>, <tt class="docutils literal"><span class="pre">--all</span></tt></td>
+<td>Show all available links</td>
+</tr>
+<tr class="row-odd"><td><tt class="docutils literal"><span class="pre">-x</span></tt>, <tt class="docutils literal"><span class="pre">--lid</span> <span class="pre">&lt;x&gt;</span></tt></td>
+<td>Show link with id <tt class="docutils literal"><span class="pre">&lt;x&gt;</span></tt></td>
+</tr>
+</tbody>
+</table>
+<p>Example:</p>
+<div class="highlight-none"><div class="highlight"><pre>show link --all or show link
+</pre></div>
+</div>
+</div>
+<div class="section" id="show-job-function">
+<h4><a class="toc-backref" href="#id15">Show Job Function</a><a class="headerlink" href="#show-job-function" title="Permalink to this headline">¶</a></h4>
+<p>Show persisted job objects.</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="33%" />
+<col width="67%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Argument</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><tt class="docutils literal"><span class="pre">-a</span></tt>, <tt class="docutils literal"><span class="pre">--all</span></tt></td>
+<td>Show all available jobs</td>
+</tr>
+<tr class="row-odd"><td><tt class="docutils literal"><span class="pre">-j</span></tt>, <tt class="docutils literal"><span class="pre">--jid</span> <span class="pre">&lt;x&gt;</span></tt></td>
+<td>Show job with id <tt class="docutils literal"><span class="pre">&lt;x&gt;</span></tt></td>
+</tr>
+</tbody>
+</table>
+<p>Example:</p>
+<div class="highlight-none"><div class="highlight"><pre>show job --all or show job
+</pre></div>
+</div>
+</div>
+<div class="section" id="show-submission-function">
+<h4><a class="toc-backref" href="#id16">Show Submission Function</a><a class="headerlink" href="#show-submission-function" title="Permalink to this headline">¶</a></h4>
+<p>Show persisted job submission objects.</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="34%" />
+<col width="66%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Argument</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><tt class="docutils literal"><span class="pre">-j</span></tt>, <tt class="docutils literal"><span class="pre">--jid</span> <span class="pre">&lt;x&gt;</span></tt></td>
+<td>Show available submissions for given job</td>
+</tr>
+<tr class="row-odd"><td><tt class="docutils literal"><span class="pre">-d</span></tt>, <tt class="docutils literal"><span class="pre">--detail</span></tt></td>
+<td>Show job submissions in full details</td>
+</tr>
+</tbody>
+</table>
+<p>Example:</p>
+<div class="highlight-none"><div class="highlight"><pre>show submission
+show submission --jid 1
+show submission --jid 1 --detail
+</pre></div>
+</div>
+</div>
+</div>
+<div class="section" id="create-command">
+<h3><a class="toc-backref" href="#id17">Create Command</a><a class="headerlink" href="#create-command" title="Permalink to this headline">¶</a></h3>
+<p>Creates new link and job objects. This command is supported only in interactive mode. It will ask user to enter the link config and job configs for from /to and driver when creating link and job objects respectively.</p>
+<p>Available functions:</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="25%" />
+<col width="75%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Function</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><tt class="docutils literal"><span class="pre">link</span></tt></td>
+<td>Create new link object</td>
+</tr>
+<tr class="row-odd"><td><tt class="docutils literal"><span class="pre">job</span></tt></td>
+<td>Create new job object</td>
+</tr>
+</tbody>
+</table>
+<div class="section" id="create-link-function">
+<h4><a class="toc-backref" href="#id18">Create Link Function</a><a class="headerlink" href="#create-link-function" title="Permalink to this headline">¶</a></h4>
+<p>Create new link object.</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="72%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Argument</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><tt class="docutils literal"><span class="pre">-c</span></tt>, <tt class="docutils literal"><span class="pre">--cid</span> <span class="pre">&lt;x&gt;</span></tt></td>
+<td>Create new link object for connector with id <tt class="docutils literal"><span class="pre">&lt;x&gt;</span></tt></td>
+</tr>
+</tbody>
+</table>
+<p>Example:</p>
+<div class="highlight-none"><div class="highlight"><pre>create link --cid 1 or create link -c 1
+</pre></div>
+</div>
+</div>
+<div class="section" id="create-job-function">
+<h4><a class="toc-backref" href="#id19">Create Job Function</a><a class="headerlink" href="#create-job-function" title="Permalink to this headline">¶</a></h4>
+<p>Create new job object.</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="27%" />
+<col width="73%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Argument</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><tt class="docutils literal"><span class="pre">-f</span></tt>, <tt class="docutils literal"><span class="pre">--from</span> <span class="pre">&lt;x&gt;</span></tt></td>
+<td>Create new job object with a FROM link with id <tt class="docutils literal"><span class="pre">&lt;x&gt;</span></tt></td>
+</tr>
+<tr class="row-odd"><td><tt class="docutils literal"><span class="pre">-t</span></tt>, <tt class="docutils literal"><span class="pre">--to</span> <span class="pre">&lt;t&gt;</span></tt></td>
+<td>Create new job object with a TO link with id <tt class="docutils literal"><span class="pre">&lt;x&gt;</span></tt></td>
+</tr>
+</tbody>
+</table>
+<p>Example:</p>
+<div class="highlight-none"><div class="highlight"><pre>create job --from 1 --to 2 or create job --f 1 --t 2
+</pre></div>
+</div>
+</div>
+</div>
+<div class="section" id="update-command">
+<h3><a class="toc-backref" href="#id20">Update Command</a><a class="headerlink" href="#update-command" title="Permalink to this headline">¶</a></h3>
+<p>Update commands allows you to edit link and job objects. This command is supported only in interactive mode.</p>
+<div class="section" id="update-link-function">
+<h4><a class="toc-backref" href="#id21">Update Link Function</a><a class="headerlink" href="#update-link-function" title="Permalink to this headline">¶</a></h4>
+<p>Update existing link object.</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="34%" />
+<col width="66%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Argument</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><tt class="docutils literal"><span class="pre">-x</span></tt>, <tt class="docutils literal"><span class="pre">--lid</span> <span class="pre">&lt;x&gt;</span></tt></td>
+<td>Update existing link with id <tt class="docutils literal"><span class="pre">&lt;x&gt;</span></tt></td>
+</tr>
+</tbody>
+</table>
+<p>Example:</p>
+<div class="highlight-none"><div class="highlight"><pre>update link --lid 1
+</pre></div>
+</div>
+</div>
+<div class="section" id="update-job-function">
+<h4><a class="toc-backref" href="#id22">Update Job Function</a><a class="headerlink" href="#update-job-function" title="Permalink to this headline">¶</a></h4>
+<p>Update existing job object.</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="34%" />
+<col width="66%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Argument</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><tt class="docutils literal"><span class="pre">-j</span></tt>, <tt class="docutils literal"><span class="pre">--jid</span> <span class="pre">&lt;x&gt;</span></tt></td>
+<td>Update existing job object with id <tt class="docutils literal"><span class="pre">&lt;x&gt;</span></tt></td>
+</tr>
+</tbody>
+</table>
+<p>Example:</p>
+<div class="highlight-none"><div class="highlight"><pre>update job --jid 1
+</pre></div>
+</div>
+</div>
+</div>
+<div class="section" id="delete-command">
+<h3><a class="toc-backref" href="#id23">Delete Command</a><a class="headerlink" href="#delete-command" title="Permalink to this headline">¶</a></h3>
+<p>Deletes link and job objects from Sqoop server.</p>
+<div class="section" id="delete-link-function">
+<h4><a class="toc-backref" href="#id24">Delete Link Function</a><a class="headerlink" href="#delete-link-function" title="Permalink to this headline">¶</a></h4>
+<p>Delete existing link object.</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="35%" />
+<col width="65%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Argument</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><tt class="docutils literal"><span class="pre">-x</span></tt>, <tt class="docutils literal"><span class="pre">--lid</span> <span class="pre">&lt;x&gt;</span></tt></td>
+<td>Delete link object with id <tt class="docutils literal"><span class="pre">&lt;x&gt;</span></tt></td>
+</tr>
+</tbody>
+</table>
+<p>Example:</p>
+<div class="highlight-none"><div class="highlight"><pre>delete link --lid 1
+</pre></div>
+</div>
+</div>
+<div class="section" id="delete-job-function">
+<h4><a class="toc-backref" href="#id25">Delete Job Function</a><a class="headerlink" href="#delete-job-function" title="Permalink to this headline">¶</a></h4>
+<p>Delete existing job object.</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="35%" />
+<col width="65%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Argument</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><tt class="docutils literal"><span class="pre">-j</span></tt>, <tt class="docutils literal"><span class="pre">--jid</span> <span class="pre">&lt;x&gt;</span></tt></td>
+<td>Delete job object with id <tt class="docutils literal"><span class="pre">&lt;x&gt;</span></tt></td>
+</tr>
+</tbody>
+</table>
+<p>Example:</p>
+<div class="highlight-none"><div class="highlight"><pre>delete job --jid 1
+</pre></div>
+</div>
+</div>
+</div>
+<div class="section" id="clone-command">
+<h3><a class="toc-backref" href="#id26">Clone Command</a><a class="headerlink" href="#clone-command" title="Permalink to this headline">¶</a></h3>
+<p>Clone command will load existing link or job object from Sqoop server and allow user in place updates that will result in creation of new link or job object. This command is not supported in batch mode.</p>
+<div class="section" id="clone-link-function">
+<h4><a class="toc-backref" href="#id27">Clone Link Function</a><a class="headerlink" href="#clone-link-function" title="Permalink to this headline">¶</a></h4>
+<p>Clone existing link object.</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="35%" />
+<col width="65%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Argument</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><tt class="docutils literal"><span class="pre">-x</span></tt>, <tt class="docutils literal"><span class="pre">--lid</span> <span class="pre">&lt;x&gt;</span></tt></td>
+<td>Clone link object with id <tt class="docutils literal"><span class="pre">&lt;x&gt;</span></tt></td>
+</tr>
+</tbody>
+</table>
+<p>Example:</p>
+<div class="highlight-none"><div class="highlight"><pre>clone link --lid 1
+</pre></div>
+</div>
+</div>
+<div class="section" id="clone-job-function">
+<h4><a class="toc-backref" href="#id28">Clone Job Function</a><a class="headerlink" href="#clone-job-function" title="Permalink to this headline">¶</a></h4>
+<p>Clone existing job object.</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="35%" />
+<col width="65%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Argument</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><tt class="docutils literal"><span class="pre">-j</span></tt>, <tt class="docutils literal"><span class="pre">--jid</span> <span class="pre">&lt;x&gt;</span></tt></td>
+<td>Clone job object with id <tt class="docutils literal"><span class="pre">&lt;x&gt;</span></tt></td>
+</tr>
+</tbody>
+</table>
+<p>Example:</p>
+<div class="highlight-none"><div class="highlight"><pre>clone job --jid 1
+</pre></div>
+</div>
+</div>
+</div>
+<div class="section" id="start-command">
+<h3><a class="toc-backref" href="#id29">Start Command</a><a class="headerlink" href="#start-command" title="Permalink to this headline">¶</a></h3>
+<p>Start command will begin execution of an existing Sqoop job.</p>
+<div class="section" id="start-job-function">
+<h4><a class="toc-backref" href="#id30">Start Job Function</a><a class="headerlink" href="#start-job-function" title="Permalink to this headline">¶</a></h4>
+<p>Start job (submit new submission). Starting already running job is considered as invalid operation.</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="50%" />
+<col width="50%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Argument</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><tt class="docutils literal"><span class="pre">-j</span></tt>, <tt class="docutils literal"><span class="pre">--jid</span> <span class="pre">&lt;x&gt;</span></tt></td>
+<td>Start job with id <tt class="docutils literal"><span class="pre">&lt;x&gt;</span></tt></td>
+</tr>
+<tr class="row-odd"><td><tt class="docutils literal"><span class="pre">-s</span></tt>, <tt class="docutils literal"><span class="pre">--synchronous</span></tt></td>
+<td>Synchoronous job execution</td>
+</tr>
+</tbody>
+</table>
+<p>Example:</p>
+<div class="highlight-none"><div class="highlight"><pre>start job --jid 1
+start job --jid 1 --synchronous
+</pre></div>
+</div>
+</div>
+</div>
+<div class="section" id="stop-command">
+<h3><a class="toc-backref" href="#id31">Stop Command</a><a class="headerlink" href="#stop-command" title="Permalink to this headline">¶</a></h3>
+<p>Stop command will interrupt an job execution.</p>
+<div class="section" id="stop-job-function">
+<h4><a class="toc-backref" href="#id32">Stop Job Function</a><a class="headerlink" href="#stop-job-function" title="Permalink to this headline">¶</a></h4>
+<p>Interrupt running job.</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="35%" />
+<col width="65%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Argument</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><tt class="docutils literal"><span class="pre">-j</span></tt>, <tt class="docutils literal"><span class="pre">--jid</span> <span class="pre">&lt;x&gt;</span></tt></td>
+<td>Interrupt running job with id <tt class="docutils literal"><span class="pre">&lt;x&gt;</span></tt></td>
+</tr>
+</tbody>
+</table>
+<p>Example:</p>
+<div class="highlight-none"><div class="highlight"><pre>stop job --jid 1
+</pre></div>
+</div>
+</div>
+</div>
+<div class="section" id="status-command">
+<h3><a class="toc-backref" href="#id33">Status Command</a><a class="headerlink" href="#status-command" title="Permalink to this headline">¶</a></h3>
+<p>Status command will retrieve the last status of a job.</p>
+<div class="section" id="status-job-function">
+<h4><a class="toc-backref" href="#id34">Status Job Function</a><a class="headerlink" href="#status-job-function" title="Permalink to this headline">¶</a></h4>
+<p>Retrieve last status for given job.</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="35%" />
+<col width="65%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Argument</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><tt class="docutils literal"><span class="pre">-j</span></tt>, <tt class="docutils literal"><span class="pre">--jid</span> <span class="pre">&lt;x&gt;</span></tt></td>
+<td>Retrieve status for job with id <tt class="docutils literal"><span class="pre">&lt;x&gt;</span></tt></td>
+</tr>
+</tbody>
+</table>
+<p>Example:</p>
+<div class="highlight-none"><div class="highlight"><pre>status job --jid 1
+</pre></div>
+</div>
+</div>
+</div>
+</div>
+</div>
+
+
+      </div>
+      <div class="bottomnav">
+      
+        <p>
+        <a class="uplink" href="index.html">Contents</a>
+        </p>
+
+      </div>
+
+    <div class="footer">
+        &copy; Copyright 2009-2013 The Apache Software Foundation.
+    </div>
+  </body>
+</html>
\ No newline at end of file



Mime
View raw message