theanurin/sqlmigrationbuilder

SQL Migration Builder

镜像概述和主要用途

SQL Migration Builder 是一个基于 Mustache 的 SQL 脚本模板处理器，用于生成和处理 SQL 迁移脚本。它运行在 Alpine Linux 环境中，结合 NodeJS 执行模板处理，支持通过环境变量配置和扩展 Mustache 功能，适用于数据库迁移脚本的自动化生成。

核心功能和特性

环境变量配置

• DIST_PATH: 构建产物路径，相对于 /data，默认值：.dist
• ENV: 目标构建环境名称（如 devel、test、production），默认值：空
• EXTRA_CONFIGS: 额外配置文件的逗号分隔列表，相对于 /data，默认值：空
• SOURCE_PATH: 源文件路径，相对于 /data，默认值：migration
• VERSION_FROM: 起始版本，默认值：空
• VERSION_TO: 目标版本，默认值：空

Mustache 扩展功能

ENV 环境变量的特殊处理

• 渲染上下文会生成格式为 is${大写ENV} 的布尔标志（如 ENV=production 时生成 isProduction: true）
• 自动读取对应环境的配置文件 database-${ENV}.config（如 ENV=test 时读取 database-test.config）

示例：

sql
-- 仅在非生产环境生成 'EMULATOR' 枚举值
CREATE TYPE "public"."SERVICE_KIND" AS ENUM (
{{^isProduction}}
	'EMULATOR',
{{/isProduction}}
	'WEBSOCKET'
);

访问器扩展

• s: 引用属性数组（如 database.schemas 引用所有 schema 条目数组）
• $root: 引用根数据上下文
• $parent: 引用父数据上下文

示例：

sql
-- database.schema.common.name = common
-- database.schema.audit.name  = audit
-- database.user.readonly = "db_ro_user"

{{#database.schemas}}
CREATE SCHEMA "{{ name }}";
COMMENT ON SCHEMA "{{ name }}" IS '{{ desc }}';
-- 引用根上下文
GRANT USAGE ON SCHEMA "{{ name }}" TO "{{$root.database.user.readonly}}";
-- 引用父上下文
GRANT USAGE ON SCHEMA "{{ name }}" TO "{{$parent.user.readonly}}";
{{/database.schemas}}

卷挂载

• /data: 数据库工作目录的根路径，需挂载包含源文件和配置的本地目录

使用场景和适用范围

适用于需要根据不同环境（开发、测试、生产）生成差异化 SQL 迁移脚本的场景，支持通过模板自动化处理数据库模式变更、权限配置等，提高数据库迁移的可维护性和一致性。

使用方法和配置说明

基本运行命令

bash
docker run --interactive --tty --rm --volume /path/to/database/workdir:/data theanurin/sqlmigrationbuilder

自定义环境配置示例

指定生产环境并挂载本地工作目录：

bash
docker run -e ENV=production -v /local/database/workdir:/data theanurin/sqlmigrationbuilder

镜像内部组件

• 基础镜像：Alpine Linux
• 运行时：NodeJS
• 核心脚本：Migration Builder JS Script

支持信息

• 维护者：ZXTeam
• 获取帮助：*** Channel