Db Migration Helper

wu529778790/shenzjd-skills/db-migration-helper

作者 wu52977879091d81223806690723b86b0cc06dc65a29568c1ad无许可证收录于 2026年10月9日更新于 2026年10月9日

Use when generating database migration SQL from model or schema changes — compares current vs desired schema, detects diffs, outputs reversible safe migrations.

AI 生成的概览

通过对比模型定义与当前数据库结构,生成可回滚的数据库迁移 SQL。

功能
对比代码中的实体或模型定义与当前数据库结构,检测新增表、增删列、修改类型等结构变更。随后生成正向迁移 SQL、回滚脚本和风险评估,并使用内置的 SQL 模板。支持 MySQL、PostgreSQL 和 SQLite,可识别常见 ORM 与迁移框架。
适用场景
当模型或实体定义发生变化、需要迁移 SQL 时使用,也适用于用户要求创建迁移或同步结构的情况。不适用于仅查看数据库结构、数据迁移、种子数据、备份恢复,或使用 ORM 自动迁移的项目。
运行要求
仅包含说明,不附带脚本。依赖代理读取项目文件的能力,并可能引用 npx prisma db pull、grep 等命令,因此需要 Node.js 或 shell 环境以及对项目结构文件的访问权限。

DB Migration Helper

分析 model 变更,生成安全的数据库迁移 SQL。

Overview

对比代码中的实体/模型定义与当前数据库 schema,检测结构变更(新增表、增删列、改类型),生成向前兼容的迁移 SQL。支持 MySQL、PostgreSQL、SQLite。

When to Use

  • User wants to create database migrations
  • User modified model/entity definitions
  • User mentions migration, schema change, or sync
  • User says "生成迁移" / "create migration"
  • User inputs /db-migration-helper

When NOT to Use:

  • User only wants to view database structure
  • User wants data migration (not schema)
  • User uses ORM auto-migration
  • User wants to generate seed data
  • User wants to backup/restore database

Core Pattern

Step 1: 检测项目类型和 ORM

检测文件ORM/框架迁移方式
prisma/schema.prismaPrisma生成 SQL diff
alembic/SQLAlchemy + Alembic生成 Alembic migration
migrations/通用扫描已有迁移推断
*.entity.ts / *.model.tsTypeORM / Sequelize从装饰器提取
schema.rb / db/migrate/RailsRails migration

Step 2: 提取当前 Schema

bash
# Prisma (v2.18+,旧命令 introspect 已更名为 db pull,统一用 db pull)npx prisma db pull 2>/dev/null
# 通用 — 从代码提取grep -r "CREATE TABLE\|@Entity\|@Table\|model " --include="*.ts" --include="*.py" --include="*.go" -l

提取:

  • 表名和列定义
  • 列类型、约束(NOT NULL、DEFAULT、UNIQUE)
  • 索引和外键

Step 3: 对比变更

对比代码中的 model 定义与已有 schema(或上一次迁移),检测:

变更类型风险等级说明
新增表低直接 CREATE TABLE
新增列(有 DEFAULT)低ALTER TABLE ADD COLUMN
新增列(无 DEFAULT)中需要处理已有数据
删除列高可能丢失数据,需要确认
修改列类型高可能不兼容
新增索引低CREATE INDEX
删除索引低DROP INDEX

Step 4: 生成迁移文件

使用 templates/migration.sql 模板,生成:

  1. Up 迁移 — 正向变更 SQL
  2. Down 回滚 — 反向回滚 SQL
  3. 风险评估 — 标注高风险操作
sql
-- Migration: 20260603_add_user_avatar-- Risk: LOW
-- UpALTER TABLE users ADD COLUMN avatar_url VARCHAR(500);CREATE INDEX idx_users_email ON users(email);
-- DownDROP INDEX idx_users_email;ALTER TABLE users DROP COLUMN avatar_url;

Quick Reference

bash
/db-migration-helper                    # 检测变更,生成迁移/db-migration-helper --dry-run          # 只预览 SQL 不执行/db-migration-helper --name add_user    # 指定迁移名称
参数说明默认值
--dry-run只预览不执行false
--name迁移文件名自动生成
--output输出目录./migrations/

Common Mistakes

错误正确做法原因
不生成 down 回滚始终生成回滚 SQL出问题需要回退
删除列不备份先备份数据再删列数据丢失不可恢复
改类型用 ALTER COLUMNPostgreSQL 可直接 ALTER COLUMN ... TYPE ... USING;MySQL 用 新建列 → 迁移数据 → 删旧列MySQL 直接改类型可能丢数据,PG 的 USING 是原子转换
不加索引为查询字段加索引影响查询性能
迁移文件没有名字用描述性命名方便团队协作和回溯
不检查外键依赖先检查表间关系删除被引用的列会失败

来源与署名

来源:wu529778790/shenzjd-skills位于db-migration-helper提交91d8122

许可证: 无许可证

内容归原作者所有。SourceWeft 从公开仓库中收录这些内容。

举报或申请下架