这个工具是什么?
概括
工具名称:mysqlDiff
简单来说,就是一个可以对比两个数据库(如targetDB和sourceDB)的表结构,并生成由targetDB更新至sourceDB的DDL语句的对比工具。
什么是DDL:
DDL是"Data Definition Language"(数据定义语言)的缩写。DDL用于定义数据库的结构,包括表、列、索引等。常见的DDL语句包括:
- CREATE:用于创建数据库、表、视图或其他数据库对象。
- ALTER:用于修改已存在的数据库对象,比如修改表结构、添加列等。
- DROP:用于删除数据库、表或其他数据库对象。
- TRUNCATE:用于清空表的数据,但保留表结构。
- RENAME:用于重命名数据库对象。
应用场景:
在公司中开发软件进行版本迭代时,总会出现一些数据库表结构的变更,如新增表,新增/删除字段,新增/删除索引等,而每个人对表结构的修改要记录到一个统一的平台上供组内开发人员共享。而此时如果凭借记忆来记录DDL语句难免会发生失误,因此一个自动化对比工具就显得比较实用了。
GitHub地址
实现思路及如何使用
mysqlDiff介绍
根据输入的两个url分别连接到两个数据库targetDB和sourceDB。mysqlDIff工具会分析两个数据库并给出由targetDB更新至sourceDB的sql脚本。
区分粒度:字段的类型,comment, 索引的变化。
情况分类
- 若targetDB含有sourceDB中不存在的表,则会给出对应的DROP TABLE语句。
- 若sourceDB含有targetDB中不存在的表,如表student,则会给出表student的建表语句。
- 若sourceDB与targetDB含有若干个名字相同的表,如tables,那么sqlDiff工具将会比较它们每一对相同名称的表之间的差异,并给出由targetDB->sourceDB的表结构更新语句,甚至是索引更新的sql语句。
如何使用
根据您的操作系统下载对应的发行版(以下以linux环境为举例)。 在命令行中切换目录至刚刚下载的发行版对应的目录,使用 sqlDiff_mysqlXXX -h 来查看如何使用(请确保您要链接的的mysql版本与发行版描述的一致)。 执行二进制问文件,SQL脚本将会输出在下方的命令行中。
示例
输入
./sqlDiff_mysql8.0.32 -sourceDB "root:root@tcp(localhost:3306)/db_cs_account1.2.0" -targetDB "root:root@tcp(localhost:3306)/db_cs_account"
输出
#Table changes from database db_cs_account to database db_cs_account1.2.0:
CREATE TABLE tb_test (
id int NOT NULL AUTO_INCREMENT,
name varchar(32) DEFAULT 'zhangsan',
age int NOT NULL,
hobbies json DEFAULT NULL,
PRIMARY KEY (id),
UNIQUE KEY id (id)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_0900_ai_ci;
#The sql statement corresponding to the change of table tb_account :
ALTER TABLE tb_account
ADD COLUMN delete_tm datetime COMMENT '账户删除时间',
ADD COLUMN testColumn varchar(234) NOT NULL,
DROP COLUMN account_name,
MODIFY COLUMN user_id int NOT NULL DEFAULT 34535 COMMENT '宵明用户ID',
MODIFY COLUMN platform_id int NOT NULL DEFAULT 5555 COMMENT '云平台id',
MODIFY COLUMN status json NOT NULL COMMENT '状态',
MODIFY COLUMN insert_tm datetime DEFAULT CURRENT_TIMESTAMP;
#Index update statement for table tb_account:
CREATE UNIQUE INDEX id ON tb_account(id);
CREATE UNIQUE INDEX yhi ON tb_account(platform_id,account_uid);
CREATE UNIQUE INDEX yhido ON tb_account(user_id,platform_id,insert_tm);
CREATE INDEX aka ON tb_account(user_id,id);