Please see the docs for latest release in 1.99.* . Some of the information below might be outdated

Building from sources

Checkout sources and switch to sqoop2 branch:

git clone sqoop2
cd sqoop2
git checkout sqoop2


Setting up a build environment with Eclipse


  • Install Eclipse,
  • Install maven if not already on your machine
  • Install Oracle's JDK 

Set up 

  • Run the following commands
mvn eclipse:configure-workspace -Declipse.workspace=<path to your eclipse workspace>
mvn eclipse:eclipse -DdownloadSources=true -DdownloadJavadocs=true
  • Import the project into eclipse by going to File > Import... > General > Existing Projects into Workspace > Next.
  • In the next wizard window, click the browse button next to "Select root directory" and browse to the root of the workspace from where you have checked out sqoop2. This will populate about 10 projects into your workspace - all of which are different modules within Sqoop2. Click Finish button to get these projects into the workspace and start working.

Note - if this is the first time you are setting up Eclipse for a maven project, the import will show class path problems due to missing variable M2_REPO (Unbound classpath variable: 'M2_REPO/...). To fix this error, go to Preferences > Java > Build Path > Classpath Variables. Click on New..., enter name M2_REPO, click on Folder and browse upto the directory ~/.m2/repository. Click OK and close the preferences dialog. This will force the rebuild of the workspace and all projects should turn green.

Similar steps need to be followed with IDEA Intellij as well.

Setting up the Code Formatter 

See Sqoop 2 Coding Guidelines

Quick commands to compile and run tests

Sqoop clean:

mvn clean

Sqoop compile:

mvn compile

Run all unit tests:

mvn test

Run all  integration tests :

Running integration tests does take up a lot of CPU, since these tests run on the actual execution engine ( such as Hadoop MR ) esp.

Running org.apache.sqoop.integration.connector.jdbc.generic.PartitionerTest

mvn clean integration-test

Run one integration test:

mvn clean integration-test -Dtest=org.apache.sqoop.integration.connector.jdbc.generic.FromRDBMSToHDFSTest -DfailIfNoTests=false

If you want to run tests against the postgres repository, have a working installation of postgres and then point to it when running tests. In the following case we have a working postgres installation as 


mvn clean integration-test -pl repository/repository-postgresql -Dsqoop.provider.class=org.apache.sqoop.common.test.db.PostgreSQLProvider -Dsqoop.provider.postgresql.jdbc=jdbc:postgresql:// -Dsqoop.provider.postgresql.username=sqoop -Dsqoop.provider.postgresql.password=sqoop -Dpostgresql

Sadly, as of this writing it does not really run the integration tests, it runs only the unit tests.


Build sqoop :

mvn package


Optionally you can build Sqoop with skipping tests ( both unit tests and integration tests )

mvn package -DskipTests


Other handy commands that does build and run all tests from scratch

mvn verify
mvn clean install

Creating Sqoop binaries

Now build and package Sqoop2 binary distribution:

mvn package -Pbinary

mvn package -DskipTests=true -Dmaven.javadoc.skip=true -Pbinary -Dhadoop.profile=200  // for a specific hadoop profile

This process will create a directory and a tarball under dist/target directory. The directory (named sqoop-2.0.0-SNAPSHOT or  sqoop-2.0.0-SNAPSHOT-bin-hadoop200, depending on the hadoop profile used ) contains necessary binaries to run Sqoop2, and its structure looks something like below.

VB: There is NO lib folder under the client in the latest code as of this writing

--+ bin --+
  + client --+ lib --+ sqoop-common.jar
  |                  |
  |                  + sqoop-client.jar
  |                  |
  |                  + (3rd-party client dependency jars)
  + server --+ bin --+
  |          |
  |          + conf --+
  |          |        |
  |          |        +
  |          |
  |          + webapps --+ ROOT
  |                      |
  |                      + sqoop.war
  + ...

As part of this process, a copy of the Tomcat server is also downloaded and put under the server directory in the above structure.

If you are on particular release branch such as 1.99.4, all the artifacts in it will be created with the 1.99.4 build version. for instance sqoop-1.99.4-bin-hadoop200.tar.gz

Installing Sqoop2 on remote server

To install generated binaries on remote server simply copy directory sqoop-2.0.0-SNAPSHOT to your remote server:

scp -r dist/target/sqoop-2.0.0-SNAPSHOT

Install dependencies

Sqoop server is depending on hadoop binaries, but they are not part of the distribution and thus you need to install them into Sqoop server manually. The latest hadoop version we support is 2.5.2 .

VB: There is no in the in the latest code under sqoop-2.0.0-SNAPSHOT/bin as of this writing


To install hadoop libraries execute command with argument -hadoop $version $location. Following example is for Cloudera distribution version 4(CDH4):

 ./bin/ -hadoop 2.0 /usr/lib/hadoop/client/

If you're running CDH4 MR1:

cd dist/target/sqoop-2.0.0-SNAPSHOT-bin-hadoop200 or cd dist/target/sqoop-2.0.0-SNAPSHOT
./bin/ -hadoop-version cdh4mr1 -hadoop-path /usr/lib

In case that you're running original Mapreduce implementation (MR1), you will also need to install it's jar:

 ./bin/ -jars /usr/lib/hadoop-0.20-mapreduce/hadoop-2.0.0-mr1-cdh4.1.1-core.jar

You can install any arbitrary jars (connectors, JDBC drivers) using -jars argument that takes list of jars separated by ":". Here is example for installing MySQL jdbc driver into Sqoop server:

  ./bin/ -jars /path/to/jar/mysql-connector-java-5.1.21-bin.jar

Installing a new connector to Sqoop2

If you are contributing or adding a new connector say sqoop-foo-connector to the sqoop2, here are steps to follow.


Step 1: Create a sqoop-foo-connector.jar. Make sure the jar contains the for it to be picked up by sqoop

A typical for a sqoop2 connector looks like below

# Generic JDBC Connector Properties
org.apache.sqoop.connector.class = = sqoop-foo-connector


Step 2: Add this jar to the a folder on your installation machine and update the path to this folder in the located under the server/conf directory under the Sqoop2  for the key 


# External connectors load path
# "/path/to/external/connectors/": Add all the connector JARs in the specified folder


Step 3: Start the server and while initalizing the server this jar should be loaded into the sqoop's class path and registered into the sqoop repository/

Starting/Stopping Sqoop2 server

To start Sqoop2 server invoke the sqoop shell script:

cd dist/target/sqoop-2.0.0-SNAPSHOT
bin/ server start

The Sqoop2 server is then running as a web application within the Tomcat server.

Similarly, to stop Sqoop2 server, do the following:

bin/ server stop

Starting/Running Sqoop2 client

To start an interactive shell,

bin/ client

This will bring up an interactive client ready for input commands:

Sqoop Shell: Type 'help' or '\h' for help.


Please see the 5 min Demo Guide or the Command Line Shell Guide for the latest release 1.99.*

Sqoop configuration files 

Both the default bootstrap configuration and the main configuration are located under the server/conf directory in the Sqoop2 distribution directory.

The bootstrap configuration controls what the mechanism is to provide configuration for different managers in the Sqoop.


The main configuration controls what the mechanism is for where the

  • Where are the log files are, what the logging levels are?
  • What is the repository used?
  • What is the submission/ execution engine used?
  • What is the Authentication mechanism used?
# Logging Configuration
# Any property that starts with the prefix
# org.apache.sqoop.log4j is parsed out by the configuration
# system and passed to the log4j subsystem. This allows you
# to specify log4j configuration properties from within the
# Sqoop configuration.
org.apache.sqoop.log4j.appender.file.layout.ConversionPattern=%d{ISO8601} %-5p %c{2} [%l] %m%n
org.apache.sqoop.log4j.rootCategory=WARN, file
# Audit Loggers Configuration
# Multiple audit loggers could be given here. To specify an
# audit logger, you should at least add org.apache.sqoop.
# auditlogger.[LoggerName].class. You could also provide
# more configuration options by using org.apache.sqoop.
# auditlogger.[LoggerName] prefix, then all these options
# are parsed to the logger class.
# Repository configuration
# The Repository subsystem provides the special prefix which
# is "org.apache.sqoop.repository.sysprop". Any property that
# is specified with this prefix is parsed out and set as a
# system property. For example, if the built in Derby repository
# is being used, the sysprop prefixed properties can be used
# to affect Derby configuration at startup time by setting
# the appropriate system properties.
# Repository provider
# Repository upgrade
# If set to true, it will not upgrade the sqoop respository schema, by default it will iniate the upgrade on server start-up
# JDBC repository provider configuration
# System properties for embedded Derby configuration
# Sqoop Connector configuration
# If set to true will initiate Connectors config upgrade during server startup
# Sqoop Driver configuration
# If set to true will initiate the Driver config upgrade during server startup
# Sleeping period for reloading configuration file (once a minute)
# Submission engine configuration
# Submission engine class
# Number of milliseconds, submissions created before this limit will be removed, default is one day
# Number of milliseconds for purge thread to sleep, by default one day
# Number of milliseconds for update thread to sleep, by default 5 minutes
# Configuration for Mapreduce submission engine (applicable if it's configured)
# Hadoop configuration directory
# Execution engine configuration
# Authentication configuration

Debug Logs information

  • The logs of the Tomcat server is located under the server/logs directory in the Sqoop2 distribution directory, most relevant would be catalina.out
  • The logs of the Sqoop2 server  as sqoop.log  (by default unless changed by the above configuration file ) under the  (@LOGDIR) directory in the Sqoop2 distribution directory.
  • The logs for the Derby repository is  derbyrepo.log (by default unless changed by the above  configuration file ) under the  (@LOGDIR) directory in the Sqoop2 distribution directory.
  • No labels