erikbra/grate

grate 数据库变更管理系统

概述

grate 是一个自动化数据库部署（变更管理）系统，旨在通过普通的 .sql 脚本实现数据库变更管理，同时提供更多高级功能。它不依赖特定编程语言（如 C#）编写迁移，而是支持灵活的脚本部署方式——无论是开发时与新功能代码一同编写的脚本，还是通过 SSDT/RedGate 等工具生成的差异脚本，均可适用。grate 支持多种主流数据库系统，包括 Microsoft SQL Server、MariaDB/MySQL、PostgreSQL 和 Sqlite。

核心功能与特性

低维护成本的迁移管理

grate 专注于解决数据库迁移的维护复杂性和部署便利性。它采用 SQL 脚本作为核心变更单元，同时针对不同类型对象优化处理逻辑：对于函数、视图、存储过程和权限等需要频繁更新的对象，grate 支持在检测到变更时自动重新应用相关脚本，避免将所有变更集中到一次性的 update 脚本中，从而降低长期维护成本。

灵活的数据库版本控制

grate 主张数据库版本应与代码库版本保持一致，支持在运行时通过参数传递版本号实现版本关联。这使得数据库状态可直接追溯至源代码控制历史中的特定时间点，实现应用代码与数据库状态的精确同步，便于问题定位和版本回滚。

充分利用数据库原生功能

grate 鼓励充分发挥数据库管理系统（DBMS）的原生能力，支持使用表值参数（高效数据处理）、数据压缩（空间优化）、高级索引、复制和细粒度权限管理等 DBMS 特性。相比基于代码的数据库脚手架工具，直接使用 SQL 脚本可更直接地利用数据库系统功能。

适用场景与范围

grate 适用于需要高效管理数据库变更的开发团队，尤其适合以下场景：

• 多数据库环境：支持 Microsoft SQL Server、MariaDB/MySQL、PostgreSQL 和 Sqlite，满足异构数据库架构需求。
• 多样化脚本来源：兼容开发时手动编写的脚本或通过专业工具生成的差异脚本，适应不同团队工作流。
• 版本一致性要求：需将数据库版本与应用代码版本强关联，实现源代码控制中特定提交点的数据库与代码状态同步。

使用方法概述

基本工作流程

1. 脚本组织：将数据库变更脚本（.sql）存放于指定目录，可包含架构定义、数据初始化、服务器配置等内容。
2. 配置连接：指定目标数据库类型及连接信息（如连接字符串）。
3. 版本指定：运行时传递版本号（建议与代码库版本一致）。
4. 执行部署：grate 自动检测脚本变更并应用至目标数据库，同时记录版本元数据。

关键配置参数

grate 支持通过命令行参数或配置文件设置核心参数，主要包括：

• --connection-string：目标数据库连接字符串
• --database-type：数据库类型（可选值：sqlserver、mysql、postgresql、sqlite）
• --version：数据库版本号（需与代码库版本对应）
• --scripts-directory：SQL 脚本存放目录路径

详细配置说明及高级用法请参考 https://erikbra.github.io/grate/%E3%80%82