Diesel Migrations：如何用单个up.sql实现表创建与后续列添加？

Diesel 并不强制要求必须为表创建和列添加操作分别创建独立迁移，但官方更推荐增量式迁移来保证迁移历史的可追溯性。以下是针对你的需求的具体方案和建议：

方案1：单文件条件式迁移（适合小型项目/快速迭代） #

你可以在单个up.sql文件中结合IF NOT EXISTS语法，同时处理表创建和后续列添加操作，确保重复执行迁移不会报错。

以PostgreSQL为例，up.sql内容示例：

-- 创建表（仅当表不存在时）
CREATE TABLE IF NOT EXISTS users (
    id SERIAL PRIMARY KEY,
    username VARCHAR(50) NOT NULL UNIQUE
);

-- 批量添加新列（仅当列不存在时）
ALTER TABLE users ADD COLUMN IF NOT EXISTS email VARCHAR(100);
ALTER TABLE users ADD COLUMN IF NOT EXISTS created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP;

对应的down.sql（用于回滚）：

-- 删除新增列（仅当列存在时）
ALTER TABLE users DROP COLUMN IF EXISTS created_at;
ALTER TABLE users DROP COLUMN IF EXISTS email;

-- 可选：如果需要回滚表创建，可添加下方语句（谨慎使用，避免误删数据）
-- DROP TABLE IF EXISTS users;

优缺点：

• 优点：单文件管理简单，无需频繁创建新迁移文件。
• 缺点：迁移历史模糊，后期排查结构变更问题难度大；复杂结构变更（如索引、约束）的条件判断语法兼容性差。

方案2：官方推荐的增量式迁移（适合生产环境/长期维护） #

虽然需要为每个变更创建独立迁移文件，但Diesel提供了便捷的工具链（diesel migration generate）来简化流程，且能保证迁移历史清晰、回滚可靠。

操作步骤：

1. 生成新迁移文件：

   diesel migration generate add_email_created_at_to_users
   

2. 在生成的up.sql中写入列添加语句：

   ALTER TABLE users ADD COLUMN email VARCHAR(100);
   ALTER TABLE users ADD COLUMN created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP;
   

3. 在down.sql中写入回滚语句：

   ALTER TABLE users DROP COLUMN created_at;
   ALTER TABLE users DROP COLUMN email;
   

4. 运行迁移：

   diesel migration run
   

自动化简化列添加流程 #

如果你需要频繁添加列，可编写简单脚本自动生成迁移文件，实现“指定列即可完成添加”的需求。以下是一个bash脚本示例：

#!/bin/bash

# 从配置文件读取表名和列信息（示例配置文件add_cols.conf）
# 配置内容格式：TABLE=users;COLUMNS=email VARCHAR(100), created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP
CONFIG=$(cat add_cols.conf)
TABLE=$(echo $CONFIG | cut -d';' -f1 | cut -d'=' -f2)
COLUMNS=$(echo $CONFIG | cut -d';' -f2 | cut -d'=' -f2)

# 生成迁移文件
TIMESTAMP=$(date +%Y%m%d%H%M%S)
MIGRATION_NAME="add_cols_to_${TABLE}"
diesel migration generate ${MIGRATION_NAME}

# 写入up.sql
UP_FILE="migrations/${TIMESTAMP}_${MIGRATION_NAME}/up.sql"
echo "$(echo $COLUMNS | sed 's/,/; ALTER TABLE '$TABLE' ADD COLUMN IF NOT EXISTS /g' | xargs -I {} echo "ALTER TABLE $TABLE ADD COLUMN IF NOT EXISTS {};")" > $UP_FILE

# 写入down.sql
DOWN_FILE="migrations/${TIMESTAMP}_${MIGRATION_NAME}/down.sql"
echo "$(echo $COLUMNS | cut -d' ' -f1 | sed 's/,/; ALTER TABLE '$TABLE' DROP COLUMN IF NOT EXISTS /g' | xargs -I {} echo "ALTER TABLE $TABLE DROP COLUMN IF NOT EXISTS {};")" > $DOWN_FILE

# 执行迁移
diesel migration run

使用时只需修改add_cols.conf中的表名和列信息，运行脚本即可自动完成迁移。

最佳实践总结 #

• 小型项目/原型：可采用单文件条件迁移，快速迭代但需注意数据库语法兼容性。
• 生产环境：严格使用增量式迁移，每个结构变更对应独立迁移文件，便于追溯和回滚。
• 自动化辅助：通过脚本减少重复操作，但需保证生成的迁移文件语法正确，避免自动化导致的混乱。
• 测试先行：迁移前务必在本地测试环境验证up和down操作，确保不会破坏数据。

内容的提问来源于stack exchange，提问作者John Philip