1 Star 0 Fork 3

草者 / junx-shardingsphere-datamigrate

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

介绍

  目前ShardingSphere做分库分表很流行,而且是国人开源的数据库中间件,值得我们去发扬光大。但是做分库分表难免会遇到数据库扩展,要进行数据迁移的问题,ShardingSphere本身提供了Sharding-Scaling用于全库全量+增量的方式进行主库与扩展库的同步,但是痛点在与Sharding-Scaling是全库同步,你必须准备两套数据库环境,有点浪费资源,而且万一你仅仅是想把原数据库中的某几个表做分表操作,采用Sharding-Scaling是杀鸡用牛刀,不合适。因此开发了轻量级数据迁移工具junx-shardingsphere-datamigrate,用于shardingsphere做部分表全量数据迁移(非增量)。

junx-shardingsphere-datamigrate源码参见:https://gitee.com/junxworks/junx-shardingsphere-datamigrate

datamigrate数据抽取逻辑

  junx-shardingsphere-datamigrate目前以功能简单直接为主,就是从指定的源库抽取数据,发往具有新分库分表逻辑的ShardingSphere-proxy代理,由sharding代理来执行新的数据分片逻辑,数据抽取大致逻辑如下, png   目前junx-shardingsphere-datamigrate仅支持从单一源库抽取指定的表发送到ShardingSphere-proxy代理,如果源库已经是分库,那么需要同时启动多个junx-shardingsphere-datamigrate进程来抽取多个库的数据。

使用

  junx-shardingsphere-datamigrate是基于springboot2.5.5开发,是一个标准的springboot web应用,内部有数据迁移引擎,实现了多数据源之间的数据同步功能,因此junx-shardingsphere-datamigrate的启动与普通的springboot web应用启动是一样的,通过jar包的方式启动,有已经打包好的程序,在/dist目录,下载下来修改配置文件后即可运行。 imagepng   把整个dist目录拷贝出来,编辑其中的start文件,windows是编辑start.bat文件,linux编辑start.sh。其中默认参数只有源数据库与目标数据库两个数据源的配置以及需要从源数据库中抽取的表列表,具体启动命令行如下:

java -Xmx4G -Xms4G -jar junx-shardingsphere-datamigrate-1.1.0.jar 
--spring.profiles.active=pro 
--spring.datasource.druid.primary.url="jdbc:mysql://ip:port/dbname?serverTimezone=Asia/Shanghai&allowMultiQueries=true&useUnicode=true&characterEncoding=UTF-8&autoReconnect=true&rewriteBatchedStatements=true&zeroDateTimeBehavior=convertToNull" 
--spring.datasource.druid.primary.username="xxx" 
--spring.datasource.druid.primary.password="xxx" 
--spring.datasource.druid.target.url="jdbc:mysql://ip:port/dbname?serverTimezone=Asia/Shanghai&allowMultiQueries=true&useUnicode=true&characterEncoding=UTF-8&autoReconnect=true&rewriteBatchedStatements=true&zeroDateTimeBehavior=convertToNull" 
--spring.datasource.druid.target.username="xxx" 
--spring.datasource.druid.target.password="xxx" 
--junx.sharding.migrate.tables=table_a|id,table_b|bid,table_c

最简单的配置如上所示,修改对应的参数后,就可以启动junx-shardingsphere-datamigrate了。

配置说明

  junx-shardingsphere-datamigrate提供了数据迁移时候的一些基础配置,这些配置都可以在程序的启动脚本中进行调整,这里主要说明一下数据迁移引擎相关配置,其他基础的配置参考springboot相关配置说明,这里不做赘述。

junx:
  sharding:
    migrate:
      clear-primary-key-value: true #写入数据的时候,是否需要清除主键值,默认true
      default-primary-key-name: id #默认数据库中表的关键字列名,在抽取数据过后会去掉原表关键字列,采用sharding的分片主键生成机制
      extract-batch-size: 2000 #数据抽取每批记录条数
      extract-executor: #数据抽取线程池配置,注意一张表有且仅有一个线程来抽取
        name-prefix: data-extract-  #数据抽取线程前缀
        min-spare-threads: 3   #允许的最大空闲线程数
        max-threads: 5  #线程池最大线程数,也就是最多允许5张表同时抽取
        max-queue-size: 100 #最多允许100张表待抽取
        rejected-execution-handler: CallerRuns  #当任务队列超限额的时候,采用的处理方式,有Abort中断、Discard放弃执行、CallerRuns调用者线程自己执行、DiscardOldest放弃最长时间没有执行的任务,将新任务加入到队尾
      write-batch-size: 2000  #数据写入抽取每批记录条数
      wirte-executor: #数据写入线程池配置,同抽取线程池
        name-prefix: data-write-  #数据写入线程前缀
        min-spare-threads: 5
        max-threads: 20 #最大允许20个线程同时写
        rejected-execution-handler: CallerRuns #背压一下,让call线程自己执行,缓冲一下
        max-queue-size: 10 #这个不能设置太大,因为每次事件发extract-batch-size条数据在内存中,太多任务排队,容易内存溢出
      tables: #需要抽取的表名|主键名
      - xxxx|id
      - yyyy  #如果不配置主键名,则走junx.sharding.migrate.default-primary-key-name设置的主键名

提示: executor相关配置,请参考https://gitee.com/junxworks/junx/blob/master/junx-core/src/main/java/io/github/junxworks/junx/core/executor/ExecutorConfig.java 额外提示: 需要注意的是有3个配置需要关联上一起配置,分别是junx.sharding.migrate.wirte-executor数据写入线程池、junx-shardingsphere-datamigrate应用程序本身的target数据库连接池大小以及即将写入的shardingsphere-proxy配置的后端数据库连接池大小,这几个需要关联起来一起配置,写入线程池配大了,会导致线程队列阻塞等待获取target数据库连接,shardingsphere-proxy配置的数据源小了,会往目标库导致写入数据慢。这个资源池大小配置建议 shardingsphere-proxy后端数据库连接池 > target数据库连接池 > junx.sharding.migrate.wirte-executor数据写入线程池。

API接口说明

  junx-shardingsphere-datamigrate是一个web应用,在启动程序后会监听端口为22222(可自行调整),junx-shardingsphere-datamigrate在当前版本提供了5个用于控制数据迁移引擎的API接口,分别如下所示:

  在调用启动引擎接口之后,就可以看到数据迁移引擎打印的日志信息了: imagepng

结语

  当前版本做得相对比较简单,仅仅是配置数据迁移的表,然后启动数据迁移引擎,等待迁移结果就行了。后期如果有机会,还是要做成独立的控制台,有持久化的数据,能灵活配置数据源,能任意启动选中表的同步,能查看当前的任务进度等等。

[请参考]https://blog.junxworks.cn/articles/2021/09/24/1632452885363.html

Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed 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.

简介

用于shardingsphere做部分表全量数据迁移(非增量) 展开 收起
Java
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
Java
1
https://gitee.com/supermain/junx-shardingsphere-datamigrate.git
git@gitee.com:supermain/junx-shardingsphere-datamigrate.git
supermain
junx-shardingsphere-datamigrate
junx-shardingsphere-datamigrate
master

搜索帮助

344bd9b3 5694891 D2dac590 5694891