Pārlūkot izejas kodu

[sqoop2] Documentation

Abraham Elmahrek 12 gadi atpakaļ
vecāks
revīzija
2e924d494d

BIN
docs/user-guide/images/icon_sqoop_24.png


+ 1 - 0
docs/user-guide/index.md

@@ -15,5 +15,6 @@ Hue 2 User Guide
 -   [Job Browser](jobbrowser.html)
 -   [Job Designer](jobdesigner.html)
 -   [Oozie Editor and Dashboard](oozie.html)
+-   [Sqoop UI](sqoop.html)
 -   [Hue Shell](shell.html)
 -   [User Admin](admin.html)

+ 96 - 0
docs/user-guide/sqoop.md

@@ -0,0 +1,96 @@
+
+<link rel="stylesheet" href="docbook.css" type="text/css" media="screen" title="no title" charset="utf-8"></link>
+
+Sqoop UI
+========
+
+The Sqoop UI enables transfering data from a relational database
+to Hadoop and vice versa. The UI lives uses Apache Sqoop to do this.
+See the [Sqoop Documentation](http://sqoop.apache.org/docs/1.99.2/index.html) for more details on Sqoop.
+
+Installation and Configuration
+------------------------------
+
+The Sqoop UI is one of the applications installed as part of
+Hue. For information about installing and configuring Hue, see the Hue Installation
+manual.
+
+Starting
+--------
+
+Click the **Sqoop** icon
+(![image](images/icon_sqoop_24.png)) in the navigation bar at the top of
+the Hue browser page.
+
+Sqoop Jobs
+----------
+Sqoop UI is oriented around jobs in Apache Sqoop.
+
+### Creating a New Job
+
+1. Click the **New job** button at the top right.
+2. In the Name field, enter a name.
+3. Choose the type of job: import or export.
+   The proceeding form fields will change depending on which type is chosen.
+4. Select a connection, or create one if it does not exist.
+5. Fill in the rest of the fields for the job.
+   For importing, the "Table name", "Storage type", "Output format", and "Output directory" are necessary at a minimum.
+   For exporting, the "Table name" and "Input directory" are necessary at a minimum.
+6. Click **save** to finish.
+
+### Editing a Job
+
+1. In the list of jobs, click on the name of the job.
+2. Edit the desired form fields in the job.
+
+### Copying a Job
+
+1. In the list of jobs, click on the name of the job.
+2. On the left hand side of the job editor, there should be a panel containing actions.
+   Click **Copy**.
+
+### Removing a Job
+
+1. In the list of jobs, click on the name of the job.
+2. On the left hand side of the job editor, there should be a panel containing actions.
+   Click **Delete**.
+
+### Running a Job
+
+There's a status on each of the items in the job list indicating
+the last time a job was ran. The progress of the job should dynamically
+update. There's a progress bar at the bottom of each item on the job list
+as well.
+
+1. In the list of jobs, click on the name of the job.
+2. On the left hand side of the job editor, there should be a panel containing actions.
+   Click **Run**.
+
+### Creating a New Connection
+
+1. Click the **New job** button at the top right.
+2. At the connection field, click the link titled **Add a new connection**.
+3. Fill in the displayed fields.
+4. Click **save** to finish.
+
+### Editing a Connection
+
+1. Click the **New job** button at the top right.
+2. At the connection field, select the connection by name that should be edited.
+3. Click **Edit**.
+4. Edit the any of the fields.
+5. Click **save** to finish.
+
+### Removing a Connection
+
+1. Click the **New job** button at the top right.
+2. At the connection field, select the connection by name that should be deleted.
+3. Click **Delete**.
+
+NOTE: If this does not work, it's like because a job is using that connection.
+      Make sure not jobs are using the connection that will be deleted.
+
+### Filtering Sqoop Jobs
+
+The text field in the top, left corner of the Sqoop Jobs page enables fast filtering
+of sqoop jobs by name.