sqldef快速入门：5个步骤让你的数据库管理变得简单

【免费下载链接】sqldef Idempotent schema management for MySQL, PostgreSQL, SQLite, and SQL Server 项目地址: https://gitcode.com/gh_mirrors/sq/sqldef

sqldef是一款终极的数据库模式管理工具，支持MySQL、PostgreSQL、SQLite和SQL Server，通过纯SQL DDL实现幂等性的数据库结构维护。只需定义期望的SQL模式，sqldef就能自动生成并应用迁移脚本，让数据库管理变得前所未有的简单高效。

为什么选择sqldef？

传统的数据库迁移工具往往需要学习特定的DSL或维护复杂的版本控制文件，而sqldef带来了革命性的改变：

• 纯SQL驱动：直接使用标准SQL定义模式，无需学习新语法
• 幂等操作：多次运行安全无虞，只会应用必要的变更
• 多数据库支持：一套工具满足MySQL、PostgreSQL、SQLite和SQL Server的管理需求
• 离线模式：支持文件间的模式比较，无需数据库连接
• 轻量级部署：单二进制文件，无依赖，轻松集成到CI/CD流程

图1：sqldef命令行操作演示，展示如何快速应用数据库模式变更

步骤1：安装sqldef

根据你的操作系统和数据库类型，选择合适的安装方式：

Linux系统

# 安装mysqldef
wget -O - https://github.com/sqldef/sqldef/releases/latest/download/mysqldef_linux_amd64.tar.gz | tar xvz

# 安装psqldef (PostgreSQL)
wget -O - https://github.com/sqldef/sqldef/releases/latest/download/psqldef_linux_amd64.tar.gz | tar xvz

# 安装sqlite3def
wget -O - https://github.com/sqldef/sqldef/releases/latest/download/sqlite3def_linux_amd64.tar.gz | tar xvz

# 安装mssqldef (SQL Server)
wget -O - https://github.com/sqldef/sqldef/releases/latest/download/mssqldef_linux_amd64.tar.gz | tar xvz

macOS系统

# 安装mysqldef
brew install sqldef/sqldef/mysqldef

# 安装psqldef
brew install sqldef/sqldef/psqldef

# 安装sqlite3def
brew install sqldef/sqldef/sqlite3def

# 安装mssqldef
brew install sqldef/sqldef/mssqldef

提示：所有命令都是单文件可执行程序，下载后直接放到/usr/local/bin目录即可全局使用。

步骤2：导出当前数据库模式

使用--export选项将现有数据库结构导出到SQL文件，作为起点：

# MySQL示例
mysqldef -u root -p password -h localhost -P 3306 dbname --export > schema.sql

# PostgreSQL示例
psqldef -U postgres -h localhost -p 5432 dbname --export > schema.sql

# SQLite示例
sqlite3def db.sqlite3 --export > schema.sql

# SQL Server示例
mssqldef -U sa -P password -h localhost -p 1433 dbname --export > schema.sql

导出的schema.sql文件包含了数据库的完整结构定义，包括表、列、索引和约束等。

步骤3：修改数据库模式

直接编辑schema.sql文件，按照标准SQL语法进行结构变更。例如，添加新列：

CREATE TABLE users (
  id BIGINT PRIMARY KEY,
  name VARCHAR(100) NOT NULL,
  email VARCHAR(255) UNIQUE,
  age INTEGER,  -- 新增列
  created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP
);

技巧：保持schema.sql文件作为数据库的单一真实来源，所有结构变更都在这里进行。

步骤4：预览变更（安全第一）

在应用变更前，使用--dry-run选项预览sqldef将执行的SQL语句：

# MySQL示例
mysqldef -u root -p password -h localhost -P 3306 dbname --dry-run < schema.sql

# PostgreSQL示例
psqldef -U postgres -h localhost -p 5432 dbname --dry-run < schema.sql

这一步至关重要，可以避免意外修改数据库结构。输出将显示所有将要执行的DDL语句，如：

ALTER TABLE users ADD COLUMN age INTEGER;

步骤5：应用变更

确认预览结果无误后，使用--apply选项应用变更：

# MySQL示例
mysqldef -u root -p password -h localhost -P 3306 dbname --apply < schema.sql

# PostgreSQL示例
psqldef -U postgres -h localhost -p 5432 dbname --apply < schema.sql

sqldef会智能比较当前数据库结构与schema.sql的差异，只执行必要的变更。即使多次运行，也不会重复执行相同的操作，确保了幂等性。

高级技巧：重命名表和列

使用-- @renamed from=old_name注解实现安全重命名：

CREATE TABLE users ( -- @renamed from=user_accounts
  id INTEGER PRIMARY KEY,
  username TEXT,
  user_age INTEGER  -- @renamed from=age
);

这将生成重命名语句而非删除重建，保留数据完整性：

ALTER TABLE user_accounts RENAME TO users;
ALTER TABLE users RENAME COLUMN age TO user_age;

离线模式：文件对比

无需数据库连接，直接比较两个SQL文件的差异：

# 比较current.sql和desired.sql
mysqldef current.sql < desired.sql

这在CI/CD流程中特别有用，可以在合并代码前验证模式变更。

实际案例与示例

项目提供了丰富的使用示例，位于example目录：

# 数据库模式示例
./example/run.sh psqldef      # PostgreSQL示例
./example/run.sh mysqldef     # MySQL示例
./example/run.sh sqlite3def   # SQLite示例
./example/run.sh mssqldef     # SQL Server示例

# 离线模式示例
./example/run-offline.sh psqldef  # 离线比较PostgreSQL模式

总结

通过这5个简单步骤，你已经掌握了sqldef的核心使用方法。这款强大的工具将彻底改变你的数据库管理方式，让模式变更变得安全、简单且可重复。无论是小型项目还是大型企业应用，sqldef都能帮助你保持数据库结构的清晰与可控。

开始使用sqldef，体验现代数据库模式管理的便捷与高效！

【免费下载链接】sqldef Idempotent schema management for MySQL, PostgreSQL, SQLite, and SQL Server 项目地址: https://gitcode.com/gh_mirrors/sq/sqldef