ETL系列之Sqoop

==楼兰==

一、ETL简介

1、关于ETL

​ ETL的英文全称是 Extract-Transform-Load，即代表了大数据迁移过程中的抽取(Extract)、转换(Transform)、加载(Load)的过程。其目的是将企业中分散、凌乱、标准不统一的数据整合到一起，为企业的决策提供分析依据。

​ 一个完整的ETL过程就是将数据从数据源中抽取出来，经过一系列的清洗、转换等操作后，输出到目的数据源中。ETL中的数据源，不光是传统保存到数据库中的业务数据，还包括日志、MQ、网络数据包等各种各样的数据。ETL中的转换操作，就是对数据进行一些处理，但是在ETL过程中的处理，通常只包含一些简单的数据清洗、转换工作，而不会涉及到复杂的数据计算。

​ 一个典型的大数据项目，通常会独立于业务系统单独部署一个数据存储，然后通过ETL过程，将业务系统的数据、日志等信息集中抽取到大数据存储中，再基于大数据存储进行独立于业务系统的数据运算。ETL的技术门槛通常不是很高，但是他却是大数据项目中不可或缺的一个重要组成部分。

2、大数据与传统关系型数据库的关系

​ 这里我们讨论一个经常会被问到的问题，既然大数据存储比如Hive、HBase、ES等，相比传统的关系型数据库例如MySQL等，他的容量优势几乎是碾压的，那为什么不抛弃传统关系型数据库，直接使用基于大数据存储的数据库呢？

​ 这涉及到如何对存储进行规划的问题。一方面，传统关系型数据库相比于基于大数据存储的数据库，在事务处理、读写性能等方面依然有不可忽略的优势。另一方面，通常情况下，大数据应用处理的数据价值是低于关系型数据库的。大数据存储数据库需要存储各个方面的数据，这些数据的业务价值是不一样的。就好比是矿石，里面即包含有价值的金属，也包含没有价值的泥土。而关系型数据库通常用来存储的是具有重要业务价值的数据。就好比是从矿石中精炼出来的金属。再结合部署、运维成本等其他方面的综合因素，大数据与关系型数据库依然需要并存很长一段时间。用关系型数据库来进行快速完整的事务处理，而将存量数据导入到大数据存储系统中进行统一分析。而ETL，就是连接大数据与关系型数据库之间的数据纽带 。

3、Sqoop简介

​ ETL的技术门槛其实并不是很高，通常将不同数据源的CRUD整合起来，就可以完成ETL工作。而成熟的软件工具也有不少。除了这节课程介绍的Sqoop，还有kettle、flume以及FileBeat+ELK等等非常多的工具可以选择，并且大部分的ETL工作，就算不使用这些工具，自己实现也是非常容易的。像Flink、Spark这些计算框架也都可以很方便的实现大规模的数据ETL工作。在学习这些工具时，也需要同时理解ETL的思想。

​ Sqoop就是其中最为老牌的一个开源ETL工具。Sqoop项目开始于2009年，最早就是作为Hadoop的一个第三方模块存在的。后来为了让使用者能够快速部署，才独立成为了一个Apahce的顶级项目。

​ 他的主要作用也就是用于在Hadoop(同时也包含基于Hadoop的数据存储hdfs,hive,hbase…)与传统关系型数据库(mysql,oracle,postgresql…)之间进行数据的传递。

​ Sqoop的功能都是围绕Hadoop来进行的，导入操作被定义为将关系型数据库中的数据存入到Hadoop中。而导出操作被定义为将Hadoop中的数据存入到关系型数据库中。并且整个导入导出的功能，也都是以Hadoop的Mapreduce计算框架为基础的。Sqoop就是将导入或导出的命令翻译成mapreduce计算程序。而应用主要是对mapreduce的inputformat和outputformat进行定制。

二、Sqoop下载

Sqoop官网地址：http://sqoop.apache.org/

​ 目前阶段Sqoop已经显示retired退休了，但是其实并不是Sqoop已经被淘汰了，而是被移入了Attic。这个Attic相当于是Apache的一个小黑屋，长期没有进行更新的Apache项目就会被移入到Attic。Sqoop移入到Attic，并不影响正常的下载使用，只是Bug修复以及版本更新会比较慢。这其实也从一个侧面说明Sqoop项目在ETL这个领域已经足够成熟。

​ Sqoop主要有两个版本，Sqoop 1，目前最新的版本号是1.4.7。Sqoop 2，目前最新的版本号是1.99.7。其中，Sqoop2版本与Sqoop1版本不兼容，并且也并不是为了生产环境部署而设计的，所以通常只使用Sqoop 1版本即可。

三、Sqoop基础使用

3.1 前置软件

​ 由于Sqoop是在关系型数据库与Hadoop之间采集数据，使用Sqoop之前需要安装java和Hadoop，另外还需要一个关系型数据库，例如MySQL。Hive和HBase为可选软件。

3.2 Sqoop安装

​ Sqoop的安装比较简单，就是解压，配置，执行三个步骤。

​ 下载地址 http://archive.apache.org/dist/sqoop/ 获取Sqoop安装包sqoop-1.4.7.bin__hadoop-2.6.0.tar.gz。上传到服务器后，进行解压。

​ 在解压后的目录中，主要的配置文件在conf目录。Sqoop默认只提供了一个配置文件模版，需要手动复制配置文件。

cp sqoop-env-template.sh sqoop-env.sh

然后修改sqoop-env.sh中的配置内容，主要是指定Hadoop、Hive、HBase、Zookeeper这些相关组件的安装目录。

export HADOOP_COMMON_HOME=/app/hadoop/hadoop-3.2.2
export HADOOP_MAPRED_HOME=/app/hadoop/hadoop-3.2.2
export HIVE_HOME=/app/hive/
export ZOOKEEPER_HOME=/app/zookeeper/zookeeper-3.5.8
export ZOOCFGDIR=/app/zookeeper/zookeeper-3.5.8
export HBASE_HOME=/app/hbase/hbase-2.4.4

​ 接下来，如果需要操作MySQL，还需要手动将MySQL的JDBC驱动包上传到Sqoop的lib目录下。

3.3 Sqoop基础使用

1、查看Sqoop的帮助信息

bin/sqoop help

如果正常，可以看到Sqoop的命令提示

Available commands:
  codegen            Generate code to interact with database records
  create-hive-table     Import a table definition into Hive
  eval               Evaluate a SQL statement and display the results
  export             Export an HDFS directory to a database table
  help               List available commands
  import             Import a table from a database to HDFS
  import-all-tables     Import tables from a database to HDFS
  import-mainframe    Import datasets from a mainframe server to HDFS
  job                Work with saved jobs
  list-databases        List available databases on a server
  list-tables           List available tables in a database
  merge              Merge results of incremental imports
  metastore           Run a standalone Sqoop metastore
  version            Display version information

2、单独连接数据库

bin/sqoop list-databases --connect jdbc:mysql://hadoop01:3306/ --username root --password root

正常情况下，将会列出MySQL中创建的所有数据库。

这两个步骤通常用来检测Sqoop部署是否成功。

3、导入数据

​ 在Sqoop中，"导入"是指从关系型数据库向大数据集群中传输数据，对应import指令。

全部导入：

bin/sqoop import \\
--connect jdbc:mysql://hadoop01:3306/testdb \\
--username root \\
--password root \\
--table user \\
--target-dir /user \\
--delete-target-dir \\
--num-mappers 1 \\
--fields-terminated-by "\\t"

查询导入：

bin/sqoop import \\
--connect jdbc:mysql://hadoop01:3306/testdb \\
--username root \\
--password root \\
--target-dir /user \\
--delete-target-dir \\
--num-mappers 1 \\
--fields-terminated-by "\\t" \\
--query 'select name,sex from user where id <=1 and $CONDITIONS;'

注意：在查询语句中$CONDITIONS这个关键字是不可少的。在日志中可以看到，这个关键字将被Sqoop翻译成为分片执行的一些过滤条件。

导入指定列：

bin/sqoop import \\
--connect jdbc:mysql://hadoop01:3306/testdb \\
--username root \\
--password root \\
--target-dir /user \\
--delete-target-dir \\
--num-mappers 1 \\
--fields-terminated-by "\\t" \\
--columns id,sex \\
--table user

注意：在columns中包含多个列时不要有空格。

使用相关关键字进行查询

bin/sqoop import \\
--connect jdbc:mysql://hadoop01:3306/testdb \\
--username root \\
--password root \\
--target-dir /user \\
--delete-target-dir \\
--num-mappers 1 \\
--fields-terminated-by "\\t" \\
--table staff \\
--where "id=1"

从MySQL导入Hive

bin/sqoop import \\
--connect jdbc:mysql://hadoop01:3306/testdb \\
--username root \\
--password root \\
--table user \\
--num-mappers 1 \\
--hive-import \\
--fields-terminated-by "\\t" \\
--hive-overwrite \\
--hive-table hive_user

注意：sqoop操作hive还需要引入hive-common-xxx.jar这个工具包。手动从hive的lib目录下复制过来即可。

这个过程是先将数据导出到HDFS的一个临时目录上，然后再执行Hive数据迁移。迁移完成后，临时目录就会删除。

从MySQL导入HBase

bin/sqoop import \\
--connect jdbc:mysql://hadoop01:3306/testdb \\
--username root \\
--password root \\
--table user \\
--columns "id,name,sex" \\
--column-family "user" \\
--hbase-create-table \\
--hbase-row-key "id" \\
--hbase-table "hbase_user" \\
--num-mappers 1 \\
--split-by id

​ 这个过程会自动在Hbase中创建表，但是如果Sqoop与HBase的版本不兼容，建表就会失败，这时就需要手动创建HBase表。

4、导出数据

​ Sqoop的导出，是指从Hadoop平台向外导出数据，对应export指令。

Hive/HDFS 导出到MySQL

bin/sqoop export \\
--connect jdbc:mysql://hadoop01:3306/testdb \\
--username root \\
--password root \\
--table user \\
--num-mappers 1 \\
--export-dir /user/hive/warehouse/hive_user \\
--input-fields-terminated-by "\\t"

注意：MySQL中要手动建表。

5、通过脚本执行

Sqoop还提供了根据脚本进行任务执行的方式。这样就不用敲复杂的指令了。

通过vi /root/sqoop/userJob.opt定制一个用户数据的迁移过程

export
--connect
jdbc:mysql://hadoop01:3306/testdb
--username
root
--password
root
--table
user
--num-mappers
1
--export-dir
/user/hive/warehouse/staff_hive
--input-fields-terminated-by
"\\t"

然后可以在sqoop命令执行过程中，通过 --options-file指令指定脚本文件

bin/sqoop --options-file /root/sqoop/userJob.opt

这个任务就能够很容易的配置到一些定时任务工具中，比如crontab。

四、详细参数补充

这一部分就列出一些Sqoop常用到的参数，可以作为手册快速翻阅。当然更详细的说明可以参见官网上的说明文档。

Sqoop目前已经很少更新，所以官网文档建议直接保存下来。

1 常用命令列举

这里给大家列出来了一部分Sqoop操作时的常用参数，以供参考，需要深入学习的可以参看对应类的源代码。

序号	命令	类	说明
1	import	ImportTool	将数据导入到集群
2	export	ExportTool	将集群数据导出
3	codegen	CodeGenTool	获取数据库中某张表数据生成Java并打包Jar
4	create-hive-table	CreateHiveTableTool	创建Hive表
5	eval	EvalSqlTool	查看SQL执行结果
6	import-all-tables	ImportAllTablesTool	导入某个数据库下所有表到HDFS中
7	job	JobTool	用来生成一个sqoop的任务，生成后，该任务并不执行，除非使用命令执行该任务。
8	list-databases	ListDatabasesTool	列出所有数据库名
9	list-tables	ListTablesTool	列出某个数据库下所有表
10	merge	MergeTool	将HDFS中不同目录下面的数据合在一起，并存放在指定的目录中
11	metastore	MetastoreTool	记录sqoop job的元数据信息，如果不启动metastore实例，则默认的元数据存储目录为：~/.sqoop，如果要更改存储目录，可以在配置文件sqoop-site.xml中进行更改。
12	help	HelpTool	打印sqoop帮助信息
13	version	VersionTool	打印sqoop版本信息

2 命令&参数详解

接下来列举一些执行参数。

首先来我们来介绍一下公用的参数，所谓公用参数，就是大多数命令都支持的参数。

2.1 公用参数：数据库连接

序号	参数	说明
1	–connect	连接关系型数据库的URL
2	–connection-manager	指定要使用的连接管理类
3	–driver	Hadoop根目录
4	–help	打印帮助信息
5	–password	连接数据库的密码
6	–username	连接数据库的用户名
7	–verbose	在控制台打印出详细信息

2.2 公用参数：import

序号	参数	说明
1	–enclosed-by	给字段值前加上指定的字符
2	–escaped-by	对字段中的双引号加转义符
3	–fields-terminated-by	设定每个字段是以什么符号作为结束，默认为逗号
4	–lines-terminated-by	设定每行记录之间的分隔符，默认是\\n
5	–mysql-delimiters	Mysql默认的分隔符设置，字段之间以逗号分隔，行之间以\\n分隔，默认转义符是\\，字段值以单引号包裹。
6	–optionally-enclosed-by	给带有双引号或单引号的字段值前后加上指定字符。

2.3 公用参数：export

序号	参数	说明
1	–input-enclosed-by	对字段值前后加上指定字符
2	–input-escaped-by	对含有转移符的字段做转义处理
3	–input-fields-terminated-by	字段之间的分隔符
4	–input-lines-terminated-by	行之间的分隔符
5	–input-optionally-enclosed-by	给带有双引号或单引号的字段前后加上指定字符

2.4 公用参数：hive

序号	参数	说明
1	–hive-delims-replacement	用自定义的字符串替换掉数据中的\\r\\n和\\013 \\010等字符
2	–hive-drop-import-delims	在导入数据到hive时，去掉数据中的\\r\\n\\013\\010这样的字符
3	–map-column-hive	生成hive表时，可以更改生成字段的数据类型
4	–hive-partition-key	创建分区，后面直接跟分区名，分区字段的默认类型为string
5	–hive-partition-value	导入数据时，指定某个分区的值
6	–hive-home	hive的安装目录，可以通过该参数覆盖之前默认配置的目录
7	–hive-import	将数据从关系数据库中导入到hive表中
8	–hive-overwrite	覆盖掉在hive表中已经存在的数据
9	–create-hive-table	默认是false，即，如果目标表已经存在了，那么创建任务失败。
10	–hive-table	后面接要创建的hive表,默认使用MySQL的表名
11	–table	指定关系数据库的表名

接下来是一些命令对应的特有参数。

2.5 命令&参数：import

将关系型数据库中的数据导入到HDFS（包括Hive，HBase）中，如果导入的是Hive，那么当Hive中没有对应表时，则自动创建。

1) 命令：

如：导入数据到hive中

bin/sqoop import \\--connect jdbc:mysql://hadoop01:3306/testdb \\
--username root \\
--password 000000 \\
--table user \\
--hive-import 

如：增量导入数据到hive中，mode=append

bin/sqoop import \\
--connect jdbc:mysql://hadoop01:3306/testdb \\
--username root \\
--password root \\
--table user \\
--num-mappers 1 \\
--fields-terminated-by "\\t" \\
--target-dir /user/hive/warehouse/staff_hive \\
--check-column id \\
--incremental append \\
--last-value 3

注意：append不能与–hive-等参数同时使用（Append mode for hive imports is not yet supported. Please remove the parameter --append-mode）

如：增量导入数据到hdfs中，mode=lastmodified

先在mysql中建表并插入几条数据：
mysql> create table user2(id int(4), name varchar(255), sex varchar(255), last_modified timestamp DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP);
mysql> insert into user2 (id, name, sex) values(1, 'AAA', 'female');
mysql> insert into company.staff_timestamp (id, name, sex) values(2, 'BBB', 'female');
导入一部分数据：
$ bin/sqoop import \\
--connect jdbc:mysql://hadoop01:3306/testdb \\
--username root \\
--password root \\
--table user \\
--delete-target-dir \\
--m 1
再增量导入一部分数据：
mysql> insert into company.staff_timestamp (id, name, sex) values(3, 'CCC', 'female');

$ bin/sqoop import \\
--connect jdbc:mysql://hadoop01:3306/testdb \\
--username root \\
--password root \\
--table user2 \\
--check-column last_modified \\
--incremental lastmodified \\
--last-value "2017-09-28 22:20:38" \\
--m 1 \\
--append

注意：使用lastmodified方式导入数据要指定增量数据是要–append（追加）还是要–merge-key（合并）

last-value指定的值是会包含于增量导入的数据中

2) 参数：

序号	参数	说明
1	–append	将数据追加到HDFS中已经存在的DataSet中，如果使用该参数，sqoop会把数据先导入到临时文件目录，再合并。
2	–as-avrodatafile	将数据导入到一个Avro数据文件中
3	–as-sequencefile	将数据导入到一个sequence文件中
4	–as-textfile	将数据导入到一个普通文本文件中
5	–boundary-query	边界查询，导入的数据为该参数的值（一条sql语句）所执行的结果区间内的数据。
6	–columns <col1, col2, col3>	指定要导入的字段
7	–direct	直接导入模式，使用的是关系数据库自带的导入导出工具，以便加快导入导出过程。
8	–direct-split-size	在使用上面direct直接导入的基础上，对导入的流按字节分块，即达到该阈值就产生一个新的文件
9	–inline-lob-limit	设定大对象数据类型的最大值
10	–m或–num-mappers	启动N个map来并行导入数据，默认4个。
11	–query或–e	将查询结果的数据导入，使用时必须伴随参–target-dir，–hive-table，如果查询中有where条件，则条件后必须加上$CONDITIONS关键字
12	–split-by	按照某一列来切分表的工作单元，不能与–autoreset-to-one-mapper连用（请参考官方文档）
13	–table	关系数据库的表名
14	–target-dir	指定HDFS路径
15	–warehouse-dir	与14参数不能同时使用，导入数据到HDFS时指定的目录
16	–where	从关系数据库导入数据时的查询条件
17	–z或–compress	允许压缩
18	–compression-codec	指定hadoop压缩编码类，默认为gzip(Use Hadoop codec default gzip)
19	–null-string	string类型的列如果null，替换为指定字符串
20	–null-non-string	非string类型的列如果null，替换为指定字符串
21	–check-column
作为增量导入判断的列名
22	–incremental	mode：append或lastmodified
23	–last-value	指定某一个值，用于标记增量导入的位置

5.2.6 命令&参数：export

从HDFS（包括Hive和HBase）中奖数据导出到关系型数据库中。

**1) 命令：

$ bin/sqoop export \\
--connect jdbc:mysql://hadoop01:3306/company \\
--username root \\
--password root \\
--table user \\
--export-dir /user \\
--input-fields-terminated-by "\\t" \\
--num-mappers 1

2) 参数：

序号	参数	说明
1	–direct	利用数据库自带的导入导出工具，以便于提高效率
2	–export-dir	存放数据的HDFS的源目录
3	-m或–num-mappers	启动N个map来并行导入数据，默认4个
4	–table	指定导出到哪个RDBMS中的表
5	–update-key	对某一列的字段进行更新操作
6	–update-mode	updateonlyallowinsert(默认)
7	–input-null-string	请参考import该类似参数说明
8	–input-null-non-string	请参考import该类似参数说明
9	–staging-table	创建一张临时表，用于存放所有事务的结果，然后将所有事务结果一次性导入到目标表中，防止错误。
10	–clear-staging-table	如果第9个参数非空，则可以在导出操作执行前，清空临时事务结果表

5.2.7 命令&参数：codegen

将关系型数据库中的表映射为一个Java类，在该类中有各列对应的各个字段。

$ bin/sqoop codegen \\
--connect jdbc:mysql://hadoop01:3306/testdb \\
--username root \\
--password root \\
--table user \\
--bindir /root/staff \\
--class-name User \\
--fields-terminated-by "\\t"

序号	参数	说明
1	–bindir	指定生成的Java文件、编译成的class文件及将生成文件打包为jar的文件输出路径
2	–class-name	设定生成的Java文件指定的名称
3	–outdir	生成Java文件存放的路径
4	–package-name	包名，如com.z，就会生成com和z两级目录
5	–input-null-non-string	在生成的Java文件中，可以将null字符串或者不存在的字符串设置为想要设定的值（例如空字符串）
6	–input-null-string	将null字符串替换成想要替换的值（一般与5同时使用）
7	–map-column-java	数据库字段在生成的Java文件中会映射成各种属性，且默认的数据类型与数据库类型保持对应关系。该参数可以改变默认类型，例如：–map-column-java id=long, name=String
8	–null-non-string	在生成Java文件时，可以将不存在或者null的字符串设置为其他值
9	–null-string	在生成Java文件时，将null字符串设置为其他值（一般与8同时使用）
10	–table	对应关系数据库中的表名，生成的Java文件中的各个属性与该表的各个字段一一对应

5.2.8 命令&参数：create-hive-table

生成与关系数据库表结构对应的hive表结构。

命令：

$ bin/sqoop create-hive-table \\
--connect jdbc:mysql://hadoop01:3306/testdb \\
--username root \\
--password root \\
--table user \\
--hive-table hive_user

参数：

序号	参数	说明
1	–hive-home	Hive的安装目录，可以通过该参数覆盖掉默认的Hive目录
2	–hive-overwrite	覆盖掉在Hive表中已经存在的数据
3	–create-hive-table	默认是false，如果目标表已经存在了，那么创建任务会失败
4	–hive-table	后面接要创建的hive表
5	–table	指定关系数据库的表名

5.2.9 命令&参数：eval

可以快速的使用SQL语句对关系型数据库进行操作，经常用于在import数据之前，了解一下SQL语句是否正确，数据是否正常，并可以将结果显示在控制台。

命令：

$ bin/sqoop eval \\
--connect jdbc:mysql://hadoop01:3306/testdb \\
--username root \\
--password root \\
--query "SELECT * FROM staff"

参数：

序号	参数	说明
1	–query或–e	后跟查询的SQL语句

5.2.10 命令&参数：import-all-tables

可以将RDBMS中的所有表导入到HDFS中，每一个表都对应一个HDFS目录

命令：

$ bin/sqoop import-all-tables \\
--connect jdbc:mysql://hadoop01:3306/testdb \\
--username root \\
--password root \\
--warehouse-dir /all_tables

参数：

序号	参数	说明
1	–as-avrodatafile	这些参数的含义均和import对应的含义一致
2	–as-sequencefile
3	–as-textfile
4	–direct
5	–direct-split-size
6	–inline-lob-limit
7	–m或—num-mappers
8	–warehouse-dir
9	-z或–compress
10	–compression-codec

5.2.11 命令&参数：job

用来生成一个sqoop任务，生成后不会立即执行，需要手动执行。

命令：

$ bin/sqoop job \\
 --create myjob -- import-all-tables \\
 --connect jdbc:mysql://hadoop01:3306/testdb \\
 --username root \\
 --password root
$ bin/sqoop job \\
--list
$ bin/sqoop job \\
--exec myjob

注意import-all-tables和它左边的–之间有一个空格

参数：

序号	参数	说明
1	–create	创建job参数
2	–delete	删除一个job
3	–exec	执行一个job
4	–help	显示job帮助
5	–list	显示job列表
6	–meta-connect	用来连接metastore服务
7	–show	显示一个job的信息
8	–verbose	打印命令运行时的详细信息

注意：在执行一个job时，如果需要手动输入数据库密码，可以做如下优化

5.2.12 命令&参数：list-databases

命令：

$ bin/sqoop list-databases \\
--connect jdbc:mysql://hadoop01:3306/ \\
--username root \\
--password root

**参数：**与公用参数一样

5.2.13 命令&参数：list-tables

命令：

$ bin/sqoop list-tables \\
--connect jdbc:mysql://hadoop01:3306/testdb \\
--username root \\
--password root

**参数：**与公用参数一样

5.2.14 命令&参数：merge

将HDFS中不同目录下面的数据合并在一起并放入指定目录中

参数：

序号	参数	说明
1	–new-data	HDFS 待合并的数据目录，合并后在新的数据集中保留
2	–onto	HDFS合并后，重复的部分在新的数据集中被覆盖
3	–merge-key
合并键，一般是主键ID
4	–jar-file	合并时引入的jar包，该jar包是通过Codegen工具生成的jar包
5	–class-name	对应的表名或对象名，该class类是包含在jar包中的
6	–target-dir	合并后的数据在HDFS里存放的目录

5.2.15 命令&参数：metastore

记录了Sqoop job的元数据信息，如果不启动该服务，那么默认job元数据的存储目录为~/.sqoop，可在sqoop-site.xml中修改。

命令：

如：启动sqoop的metastore服务

$ bin/sqoop metastore

参数：

序号	参数	说明
1	–shutdown	关闭metastore