Supabase migration 开发实践

这两天在对接 Supabase 的数据库，了解到 Supabase 支持通过 supabase-cli 来使用 migration，因此把官网的相关文档都看了一遍。

但是官方的文档有点乱，一会儿是在 Studio 中创建表、一会儿手工创建 migration，一会儿又通过 diff 来生成，然后还有 supabase/scheams/，晕菜了。

在认真研究并本地测试之后，简单总结一下我的开发实践。

开发环境：

0x01. 安装 supabase-cli 工具

bash 复制代码

brew install supabase/tap/supabase

sql 复制代码

supabase initsupabase start

start 执行完成之后，本地docker会运行一套supabase环境，其中包括一个纯净的supabase db。

创建 migration 文件有两种方式：手工编写和自动生成，推荐使用自动创建migration的方式。

新版本的 supabase-cli 支持声明式定义schema，即在 supabase/scheams/ 目录下，写完整的schema，然后通过 supabase db diff 来创建 migration。

在 supabase db diff 的时候，如果本地存在 supabase/scheams/ 目录，则会和本地目录中定义的 schema 对比，根据差异创建 migration；否则和本地数据库来对比。

使用 supabase/scheams/ 的好处是，对于任意一个给定的 schema，所有的定义都在一个文件中，是一个完整的 schema 定义，一目了然。

三步操作：

创建一个新的 migration 文件，比如创建新表employees:

supabase migration new create_employees_table
执行 diff 获取本地数据库的变更

supabase db diff
把上面命令输出的sql复制到生成的migration文件中

当然，省事点的，可以直接用diff命令把migration创建出来：

复制代码

supabase db diff -f create_employees_table

见上一节。

复制代码

supabase migration up

这里的 project-ref 有两种获取方式：

访问 Supabase 项目，从 URL 中获取，比如项目：https://supabase.com/dashboard/project/ejncwnlcyadphxwcnfac 的 project-id 就是最后的 ejncwnlcyadphxwcnfac。
执行 supabase link，从列表中选择/获取

如果有一些数据需要执行 seed.sql 初始化，可以追加--include-seed 参数，即：

css 复制代码

supabase db push --include-seed

避免直接操作 Supabase 线上环境。

所有数据库的操作，都先在本地环境处理，生成对应的migration；本地测试通过之后，推送到远程。

不论是自己开发，还是团队开发，使用的都是同样的流程：