MySQL-Schema-Sync 安装与使用指南
1. 项目的目录结构及介绍
当你克隆或下载了MySQL-Schema-Sync的代码仓库后,主要目录结构大致如下:
├── bin # 编译后的可执行文件存放目录
│ └── mysql-schema-sync # 主工具二进制文件
├── cmd # 命令行入口文件
│ └── sync # 同步工具的命令行入口逻辑定义
├── internal # 内部使用的各种模块和函数
│ ├── cfg # 配置相关逻辑处理
│ ├── compare # 模式比较逻辑
│ ├── db # 数据库操作相关的封装
│ └── diff # 差异计算和展示
├── scripts # 自带的一些辅助脚本
│ └── check.sh # 示例批量同步脚本
└── config.json.example # 配置文件模板
目录解析
bin
: 编译好的MySQL-Schema-Sync工具。cmd/sync
: Go语言编写的命令行接口入口。internal
: 项目内部核心逻辑,包括配置解析、数据库对比、数据库连接等功能。scripts/check.sh
: 示例脚本,用于循环执行多个配置文件中的同步指令。config.json.example
: 提供的配置文件示例。
2. 项目启动文件介绍
MySQL-Schema-Sync 的主要启动文件是位于bin
目录下的mysql-schema-sync
。此文件是根据项目源码编译生成的二进制执行文件,通过它你可以初始化同步过程或查看可选参数的帮助。
调用方法举例:
./mysql-schema-sync -help
这将显示工具的所有选项及其描述,帮助你理解如何正确配置和运行同步作业。
3. 项目的配置文件介绍
配置文件采用JSON格式,它的样例如下所示:
{
"source": "user:pass@(databaseIP:port)/dbname",
"dest": "user:pass@(destinationIP:port)/dbname",
"tables": ["table_name", "prefix*"],
"alter_ignore": [
{
"table_name": [
{"column": ["col_to_ignore", "col*"]},
{"index": ["idx_to_ignore"]}
]
}
],
"tables_ignore": ["ignoreme"],
"email": {
"send_mail": false,
"smtp_host": "smtp.example.com:port",
"from": "your-email@example.com",
"password": "secretpassword",
"to": "receiver@example.com"
},
...
}
配置键解析
"source"
和"dest"
: 指定源数据库和目标数据库的连接字符串。"tables"
: 列出要同步的特定表名,或使用通配符表示一组表。"alter_ignore"
: 忽略某些列或索引的更改,在同步时不会影响这些元素。"tables_ignore"
: 设置哪些表在同步时不被考虑。"email"
: 发送同步状态报告的电子邮件设置。
配置文件是整个流程的核心组成部分,你需要根据具体的需求调整上述各个配置项。