sqoop-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jar...@apache.org
Subject svn commit: r1471791 [1/5] - in /sqoop/site/trunk/content/resources/docs/1.99.2: ./ _sources/ _static/ css/ images/ images/logos/
Date Thu, 25 Apr 2013 00:20:55 GMT
Author: jarcec
Date: Thu Apr 25 00:20:54 2013
New Revision: 1471791

URL: http://svn.apache.org/r1471791
Log:
Add documentation for 1.99.2


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

Added: sqoop/site/trunk/content/resources/docs/1.99.2/BuildingSqoop2.html
URL: http://svn.apache.org/viewvc/sqoop/site/trunk/content/resources/docs/1.99.2/BuildingSqoop2.html?rev=1471791&view=auto
==============================================================================
--- sqoop/site/trunk/content/resources/docs/1.99.2/BuildingSqoop2.html (added)
+++ sqoop/site/trunk/content/resources/docs/1.99.2/BuildingSqoop2.html Thu Apr 25 00:20:54 2013
@@ -0,0 +1,101 @@
+
+
+<!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 two major Hadoop revisions at the moment - 1.x and 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. You can change the target Hadoop version by specifying <tt class="docutils literal"><span class="pre">-Dhadoop.profile=$hadoopVersion</span></tt> on the maven command line. Possible values of <tt class="docutils literal"><span class="pre">$hadoopVersions</span></tt> are 100 and 200 for Hadoop version 1.x and 2.x respectively. Sqoop will compile against Hadoop 2 by default. Following example will compile Sqoop against Hadoop 1.x:</p>
+<div class="highlight-none"><div class="highlight"><pre>mvn compile -Dhadoop.profile=100
+</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. You might need to explicitly specify Hadoop version if the default is not accurate.</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 unit tests and will be executed on maven target <tt class="docutils literal"><span class="pre">test</span></tt>. Second larger set of integration tests 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>
+</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.2/ClientAPI.html
URL: http://svn.apache.org/viewvc/sqoop/site/trunk/content/resources/docs/1.99.2/ClientAPI.html?rev=1471791&view=auto
==============================================================================
--- sqoop/site/trunk/content/resources/docs/1.99.2/ClientAPI.html (added)
+++ sqoop/site/trunk/content/resources/docs/1.99.2/ClientAPI.html Thu Apr 25 00:20:54 2013
@@ -0,0 +1,376 @@
+
+
+<!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 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 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-client-api-guide">
+<h1>Sqoop Client API Guide<a class="headerlink" href="#sqoop-client-api-guide" title="Permalink to this headline">¶</a></h1>
+<p>This document will explain how to use Sqoop 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>Client API is explained using Generic JDBC Connector properties. 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 job in Sqoop server.</p>
+<blockquote>
+<div><ol class="arabic simple">
+<li>Create connection using Connector ID (cid) - Creates connection and returns connection ID (xid)</li>
+<li>Create Job using Connection ID (xid)       - Create job and returns Job ID (jid)</li>
+<li>Job submission with Job ID (jid)           - Submit sqoop Job to server</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="connection">
+<h2>Connection<a class="headerlink" href="#connection" title="Permalink to this headline">¶</a></h2>
+<p>Client API allows you to create, update and delete connection. For creating or updating connection requires Connector forms and Framwork Forms. User has to retrive the connector and framework forms, then update the values.</p>
+<div class="section" id="create-connection">
+<h3>Create Connection<a class="headerlink" href="#create-connection" title="Permalink to this headline">¶</a></h3>
+<p>First create a new connection by invoking newConnection(cid) method with connector ID and returns a MConnection object with dummy id. Then fill the connection and framework forms as given below. Invoke create connection with updated connection object.</p>
+<div class="highlight-none"><div class="highlight"><pre>//Dummy connection object
+MConnection newCon = client.newConnection(1);
+
+//Get connection and framework forms. Set name for connection
+MConnectionForms conForms = newCon.getConnectorPart();
+MConnectionForms frameworkForms = newCon.getFrameworkPart();
+newCon.setName(&quot;MyConnection&quot;);
+
+//Set connection forms values
+conForms.getStringInput(&quot;connection.connectionString&quot;).setValue(&quot;jdbc:mysql://localhost/my&quot;);
+conForms.getStringInput(&quot;connection.jdbcDriver&quot;).setValue(&quot;com.mysql.jdbc.Driver&quot;);
+conForms.getStringInput(&quot;connection.username&quot;).setValue(&quot;root&quot;);
+conForms.getStringInput(&quot;connection.password&quot;).setValue(&quot;root&quot;);
+
+frameworkForms.getIntegerInput(&quot;security.maxConnections&quot;).setValue(0);
+
+Status status  = client.createConnection(newCon);
+if(status.canProceed()) {
+ System.out.println(&quot;Created. New Connection ID : &quot; +newCon.getPersistenceId());
+} else {
+ System.out.println(&quot;Check for status and forms error &quot;);
+}
+</pre></div>
+</div>
+<p>status.canProceed() returns true if status is FINE or ACCEPTABLE. Above code has given status after validation of connector and framework forms.</p>
+<p>On successful execution, new connection ID is assigned for the connection. getPersistenceId() method returns ID.
+User can retrieve a connection using below 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">getConnection(xid)</span></tt></td>
+<td>Returns a connection object.</td>
+</tr>
+<tr class="row-odd"><td><tt class="docutils literal"><span class="pre">getConnections()</span></tt></td>
+<td>Returns list of connection object</td>
+</tr>
+</tbody>
+</table>
+</div>
+<div class="section" id="list-of-status-code">
+<h3>List of status code<a class="headerlink" href="#list-of-status-code" 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">FINE</span></tt></td>
+<td>There are no issues, no warnings.</td>
+</tr>
+<tr class="row-odd"><td><tt class="docutils literal"><span class="pre">ACCEPTABLE</span></tt></td>
+<td>Validated entity is correct enough to be processed. There might be some warnings, but no errors.</td>
+</tr>
+<tr class="row-even"><td><tt class="docutils literal"><span class="pre">UNACCEPTABLE</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-message">
+<h3>View Error or Warning message<a class="headerlink" href="#view-error-or-warning-message" title="Permalink to this headline">¶</a></h3>
+<p>In case of any UNACCEPTABLE AND ACCEPTABLE status, user has to iterate the connector part forms and framework part forms for getting actual error or warning message. Below piece of code describe how to itereate over the forms for input message.</p>
+<div class="highlight-none"><div class="highlight"><pre>printMessage(newCon.getConnectorPart().getForms());
+printMessage(newCon.getFrameworkPart().getForms());
+
+private static void printMessage(List&lt;MForm&gt; formList) {
+  for(MForm form : formList) {
+    List&lt;MInput&lt;?&gt;&gt; inputlist = form.getInputs();
+    if (form.getValidationMessage() != null) {
+      System.out.println(&quot;Form message: &quot; + form.getValidationMessage());
+    }
+    for (MInput minput : inputlist) {
+      if (minput.getValidationStatus() == Status.ACCEPTABLE) {
+        System.out.println(&quot;Warning:&quot; + minput.getValidationMessage());
+      } else if (minput.getValidationStatus() == Status.UNACCEPTABLE) {
+        System.out.println(&quot;Error:&quot; + minput.getValidationMessage());
+      }
+    }
+  }
+}
+</pre></div>
+</div>
+</div>
+</div>
+<div class="section" id="job">
+<h2>Job<a class="headerlink" href="#job" title="Permalink to this headline">¶</a></h2>
+<p>A job object holds database configurations, input or output configurations and resources required for executing as a hadoop job. Create job object requires filling connector part and framework part forms.</p>
+<p>Below given code shows how to create a import 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
+MJob newjob = client.newJob(1, org.apache.sqoop.model.MJob.Type.IMPORT);
+MJobForms connectorForm = newjob.getConnectorPart();
+MJobForms frameworkForm = newjob.getFrameworkPart();
+
+newjob.setName(&quot;ImportJob&quot;);
+//Database configuration
+connectorForm.getStringInput(&quot;table.schemaName&quot;).setValue(&quot;&quot;);
+//Input either table name or sql
+connectorForm.getStringInput(&quot;table.tableName&quot;).setValue(&quot;table&quot;);
+//connectorForm.getStringInput(&quot;table.sql&quot;).setValue(&quot;select id,name from table where ${CONDITIONS}&quot;);
+connectorForm.getStringInput(&quot;table.columns&quot;).setValue(&quot;id,name&quot;);
+connectorForm.getStringInput(&quot;table.partitionColumn&quot;).setValue(&quot;id&quot;);
+//Set boundary value only if required
+//connectorForm.getStringInput(&quot;table.boundaryQuery&quot;).setValue(&quot;&quot;);
+
+//Output configurations
+frameworkForm.getEnumInput(&quot;output.storageType&quot;).setValue(&quot;HDFS&quot;);
+frameworkForm.getEnumInput(&quot;output.outputFormat&quot;).setValue(&quot;TEXT_FILE&quot;);//Other option: SEQUENCE_FILE
+frameworkForm.getStringInput(&quot;output.outputDirectory&quot;).setValue(&quot;/output&quot;);
+
+//Job resources
+frameworkForm.getIntegerInput(&quot;throttling.extractors&quot;).setValue(1);
+frameworkForm.getIntegerInput(&quot;throttling.loaders&quot;).setValue(1);
+
+Status status = client.createJob(newjob);
+if(status.canProceed()) {
+ System.out.println(&quot;New Job ID: &quot;+ newjob.getPersistenceId());
+} else {
+ System.out.println(&quot;Check for status and forms error &quot;);
+}
+
+//Print errors or warnings
+printMessage(newjob.getConnectorPart().getForms());
+printMessage(newjob.getFrameworkPart().getForms());
+</pre></div>
+</div>
+<p>Export job creation is same as import job, but only few input configuration changes</p>
+<div class="highlight-none"><div class="highlight"><pre>String url = &quot;http://localhost:12000/sqoop/&quot;;
+SqoopClient client = new SqoopClient(url);
+MJob newjob = client.newJob(1, org.apache.sqoop.model.MJob.Type.EXPORT);
+MJobForms connectorForm = newjob.getConnectorPart();
+MJobForms frameworkForm = newjob.getFrameworkPart();
+
+newjob.setName(&quot;ExportJob&quot;);
+//Database configuration
+connectorForm.getStringInput(&quot;table.schemaName&quot;).setValue(&quot;&quot;);
+//Input either table name or sql
+connectorForm.getStringInput(&quot;table.tableName&quot;).setValue(&quot;table&quot;);
+//connectorForm.getStringInput(&quot;table.sql&quot;).setValue(&quot;select id,name from table where ${CONDITIONS}&quot;);
+connectorForm.getStringInput(&quot;table.columns&quot;).setValue(&quot;id,name&quot;);
+
+//Input configurations
+frameworkForm.getStringInput(&quot;input.inputDirectory&quot;).setValue(&quot;/input&quot;);
+
+//Job resources
+frameworkForm.getIntegerInput(&quot;throttling.extractors&quot;).setValue(1);
+frameworkForm.getIntegerInput(&quot;throttling.loaders&quot;).setValue(1);
+
+Status status = client.createJob(newjob);
+if(status.canProceed()) {
+  System.out.println(&quot;New Job ID: &quot;+ newjob.getPersistenceId());
+} else {
+  System.out.println(&quot;Check for status and forms error &quot;);
+}
+
+//Print errors or warnings
+printMessage(newjob.getConnectorPart().getForms());
+printMessage(newjob.getFrameworkPart().getForms());
+</pre></div>
+</div>
+<div class="section" id="managing-connection-and-job">
+<h3>Managing connection and job<a class="headerlink" href="#managing-connection-and-job" title="Permalink to this headline">¶</a></h3>
+<p>After creating connection or job object, you can update or delete a connection or job using given 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">updateConnection(connection)</span></tt></td>
+<td>Invoke update with connection object and check status for any errors or warnings</td>
+</tr>
+<tr class="row-odd"><td><tt class="docutils literal"><span class="pre">deleteConnection(xid)</span></tt></td>
+<td>Delete connection. Deletes only if specified connection is 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 object 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-submission">
+<h2>Job Submission<a class="headerlink" href="#job-submission" title="Permalink to this headline">¶</a></h2>
+<p>Job submission requires a job id. On successful submission, getStatus() method returns &#8220;BOOTING&#8221; or &#8220;RUNNING&#8221;.</p>
+<div class="highlight-none"><div class="highlight"><pre>//Job submission start
+MSubmission submission = client.startSubmission(1);
+System.out.println(&quot;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
+MSubmission submission = client.getSubmissionStatus(1);
+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.stopSubmission(jid);
+</pre></div>
+</div>
+</div>
+<div class="section" id="describe-forms">
+<h2>Describe Forms<a class="headerlink" href="#describe-forms" title="Permalink to this headline">¶</a></h2>
+<p>You can view the connection or job forms input values with labels of built-in resource bundle.</p>
+<div class="highlight-none"><div class="highlight"><pre>String url = &quot;http://localhost:12000/sqoop/&quot;;
+SqoopClient client = new SqoopClient(url);
+//Use getJob(jid) for describing job.
+//While printing connection forms, pass connector id to getResourceBundle(cid).
+describe(client.getConnection(1).getConnectorPart().getForms(), client.getResourceBundle(1));
+describe(client.getConnection(1).getFrameworkPart().getForms(), client.getFrameworkResourceBundle());
+
+void describe(List&lt;MForm&gt; forms, ResourceBundle resource) {
+  for (MForm mf : forms) {
+    System.out.println(resource.getString(mf.getLabelKey())+&quot;:&quot;);
+    List&lt;MInput&lt;?&gt;&gt; mis = mf.getInputs();
+    for (MInput mi : mis) {
+      System.out.println(resource.getString(mi.getLabelKey()) + &quot; : &quot; + mi.getValue());
+    }
+    System.out.println();
+  }
+}
+</pre></div>
+</div>
+<p>Above Sqoop 2 Client API tutorial explained you how to create connection, create job and submit 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.2/CommandLineClient.html
URL: http://svn.apache.org/viewvc/sqoop/site/trunk/content/resources/docs/1.99.2/CommandLineClient.html?rev=1471791&view=auto
==============================================================================
--- sqoop/site/trunk/content/resources/docs/1.99.2/CommandLineClient.html (added)
+++ sqoop/site/trunk/content/resources/docs/1.99.2/CommandLineClient.html Thu Apr 25 00:20:54 2013
@@ -0,0 +1,797 @@
+
+
+<!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 Client &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 Client</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-client">
+<h1><a class="toc-backref" href="#id1">Command Line Client</a><a class="headerlink" href="#command-line-client" title="Permalink to this headline">¶</a></h1>
+<p>Sqoop 2 provides command line client 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 provided <tt class="docutils literal"><span class="pre">sqoop.sh</span></tt> shell script by passing argument <tt class="docutils literal"><span class="pre">client</span></tt>:</p>
+<div class="highlight-none"><div class="highlight"><pre>sqoop.sh client
+</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>sqoop.sh client /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
+submission start --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-client" id="id1">Command Line Client</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-framework-function" id="id13">Show Framework Function</a></li>
+<li><a class="reference internal" href="#show-connection-function" id="id14">Show Connection Function</a></li>
+<li><a class="reference internal" href="#show-job-function" id="id15">Show Job Function</a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#create-command" id="id16">Create Command</a><ul>
+<li><a class="reference internal" href="#create-connection-function" id="id17">Create Connection Function</a></li>
+<li><a class="reference internal" href="#create-job-function" id="id18">Create Job Function</a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#update-command" id="id19">Update Command</a><ul>
+<li><a class="reference internal" href="#update-connection-function" id="id20">Update Connection Function</a></li>
+<li><a class="reference internal" href="#update-job-function" id="id21">Update Job Function</a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#delete-command" id="id22">Delete Command</a><ul>
+<li><a class="reference internal" href="#delete-connection-function" id="id23">Delete Connection Function</a></li>
+<li><a class="reference internal" href="#delete-job-function" id="id24">Delete Job Function</a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#clone-command" id="id25">Clone Command</a><ul>
+<li><a class="reference internal" href="#clone-connection-function" id="id26">Clone Connection Function</a></li>
+<li><a class="reference internal" href="#clone-job-function" id="id27">Clone Job Function</a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#submission-command" id="id28">Submission Command</a><ul>
+<li><a class="reference internal" href="#submission-start-function" id="id29">Submission Start Function</a></li>
+<li><a class="reference internal" href="#submission-stop-function" id="id30">Submission Stop Function</a></li>
+<li><a class="reference internal" href="#submission-status-function" id="id31">Submission Status 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>
+<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>
+</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>
+</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>
+</tbody>
+</table>
+<p>Example:</p>
+<div class="highlight-none"><div class="highlight"><pre>set option --name verbose --value true
+</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 including server and protocol versions or all stored meta data.</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 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 version of both client and server (build numbers, supported protocols)</td>
+</tr>
+<tr class="row-odd"><td><tt class="docutils literal"><span class="pre">connector</span></tt></td>
+<td>Show connector meta data - set of parameters that connectors needs to create connections and jobs</td>
+</tr>
+<tr class="row-even"><td><tt class="docutils literal"><span class="pre">framework</span></tt></td>
+<td>Show framework meta data - set of parameters that Sqoop framework needs to create connections and jobs</td>
+</tr>
+<tr class="row-odd"><td><tt class="docutils literal"><span class="pre">connection</span></tt></td>
+<td>Show created connection meta data objects</td>
+</tr>
+<tr class="row-even"><td><tt class="docutils literal"><span class="pre">job</span></tt></td>
+<td>Show created job meta data objects</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 configuration 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 versions of both client and server as well as supported protocols.</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, protocols)</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 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 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">--protocol</span></tt></td>
+<td>Show protocol support on client or server</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 connector meta data - parameters that connectors need in order to create new connection 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
+</pre></div>
+</div>
+</div>
+<div class="section" id="show-framework-function">
+<h4><a class="toc-backref" href="#id13">Show Framework Function</a><a class="headerlink" href="#show-framework-function" title="Permalink to this headline">¶</a></h4>
+<p>Show framework meta data - parameters that Sqoop framework need in order to create new connection and job objects.</p>
+<p>This function do not have any extra arguments.</p>
+<p>Example:</p>
+<div class="highlight-none"><div class="highlight"><pre>show framework
+</pre></div>
+</div>
+</div>
+<div class="section" id="show-connection-function">
+<h4><a class="toc-backref" href="#id14">Show Connection Function</a><a class="headerlink" href="#show-connection-function" title="Permalink to this headline">¶</a></h4>
+<p>Show persisted connection 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 connections from all connectors</td>
+</tr>
+<tr class="row-odd"><td><tt class="docutils literal"><span class="pre">-x</span></tt>, <tt class="docutils literal"><span class="pre">--xid</span> <span class="pre">&lt;x&gt;</span></tt></td>
+<td>Show connection 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 connection --all
+</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 from all connectors</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
+</pre></div>
+</div>
+</div>
+</div>
+<div class="section" id="create-command">
+<h3><a class="toc-backref" href="#id16">Create Command</a><a class="headerlink" href="#create-command" title="Permalink to this headline">¶</a></h3>
+<p>Creates new connection and job objects. This command is supported only in interactive mode. It will query user for all parameters that are required by specific connector and framework and persist them in Sqoop server for later use.</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">connection</span></tt></td>
+<td>Create new connection 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-connection-function">
+<h4><a class="toc-backref" href="#id17">Create Connection Function</a><a class="headerlink" href="#create-connection-function" title="Permalink to this headline">¶</a></h4>
+<p>Create new connection 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 connection 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 connection --cid 1
+</pre></div>
+</div>
+</div>
+<div class="section" id="create-job-function">
+<h4><a class="toc-backref" href="#id18">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">-x</span></tt>, <tt class="docutils literal"><span class="pre">--xid</span> <span class="pre">&lt;x&gt;</span></tt></td>
+<td>Create new job object for connection 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">--type</span> <span class="pre">&lt;t&gt;</span></tt></td>
+<td>Create new job object with type <tt class="docutils literal"><span class="pre">&lt;t&gt;</span></tt> (<tt class="docutils literal"><span class="pre">import</span></tt>, <tt class="docutils literal"><span class="pre">export</span></tt>)</td>
+</tr>
+</tbody>
+</table>
+<p>Example:</p>
+<div class="highlight-none"><div class="highlight"><pre>create job --xid 1
+</pre></div>
+</div>
+</div>
+</div>
+<div class="section" id="update-command">
+<h3><a class="toc-backref" href="#id19">Update Command</a><a class="headerlink" href="#update-command" title="Permalink to this headline">¶</a></h3>
+<p>Update commands allows you to edit connection and job objects - change persisted meta data. This command is supported only in interactive mode.</p>
+<div class="section" id="update-connection-function">
+<h4><a class="toc-backref" href="#id20">Update Connection Function</a><a class="headerlink" href="#update-connection-function" title="Permalink to this headline">¶</a></h4>
+<p>Update existing connection 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">--xid</span> <span class="pre">&lt;x&gt;</span></tt></td>
+<td>Update existing connection 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 connection --xid 1
+</pre></div>
+</div>
+</div>
+<div class="section" id="update-job-function">
+<h4><a class="toc-backref" href="#id21">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="#id22">Delete Command</a><a class="headerlink" href="#delete-command" title="Permalink to this headline">¶</a></h3>
+<p>Deletes connection and job objects from Sqoop server.</p>
+<div class="section" id="delete-connection-function">
+<h4><a class="toc-backref" href="#id23">Delete Connection Function</a><a class="headerlink" href="#delete-connection-function" title="Permalink to this headline">¶</a></h4>
+<p>Delete existing connection 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">--xid</span> <span class="pre">&lt;x&gt;</span></tt></td>
+<td>Delete connection 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 connection --xid 1
+</pre></div>
+</div>
+</div>
+<div class="section" id="delete-job-function">
+<h4><a class="toc-backref" href="#id24">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="#id25">Clone Command</a><a class="headerlink" href="#clone-command" title="Permalink to this headline">¶</a></h3>
+<p>Clone command will load existing connection or job object from Sqoop server and allow user in place changes that will result in creation of new connection or job object. This command is not supported in batch mode.</p>
+<div class="section" id="clone-connection-function">
+<h4><a class="toc-backref" href="#id26">Clone Connection Function</a><a class="headerlink" href="#clone-connection-function" title="Permalink to this headline">¶</a></h4>
+<p>Clone existing connection 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">--xid</span> <span class="pre">&lt;x&gt;</span></tt></td>
+<td>Clone connection 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 connection --xid 1
+</pre></div>
+</div>
+</div>
+<div class="section" id="clone-job-function">
+<h4><a class="toc-backref" href="#id27">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="submission-command">
+<h3><a class="toc-backref" href="#id28">Submission Command</a><a class="headerlink" href="#submission-command" title="Permalink to this headline">¶</a></h3>
+<p>Submission command is entry point for executing actual data transfers. It allows you to start, stop and retrieve status of currently running jobs.</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">start</span></tt></td>
+<td>Start job</td>
+</tr>
+<tr class="row-odd"><td><tt class="docutils literal"><span class="pre">stop</span></tt></td>
+<td>Interrupt running job</td>
+</tr>
+<tr class="row-even"><td><tt class="docutils literal"><span class="pre">status</span></tt></td>
+<td>Retrieve status for given job</td>
+</tr>
+</tbody>
+</table>
+<div class="section" id="submission-start-function">
+<h4><a class="toc-backref" href="#id29">Submission Start Function</a><a class="headerlink" href="#submission-start-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="46%" />
+<col width="54%" />
+</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>
+</tbody>
+</table>
+<p>Example:</p>
+<div class="highlight-none"><div class="highlight"><pre>submission start --jid 1
+</pre></div>
+</div>
+</div>
+<div class="section" id="submission-stop-function">
+<h4><a class="toc-backref" href="#id30">Submission Stop Function</a><a class="headerlink" href="#submission-stop-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>submission stop --jid 1
+</pre></div>
+</div>
+</div>
+<div class="section" id="submission-status-function">
+<h4><a class="toc-backref" href="#id31">Submission Status Function</a><a class="headerlink" href="#submission-status-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>submission status --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

Added: sqoop/site/trunk/content/resources/docs/1.99.2/DevEnv.html
URL: http://svn.apache.org/viewvc/sqoop/site/trunk/content/resources/docs/1.99.2/DevEnv.html?rev=1471791&view=auto
==============================================================================
--- sqoop/site/trunk/content/resources/docs/1.99.2/DevEnv.html (added)
+++ sqoop/site/trunk/content/resources/docs/1.99.2/DevEnv.html Thu Apr 25 00:20:54 2013
@@ -0,0 +1,94 @@
+
+
+<!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 2 Development Environment Setup &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 2 Development Environment Setup</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-2-development-environment-setup">
+<h1>Sqoop 2 Development Environment Setup<a class="headerlink" href="#sqoop-2-development-environment-setup" title="Permalink to this headline">¶</a></h1>
+<p>This document describes you how to setup development environment for Sqoop 2.</p>
+<div class="section" id="system-requirement">
+<h2>System Requirement<a class="headerlink" href="#system-requirement" title="Permalink to this headline">¶</a></h2>
+<div class="section" id="java">
+<h3>Java<a class="headerlink" href="#java" title="Permalink to this headline">¶</a></h3>
+<p>Sqoop written in Java and using version 1.6. You can <a class="reference external" href="http://www.oracle.com/technetwork/java/javase/downloads/index.html">download java</a> and install. Locate JAVA_HOME to installed directroy, e.g. export JAVA_HOME=/usr/lib/jvm/jdk1.6.0_32.</p>
+</div>
+<div class="section" id="maven">
+<h3>Maven<a class="headerlink" href="#maven" title="Permalink to this headline">¶</a></h3>
+<p>Sqoop uses Maven 3 for building the project. Download <a class="reference external" href="http://maven.apache.org/download.cgi">Maven</a> and its Installation instructions given in <a class="reference external" href="http://maven.apache.org/download.cgi#Maven_Documentation">link</a>.</p>
+</div>
+</div>
+<div class="section" id="eclipse-setup">
+<h2>Eclipse Setup<a class="headerlink" href="#eclipse-setup" title="Permalink to this headline">¶</a></h2>
+<p>Steps for downloading source code is given in <a class="reference external" href="BuildingSqoop2.html">Building Sqoop2</a></p>
+<p>Sqoop 2 project has multiple modules where one module is depend on another module for e.g. sqoop 2 client module has sqoop 2 common module dependency. Follow below step for creating eclipse&#8217;s project and classpath for each module.</p>
+<div class="highlight-none"><div class="highlight"><pre>//Install all package into local maven repository
+mvn clean install -DskipTests
+
+//Adding M2_REPO variable to eclipse workspace
+mvn eclipse:configure-workspace -Declipse.workspace=&lt;path-to-eclipse-workspace-dir-for-sqoop-2&gt;
+
+//Eclipse project creation with optional parameters
+mvn eclipse:eclipse -DdownloadSources=true -DdownloadJavadocs=true
+</pre></div>
+</div>
+<p>Alternatively, for manually adding M2_REPO classpath variable as maven repository path in eclipse-&gt; window-&gt; Java -&gt;Classpath Variables -&gt;Click &#8220;New&#8221; -&gt;In new dialog box, input Name as M2_REPO and Path as $HOME/.m2/repository -&gt;click Ok.</p>
+<p>On successful execution of above maven commands, Then import the sqoop project modules into eclipse-&gt; File -&gt; Import -&gt;General -&gt;Existing Projects into Workspace-&gt; Click Next-&gt; Browse Sqoop 2 directory ($HOME/git/sqoop2) -&gt;Click Ok -&gt;Import dialog shows multiple projects (sqoop-client, sqoop-common, etc.) -&gt; Select all modules -&gt; click Finish.</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.2/Installation.html
URL: http://svn.apache.org/viewvc/sqoop/site/trunk/content/resources/docs/1.99.2/Installation.html?rev=1471791&view=auto
==============================================================================
--- sqoop/site/trunk/content/resources/docs/1.99.2/Installation.html (added)
+++ sqoop/site/trunk/content/resources/docs/1.99.2/Installation.html Thu Apr 25 00:20:54 2013
@@ -0,0 +1,124 @@
+
+
+<!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>Installation &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>Installation</span></h2>
+      </div>
+      <div class="topnav">
+      
+        <p>
+        <a class="uplink" href="index.html">Contents</a>
+        </p>
+
+      </div>
+      <div class="content">
+        
+        
+  <div class="section" id="installation">
+<h1>Installation<a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h1>
+<p>Sqoop ships as one binary package however it&#8217;s compound from two separate parts - client and server. You need to install server on single node in your cluster. This node will then serve as an entry point for all connecting Sqoop clients. Server acts as a mapreduce client and therefore Hadoop must be installed and configured on machine hosting Sqoop server. Clients can be installed on any arbitrary number of machines. Client is not acting as a mapreduce client and thus you do not need to install Hadoop on nodes that will act only as a Sqoop client.</p>
+<div class="section" id="server-installation">
+<h2>Server installation<a class="headerlink" href="#server-installation" title="Permalink to this headline">¶</a></h2>
+<p>Copy Sqoop artifact on machine where you want to run Sqoop server. This machine must have installed and configured Hadoop. You don&#8217;t need to run any Hadoop related services there, however the machine must be able to act as an Hadoop client. You should be able to list a HDFS for example:</p>
+<div class="highlight-none"><div class="highlight"><pre>hadoop dfs -ls
+</pre></div>
+</div>
+<p>Sqoop server supports multiple Hadoop versions. However as Hadoop major versions are not compatible with each other, Sqoop have multiple binary artefacts - one for each supported major version of Hadoop. You need to make sure that you&#8217;re using appropriated binary artifact for your specific Hadoop version. To install Sqoop server decompress appropriate distribution artifact in location at your convenience and change your working directory to this folder.</p>
+<div class="highlight-none"><div class="highlight"><pre># Decompress Sqoop distribution tarball
+tar -xvf sqoop-&lt;version&gt;-bin-hadoop&lt;hadoop-version&gt;.tar.gz
+
+# Move decompressed content to any location
+mv sqoop-&lt;version&gt;-bin-hadoop&lt;hadoop version&gt;.tar.gz /usr/lib/sqoop
+
+# Change working directory
+cd /usr/lib/sqoop
+</pre></div>
+</div>
+<div class="section" id="installing-dependencies">
+<h3>Installing Dependencies<a class="headerlink" href="#installing-dependencies" title="Permalink to this headline">¶</a></h3>
+<p>You need to install Hadoop libraries into Sqoop server war file. Sqoop provides convenience script <tt class="docutils literal"><span class="pre">addtowar.sh</span></tt> to do so. If you have installed Hadoop in usual location in <tt class="docutils literal"><span class="pre">/usr/lib</span></tt> and executable <tt class="docutils literal"><span class="pre">hadoop</span></tt> is in your path, you can use automatic Hadoop installation procedure:</p>
+<div class="highlight-none"><div class="highlight"><pre>./bin/addtowar.sh -hadoop-auto
+</pre></div>
+</div>
+<p>In case that you have Hadoop installed in different location, you will need to manually specify Hadoop version and path to Hadoop libraries. You can use parameter <tt class="docutils literal"><span class="pre">-hadoop-version</span></tt> for specifying Hadoop major version, we&#8217;re currently support versions 1.x and 2.x. Path to Hadoop libraries can be specified using <tt class="docutils literal"><span class="pre">-hadoop-path</span></tt> parameter. In case that your Hadoop libraries are in multiple different folders, you can specify all of them separated by <tt class="docutils literal"><span class="pre">:</span></tt>.  Example of manual installation:</p>
+<div class="highlight-none"><div class="highlight"><pre>./bin/addtowar.sh -hadoop-version 2.0 -hadoop-path /usr/lib/hadoop-common:/usr/lib/hadoop-hdfs:/usr/lib/hadoop-yarn
+</pre></div>
+</div>
+<p>Lastly you might need to install JDBC drivers that are not bundled with Sqoop because of incompatible licenses. You can add any arbitrary java jar file to Sqoop server using script <tt class="docutils literal"><span class="pre">addtowar.sh</span></tt> with <tt class="docutils literal"><span class="pre">-jars</span></tt> parameter. Similarly as in case of hadoop path you can enter multiple jars separated with <tt class="docutils literal"><span class="pre">:</span></tt>. Example of installing MySQL JDBC driver to Sqoop server:</p>
+<div class="highlight-none"><div class="highlight"><pre>./bin/addtowar.sh -jars /path/to/jar/mysql-connector-java-*-bin.jar
+</pre></div>
+</div>
+</div>
+<div class="section" id="configuring-server">
+<h3>Configuring Server<a class="headerlink" href="#configuring-server" title="Permalink to this headline">¶</a></h3>
+<p>Before starting server you should revise configuration to match your specific environment. Server configuration files are stored in <tt class="docutils literal"><span class="pre">server/config</span></tt> directory of distributed artifact along side with other configuration files of Tomcat.</p>
+<p>File <tt class="docutils literal"><span class="pre">sqoop_bootstrap.properties</span></tt> specifies which configuration provider should be used for loading configuration for rest of Sqoop server. Default value <tt class="docutils literal"><span class="pre">PropertiesConfigurationProvider</span></tt> should be sufficient.</p>
+<p>Second configuration file <tt class="docutils literal"><span class="pre">sqoop.properties</span></tt> contains remaining configuration properties that can affect Sqoop server. File is very well documented, so check if all configuration properties fits your environment. Default or very little tweaking should be sufficient most common cases.</p>
+</div>
+<div class="section" id="server-life-cycle">
+<h3>Server Life Cycle<a class="headerlink" href="#server-life-cycle" title="Permalink to this headline">¶</a></h3>
+<p>After installation and configuration you can start Sqoop server with following command:</p>
+<div class="highlight-none"><div class="highlight"><pre>./bin/sqoop.sh server start
+</pre></div>
+</div>
+<p>Similarly you can stop server using following command:</p>
+<div class="highlight-none"><div class="highlight"><pre>./bin/sqoop.sh server stop
+</pre></div>
+</div>
+</div>
+</div>
+<div class="section" id="client-installation">
+<h2>Client installation<a class="headerlink" href="#client-installation" title="Permalink to this headline">¶</a></h2>
+<p>Client do not need extra installation and configuration steps. Just copy Sqoop distribution artifact on target machine and unzip it in desired location. You can start client with following command:</p>
+<div class="highlight-none"><div class="highlight"><pre>bin/sqoop.sh client
+</pre></div>
+</div>
+<p>You can find more documentation to Sqoop client in <a class="reference external" href="CommandLineClient.html">Command Line Client</a> section.</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



Mime
View raw message