在你家公司使用 Django Migrate

Django 自带一个成熟的 ORM,提供了数据库结构迁移的功能。通过两个命令可以很方便地执行表结构更新:

  1. python manage.py makemigrations 生成迁移的 Python 脚本;
  2. python manage.py migrate 将脚本转换成 SQL 来执行,并在数据库保存已经执行过的 migrations;

但是这种方便的方法在大公司基本上都没办法直接使用,因为一般是不允许直接让你从笔记本去使用具有 ALTER 权限的数据库用户连接数据库的。有些公司是有在线的平台,只能通过平台提交数据库变更,有些是只能 DBA 来执行数据库变更。

在这种情况下我们就无法使用 Django 自带的 migrations 的功能了。那么有哪些可选的替代方案呢?

第一种是自己手写 SQL 建表,来对应代码的结构声明。之前公司在 Java 中的方案就是这种,有很多弊端。ORM 很多时候都有 length 之类的定义,这种手动对应很容易让两边不同步,没有那边是 source of the truth. 不过好像大家的忍受能力比较高,比较喜欢这种手工工作。

第二种是直接使用声明式编程。意思就是你只要声明你需要什么 table 就可以了。其实 Django 的方案就可以认为是一种声明式的。不过“声明式数据迁移”的本质是语言无关的,你写两张 create table,这个工具就可以产生从 table 1 迁移到 table 2 的 alter SQL. 不过我只听说过,没有见过落地的这种工具。

退一步,有 1st1 的公司 EdgeDBPrisma 实现了一种通过 DSL 来完成的声明式,思想和 Django 是差不多的,声明式的数据库结构迁移。

第三种,就是只适用于 Django 的方案。Django 自带了一个命令,sqlmigrate, 可以从 migrations 的文件生成 SQL 语句。

但是,还有一个问题是怎么知道哪些 migrations 执行过了,哪些没有执行过。

在原生的 Django 方案中,这个问题是通过在数据库的一张表存储 migration 的文件名来解决的。

我们也可以通过命令查询。

在每次进行 python manage.py migrate 命令的时候,Django 就去查询数据哪些 migrations 是已经完成了的,然后只执行没有执行的。

由于无法直接连接生产环境的数据库,我们就需要其他的方法来找到没有执行的 migrations.

这里我使用的方法是通过代码来记录:

  1. 部署的时候,通过和上一次代码的 diff, 就可以找到新生成的 migrations, 执行这些 migrations;
  2. 每次部署代码,都执行所有没有执行过的 migrations;

这样,migrations 代码就可以作为 source of the truth.

步骤如下:

  1. 先通过 git 命令找出改动的 migrations 文件;
  2. 处理文件名,解析成 app migration 的格式;
  3. 通过 sqlmigrate 命令生成 SQL,以及回滚的 SQL;
  4. 得到 SQL 执行文件,去执行。

这个流程应该在多数的公司都可以行得通了。

使用 Makefile 可以写成以下的脚本:

执行的效果:

生成的数据库文件如下:

几点要注意的事情:

  1. 以前我习惯通过 migrations 来做数据迁移,但是现在这种形式显然是无法为数据迁移生成 SQL 的。所以数据迁移只能通过 SQL 来做了。不过问题也不大,我写 SQL 的功力已经提高了,大部分的逻辑都可以通过 SQL 写出来;
  2. 注意 database constrains 的问题。Django 要有办法为 contrains 命名,所以原则上要提供一个数据连接让 Django 知道现在有哪些 contrains 存在了。我们是禁用了外键约束的,如果你用的话,要注意名字的重复问题。

This requires an active database connection, which it will use to resolve constraint names; this means you must generate the SQL against a copy of the database you wish to later apply it on.

doc

 

好了,到此为止,就可以愉快地使用 Django 了。

在你家公司使用 Django Migrate”已经有2条评论

  1. 有外键的话migration之间的依赖关系也要注意,最好的办法可能还是用一个有权限的测试数据库来记录migrations

Leave a comment

邮箱地址不会被公开。 必填项已用*标注