mkbucc/shmig

SHMIG

镜像概述

SHMIG是一款轻量级数据库迁移工具，采用BASH编写且仅包含单个文件，无复杂依赖，可在大多数POSIX兼容环境中运行。它支持MySQL、SQLite3和PostgreSQL三种主流数据库，专注于实现简单、可靠的数据库schema版本管理与迁移功能。

核心功能

• 多数据库支持：兼容MySQL、SQLite3、PostgreSQL三种数据库类型
• 基础迁移操作：提供创建迁移文件、应用迁移（migrate）、回滚迁移（rollback）等核心功能
• 灵活配置方式：支持配置文件（shmig.conf/shmig.local.conf）、命令行参数和环境变量，优先级为命令行>配置文件>环境变量
• 迁移文件结构：以UNIX时间戳命名，包含UP（应用迁移）和DOWN（回滚迁移）两个关键部分
• 多环境适配：通过符号链接实现开发、测试等多环境的迁移数据隔离

使用场景

• 项目开发中数据库schema的版本控制与变更管理
• 多环境（开发/测试/生产）下的数据库迁移同步
• 轻量级项目或无框架依赖场景的快速数据库迁移
• 跨POSIX兼容系统的数据库迁移需求

配置说明

配置文件

1. 默认配置：项目根目录下的shmig.conf为默认配置文件
2. 本地覆盖：shmig.local.conf可作为非版本控制的本地配置，用于覆盖默认设置
3. 自定义配置：通过-c参数指定自定义配置文件

命令行参数（必填项）

• -t：数据库类型（如mysql、sqlite3、postgres）
• -d：目标数据库名称
• -m：迁移文件所在目录

Docker部署示例

bash
# MySQL数据库迁移示例（需提前启动mariadb容器）
docker run -e PASSWORD=root -e HOST=mariadb -v $(pwd)/migrations:/sql --link mariadb:mariadb mkbucc/shmig:latest -t mysql -d db-name up

迁移文件示例

sql
-- Migration: create users table
-- Created at: 2013-10-02 07:03:11
-- ====  UP  ====
CREATE TABLE `users`(
  id int not null primary key auto_increment,
  name varchar(32) not null,
  email varchar(255) not null
);
CREATE UNIQUE INDEX `users_email_uq` ON `users`(`email`);
-- ==== DOWN ====
DROP TABLE `users`;

注意事项

• 迁移文件需包含-- ==== UP ====和-- ==== DOWN ====标记，否则对应操作会失败
• 数据库密码通过环境变量传递，需确保系统环境的安全性（如禁止其他用户读取进程环境）
• 若需优化执行速度，可考虑减少单次迁移的SQL语句数量或合并操作