一、工具介绍

1、功能描述

一句话，dbswitch工具提供源端数据库向目的端数据库的批量迁移同步功能，支持数据的全量和增量方式同步。包括：

• 结构迁移

支持字段类型、主键信息、建表语句等的转换，并生成建表SQL语句。

支持基于正则表达式转换的表名与字段名映射转换。

• 数据同步。

基于JDBC的分批次读取源端数据库数据，并基于insert/copy方式将数据分批次写入目的数据库。

支持有主键表的 增量变更同步 （变化数据计算Change Data Calculate）功能(千万级以上数据量的性能尚需在生产环境验证)

2、功能设计

结构设计

• 模块结构设计
• 
  
• 模块结构功能

└── dbswitch
    ├── dbswitch-common    // dbswitch通用定义模块
    ├── dbswitch-pgwriter  // PostgreSQL的二进制写入封装模块
    ├── dbswitch-dbwriter  // 数据库的通用批量Insert封装模块
    ├── dbswitch-core      // 数据库元数据抽取与建表结构语句转换模块
    ├── dbswitch-sql       // 基于calcite的DML语句转换与DDL拼接模块
    ├── dbswitch-dbcommon  // 数据库操作通用封装模块
    ├── dbswitch-dbchange  // 基于全量比对计算变更（变化量）数据模块
    ├── dbswitch-dbsynch   // 将dbchange模块计算的变更数据同步入库模块
    ├── dbswitch-data      // 工具入口模块，读取配置文件中的参数执行异构迁移同步
    ├── dbswitch-admin     // 在以上模块的基础上引入Quartz的调度服务与接口
    ├── dbswitch-admin-ui  // 基于Vue2的前段WEB交互页面
    ├── package-tool       // 基于maven-assembly-plugin插件的项目打包模块

二、编译打包

本工具纯Java语言开发，代码中的依赖全部来自于开源项目。

1、编译打包

• 环境要求:
• JDK:>=1.8 （建议用JDK 1.8）
• maven:>=3.6

Maven 仓库默认在国外， 国内使用难免很慢，可以更换为阿里云的仓库。 参考教程： 配置阿里云的仓库教程

• 编译命令:

(1) windows下：

 双击build.cmd脚本文件即可编译打包

(2) Linux下：

git clone https://gitee.com/inrgihc/dbswitch.git
cd dbswitch/
sh ./build.sh

(3) Docker下:

git clone https://gitee.com/inrgihc/dbswitch.git
cd dbswitch/
sh ./docker-maven-build.sh

特别注意： 在Java9及以上版本默认情况下不允许应用程序查看来自JDK的所有类，但在dbswitch中利用反射计算对象的字节大小，所以需要在JVM启动时需要增加如下参数：

--add-opens java.base/jdk.internal.loader=ALL-UNNAMED --add-opens jdk.zipfs/jdk.nio.zipfs=ALL-UNNAMED

2、安装部署

(1) 当编译打包命令执行完成后，会在dbswitch/target/目录下生成dbswitch-relase-x.x.x.tar.gz的打包文件，将文件拷贝到已安装JRE的部署机器上解压即可。

(2) 基于docker-compose提供linux联网环境下的一键安装，安装命令见 发行版链接地址

文档详见: build-docker/install/README.md

三、工具使用

dbswitch工具提供基于conf/config.yml配置的dbswitch-data模块启动方式和基于conf/application.yml的dbswitch-admin模块的WEB端使用方式；

1、基于conf/config.yml配置的dbswitch-data模块启动命令操作方式

(1)、配置文件

配置文件信息请见部署包中的：conf/config.yml（注：也同时支持使用conf/config.properties配置文件名的properties格式），示例配置如下：

dbswitch:
  source:
    # source database connection information
    ## support MySQL/MariaDB/DB2/DM/Kingbase8/Oracle/SQLServer/PostgreSQL/Greenplum etc.
    ## support multiple source database connection
    - url: jdbc:oracle:thin:@172.17.2.10:1521:ORCL
      driver-class-name: 'oracle.jdbc.driver.OracleDriver'
      username: 'system'
      password: '123456'
      # source database configuration parameters
      ## fetch size for query source database
      fetch-size: 10000
      ## schema name for query source schemas, separate by ','
      source-schema: 'TANG'
      ## table type which include or exclude,option: TABLE,VIEW
      table-type: 'TABLE'
      ## table name include from table lists, separate by ','
      source-includes: ''
      ## table name exclude from table lists, separate by ','
      source-excludes: ''
      ## table name convert mapper by regular expression
      regex-table-mapper:
        - from-pattern: '^'
          to-value: 'T_'
      ## columns name convert mapper by regular expression like regex-table-mapper
      regex-column-mapper:

  target:
    # target database connection information
    ## Best support for Oracle/PostgreSQL/Greenplum/DM etc.
    url: jdbc:postgresql://172.17.2.10:5432/test
    driver-class-name: org.postgresql.Driver
    username: tang
    password: 123456
    # target database configuration parameters
    ## schema name for create/insert table data
    target-schema: public
    ## whether drop-create table when target table exist
    target-drop: true
    ## whether create table support auto increment for primary key field
    create-table-auto-increment: false
    ## whether use insert engine to write data for target database
    ## Only useful for PostgreSQL/Greenplum database
    writer-engine-insert: false
    ## whether use change data synchronize to target database table
    change-data-sync: true

注意:

• （1）支持源端为多个数据源类型，如果dbswitch.source[i]为数组类型，i为编号，从0开始的整数；
• （2）如果dbswitch.source[i].source-includes不为空，则按照包含表的方式来执行；
• （3）如果dbswitch.source[i].source-includes为空，则按照dbswitch.source[i].source-excludes排除表的方式来执行。
• （4）如果dbswitch.target.target-drop=false，dbswitch.target.change-data-synch=true；时会对有主键表启用增量变更方式同步
• （5）对于regex-table-mapper和regex-column-mappe，为基于正则表达式替换的表名映射和字段名映射，均可以为空（代表原名映射，即源的表t_a映射到目的端也为t_a）

提示：如果要将源端所有表名(或者字段名)添加前缀，可以配置"from-pattern": "^","to-value": "T_";

• （6）支持的数据库产品及其JDBC驱动连接示例如下：

MySQL/MariaDB数据库

jdbc连接地址：jdbc:mysql://172.17.2.10:3306/test?useUnicode=true&characterEncoding=utf-8&useSSL=false&zeroDateTimeBehavior=convertToNull&serverTimezone=Asia/Shanghai&nullCatalogMeansCurrent=true&tinyInt1isBit=false&rewriteBatchedStatements=true&useCompression=true
jdbc驱动名称： com.mysql.jdbc.Driver

与:

jdbc连接地址：jdbc:mariadb://172.17.2.10:3306/test?useUnicode=true&characterEncoding=utf-8&useSSL=false&zeroDateTimeBehavior=convertToNull&serverTimezone=Asia/Shanghai&nullCatalogMeansCurrent=true&tinyInt1isBit=false&rewriteBatchedStatements=true&useCompression=true
jdbc驱动名称： org.mariadb.jdbc.Driver

Oracle数据库

jdbc连接地址：jdbc:oracle:thin:@172.17.2.10:1521:ORCL  或   jdbc:oracle:thin:@//172.17.2.10:1521/ORCL
jdbc驱动名称：oracle.jdbc.driver.OracleDriver

SQL Server(>=2005)数据库

jdbc连接地址：jdbc:sqlserver://172.17.2.10:1433;DatabaseName=test
jdbc驱动名称：com.microsoft.sqlserver.jdbc.SQLServerDriver

Sybase数据库

jdbc连接地址：jdbc:sybase:Tds:172.17.2.10:5000/test
jdbc驱动名称：com.sybase.jdbc4.jdbc.SybDriver

PostgreSQL/Greenplum数据库

jdbc连接地址：jdbc:postgresql://172.17.2.10:5432/test
jdbc驱动名称：org.postgresql.Driver

DB2数据库

jdbc连接地址：jdbc:db2://172.17.2.10:50000/testdb:driverType=4;fullyMaterializeLobData=true;fullyMaterializeInputStreams=true;progressiveStreaming=2;progresssiveLocators=2;
jdbc驱动名称：com.ibm.db2.jcc.DB2Driver

达梦DMDB数据库

jdbc连接地址：jdbc:dm://172.17.2.10:5236
jdbc驱动名称：dm.jdbc.driver.DmDriver

人大金仓Kingbase8数据库

jdbc连接地址：jdbc:kingbase8://172.17.2.10:54321/MYTEST
jdbc驱动名称：com.kingbase8.Driver

神通Oscar数据库

jdbc连接地址：jdbc:oscar://172.17.2.1:2003/OSRDB
jdbc驱动名称：com.oscar.Driver

南大通用GBase8a数据库

jdbc连接地址：jdbc:gbase://172.17.2.1:5258/gbase
jdbc驱动名称：com.gbase.jdbc.Driver

翰高HighGo数据库(可按PostgreSQL使用)

jdbc连接地址：jdbc:postgresql://172.17.2.10:5866/highgo
jdbc驱动名称：org.postgresql.Driver

Apache Hive数据库

jdbc连接地址：jdbc:hive2://172.17.2.12:10000/default
jdbc驱动名称：org.apache.hive.jdbc.HiveDriver

注意：当前只支持hive version 3.x的账号密码认证方式。

SQLite数据库

jdbc连接地址：jdbc:sqlite:/tmp/test.db   或者  jdbc:sqlite::resource:http://172.17.2.12:8080/test.db
jdbc驱动名称：org.sqlite.JDBC

注意:

(a) 本地文件方式：jdbc:sqlite:/tmp/test.db , 该方式适用于dbswitch为实体机器部署的场景。

(b) 远程文件方式: jdbc:sqlite::resource:http://172.17.2.12:8080/test.db ,该方式适用于容器方式部署的场景, 搭建文件服务器的方法可使 用如下docker方式快速部署(/home/sqlites为服务器上存放sqlite数据库文件的目录)：

docker run -d --name http_file_server -p 8080:8080 -v /home/sqlites:/data inrgihc/http_file_server:latest

说明：远程服务器文件将会被下载到本地System.getProperty("java.io.tmpdir")所指定的目录下(linux为/tmp/，Windows为C:/temp/)，并以 sqlite-jdbc-tmp-{XXX}.db的方式进行文件命名，其中{XXX}为文件网络地址(例如上述为http://192.168.31.57:8080/test.db) 的字符串哈希值， 如果本地文件已经存在则不会再次进行下载而是直接使用该文件(当已经下载过文件后，远程服务器即使关闭了，该sqlite的jdbc-url任然可 用，直至本地的sqlite-jdbc-tmp-XXX.db文件被人为手动删除)

(c) 不支持内存及其他方式;本地文件方式可以作为源端和目的端，而远程服务器方式只能作为源端。

(d) SQLite为单写多读方式，禁止人为方式造成多写导致锁表。

(2)、启动方法

• linux系统下：

cd dbswitch-release-X.X.X/
bin/datasync.sh

• windows系统下：

切换到dbswitch-release-X.X.X/bin/目录下，双击datasync.cmd脚本文件即可启动

(3)、额外说明

• 1、对于向目的库为PostgreSQL/Greenplum的数据离线同步默认采用copy方式写入数据，说明如下：
• （a） 如若使用copy方式写入，配置文件中需配置为postgresql的jdbc url和驱动类（不能为greenplum的驱动包），
• （b） 如若使用insert方式写入，需要在config.properties配置文件中设置如下参数为true:

dbswitch.target.writer-engine-insert=true

• 2、dbswitch离线同步工具支持的数据类型包括：整型、时间、文本、二进制等常用数据类型;
• 3、Oracle的表虽然设置了主键，如果主键约束实际为DISABLED状态，那在进行结构转换时会按照没有此主键处理。
• 4、关于增量变更同步方式的使用说明

步骤A：先通过设置dbswitch.target.target-drop=true，dbswitch.target.change-data-sync=false；启动程序进行表结构和数据的全量同步;

步骤B：然后设置dbswitch.target.target-drop=false，dbswitch.target.change-data-sync=true；再启动程序对（有主键表）数据进行增量变更同步。

注：如果待同步的两端表结构已经一致或源端字段是目的端字段的子集，也可直接用步骤B配置进行变更同步

2、基于conf/application.yml配置的dbswitch-admin模块启动的WEB使用方式

(1)、准备一个MySQL(建议为：版本为 5.7+ )的数据库

(2)、配置conf/application.yml

server:
  port: 9088

spring:
  application:
    name: dbswitch-admin
  tomcat:
    uri-encoding: UTF-8
    max-http-header-size: 8096
  mvc:
    throw-exception-if-no-handler-found: true
    static-path-pattern: /statics/**
  datasource:
    driver-class-name: com.mysql.jdbc.Driver
    url: jdbc:mysql://192.168.31.57:3306/dbswitch?createDatabaseIfNotExist=true&useUnicode=true&characterEncoding=UTF8&useSSL=false
    username: tangyibo
    password: 123456
    validation-query: SELECT 1
    test-on-borrow: true
  flyway:
    locations: classpath:db/migration
    baseline-on-migrate: true
    table: DBSWITCH_SCHEMA_HISTORY
    enabled: true

mybatis:
  configuration:
    lazy-loading-enabled: true
    aggressive-lazy-loading: false
    map-underscore-to-camel-case: true
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl

mapper:
  wrap-keyword: "`{0}`"
  enable-method-annotation: true

按照上述配置，修改conf/application.yml配置文件中的spring.datasource.url和spring.datasource.username及spring.datasource.password三个字段值的配置。

(3)、启动dbswitch-admin系统

• linux系统下：

cd dbswitch-release-X.X.X/
bin/startup.sh

• windows系统下：

切换到dbswitch-release-X.X.X/bin/目录下，双击startup.cmd脚本文件即可启动

(4)、补充说明

• dbswitch-admin的WEB端会根据用户的配置调用dbswitch-data模块执行数据迁移同步；
• dbswitch-admin服务启动时会基于flyway自动建库建表，需要保证配置的mysql连接账号具有建库建表等权限；
• dbswitch离线同步工具提供各种数据库间表结构转换RESTful在线API接口如下:（详见接口文档）
• WEB系统的访问如下：

URL地址: http://127.0.0.1:9088 登陆账号：admin 登陆密码：123456

Swagger在线接口地址： http://127.0.0.1:9088/swagger-ui/

注意：如果为服务器部署时，需要将127.0.0.1替换为服务器的IP地址。

• WEB系统的使用流程为：

建立源端数据库的连接 -> 建立目的断数据库的连接 -> 配置任务 -> 发布任务 -> 手动/系统调度执行任务 -> 查看调度记录 -> 数据目录查看数据结果

• WEB系统的部分截图：

3、两种方式的适用场景

• 方式一：基于conf/config.yml配置的dbswitch-data模块启动的命令操作方式式

优点：

当需要配置的表或字段等数量较大时，该方式便于在yml中配置；

只需一个配置文件即可进行启动执行任务；

缺点：

只能运行单个任务，任务执行完立即停止；

不支持CRON表达式的周期执行；

• 方式二：基于conf/application.yml配置的dbswitch-admin模块启动的WEB使用方式

优点：

提供WEB操作来配置（方式一的YAML中的参数）,只需点击即可完成配置；

支持多个任务并发执行（在硬件资源足够的条件下）

支持CRON表达式的周期执行

缺点：

当数据库内的表或字段数量较大时，WEB方式卡顿严重；

多个任务并发执行不易于分析任务错误原因；

四、模块集成开发说明

1、dbswitch安装到本地仓库

cd dbswitch && mvn clean install

2、pom.xml中引入dbswitch模块依赖

<dependency>
 <groupId>com.gitee.dbswitch</groupId>
 <artifactId>dbswitch-data</artifactId>
 <version>${dbswitch.version}</version>
</dependency>

3、代码集成开发

// 构造dbswitch所需的配置参数，参数说明请参考第三章第1小节
DbswichProperties properties = new DbswichProperties();
properties.setXXXX();

// 将参数传递给dbswitch启动同步方式执行
MigrationService service = new MigrationService(properties);
service.run();

五、常见问题解决

• （1）在Windows下，执行startup.cmd或datasync.cmd脚本报错

解决办法：将脚本的内容复制后，删除原脚本文件，然后再创建一个同名脚本文件后，将原内容粘贴进去后，再执行脚本。

• （2）在Linux下，执行startup.sh或datasync.sh脚本报错

解决办法：用vi/vim工具打开脚本，然后命令模式下设置 set ff=unix后，然后保存退出，再执行脚本。

最后

就先更到这里了，有需要异构数据库迁移同步工具的朋友关注+转发+评论之后私信我【异构数据库】即可。