安装必要的库
本次教程将指导您完成MySQL数据库的迁移操作。除了核心的db-migrate工具,我们还需要安装MySQL数据库驱动。请在您的命令行终端中,依次运行以下两条npm安装命令:
npm install -g db-migrate
npm install db-migrate-mysql
编写配置文件
接下来,您需要在项目根目录下找到或新建一个`configs`文件夹。在该文件夹内,创建一个名为`database_migrate.json`的配置文件。此文件的核心作用是配置数据库连接信息,确保迁移工具能够正确访问您的MySQL实例。
配置文件的具体内容范例如下所示。请务必将示例中的占位符替换为您实际的数据连接参数:
{
"dev": {
"host": "localhost",
"user": "your username",
"password" :"your password" ,
"database": "your db",
"driver": "mysql",
"multipleStatements": true
}
}
生成SQL迁移文件
完成环境配置后,即可开始创建具体的数据库迁移任务。通过执行以下命令,db-migrate将为您生成一个包含升级和回滚脚本的迁移文件模板:
db-migrate create add-department --config configs/database_migrate.json --sql-file
(提示:命令中的`add-department`仅为示例,您可以根据实际变更内容将其修改为更具描述性的名称,例如`add-user-email`或`create-orders-table`。)
命令成功执行后,您的项目目录中将自动生成结构清晰的迁移文件,如下图所示:

编写迁移与回滚SQL
现在,请打开生成的以`up.sql`结尾的文件。您需要在此文件中编写具体的数据库升级SQL语句。例如,若您计划在`departments`表的`leader`字段之后新增一个`mobile`字段,可以写入如下ALTER TABLE语句:
alter table departments add column mobile VARCHAR(32) after leader;
同时,为了确保数据变更的可逆性,您必须在对应的`down.sql`文件中编写回滚SQL。回滚操作应能安全地撤销`up.sql`中所做的变更,例如删除上述新增的字段。这一步是数据库版本管理安全性的重要保障。
执行数据库迁移
SQL脚本准备完毕后,即可运行迁移命令。执行以下指令,db-migrate将读取`up.sql`文件中的内容,并将其应用到配置的MySQL数据库中:
db-migrate up --config configs/database_migrate.json
执行回滚(如果需要)
如果在迁移后发现任何问题,您可以使用回滚命令快速将数据库恢复到执行本次迁移之前的状态。执行以下命令即可完成回滚操作:
db-migrate down --config configs/database_migrate.json
关键注意点
这里有一个在数据库迁移实践中常见的注意事项。有时,在执行完一次迁移后,如果您又通过旧的SQL备份文件覆盖了数据库,会导致数据库状态回退。此时再次运行迁移命令,工具可能会提示“没有可迁移的任务”。
产生此问题的原因在于,`db-migrate`在首次执行迁移时,会在您的数据库中自动创建一个名为`migrations`的系统表。此表用于跟踪记录所有已成功执行的迁移脚本。若需重新执行某个已被记录过的脚本,您需要手动在此表中删除对应的记录条目。
反之,如果您希望跳过某个迁移文件不执行,只需手动将该迁移的记录添加到`migrations`表中即可。这个`migrations`表实质上充当了整个数据库迁移流程的“状态控制器”与“进度管理器”。
参考资料
如需深入了解db-migrate的高级功能、配置选项及最佳实践,我们强烈建议您查阅其官方文档,这是获取最权威、最详尽信息的最佳途径:
https://db-migrate.readthedocs.io/en/latest/Getting%20Started/usage/
