blob: 2bcf8438a5db8387a709529dbd7519ea592185c0 [file] [log] [blame]
sqoop(1)
========
NAME
----
sqoop - The SQL-to-Hadoop database import/export tool
SYNOPSIS
--------
'sqoop' <tool-name> <tool-options>
DESCRIPTION
-----------
Sqoop is a tool designed to help users of large data import existing
relational databases or mainframe datasets into their Hadoop clusters.
Sqoop interfaces with
databases via JDBC, importing the contents of tables into HDFS while
generating Java classes so users can interpret the table's schema.
Sqoop can also run in reverse, exporting records back from HDFS to a
relational data store.
Both SequenceFile and text-based targets are supported. Sqoop
also supports high-performance imports from select databases including MySQL.
OPTIONS
-------
Sqoop must be run with a particular tool specified. The options for
each tool depend on which tool is chosen.
Run 'sqoop help' for a list of all available tools.
Run 'sqoop help <tool-name>' for usage instructions for a particular
tool. Additional usage instructions are available for each tool in the
manual. e.g. 'sqoop-import(1)'.
ENVIRONMENT
-----------
JAVA_HOME::
As part of its import process, Sqoop generates and compiles Java code
by invoking the Java compiler *javac*(1). As a result, JAVA_HOME must
be set to the location of your JDK (note: This cannot just be a JRE).
e.g., +/usr/java/default+. Hadoop (and Sqoop) requires Oracle Java 1.8 which
can be downloaded from http://www.oracle.com/technetwork/java/index.html.
HADOOP_COMMON_HOME::
The location of the Hadoop Common files (specifically the bin/hadoop executable).
If you installed Hadoop via RPM or DEB, this is in +/usr/lib/hadoop+.
HADOOP_MAPRED_HOME::
The location of the Hadoop MapReduce files (specifically the JAR files).
If you installed Hadoop via RPM or DEB, this is in +/usr/lib/hadoop-mapreduce+.
HIVE_HOME::
If you are performing a Hive import, you must identify the location of
Hive's jars and configuration. If you installed Hive via RPM or DEB,
these are in +/usr/lib/hive+.
SEE ALSO
--------
The _Sqoop User Guide_ is available in HTML-form in '/usr/share/doc/sqoop/'
(if you installed via RPM or DEB), or in the 'docs/' directory if you
installed from a tarball.
////
Copyright 2011 The Apache Software Foundation
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
////