convex-migrate 是一个用于在已部署的 Convex 应用上执行 schema 与数据迁移的技能,来源于 convex/agent-skills。它的用途是在线变更数据库结构而不破坏现有数据。
用途
该技能针对“在运行中的应用上迁移 schema / 数据”这一场景。直接修改已部署 schema 可能因为已有数据不符合新校验规则而导致部署失败或线上应用出错,convex-migrate 提供的是一套分阶段的迁移流程来规避这类问题。
主要能力
根据资料,其能力围绕 schema 变更与数据回填展开:先把新字段设为可选,使部署不会拒绝已有行;安装 @convex-dev/migrations 并编写 migration,对已有行进行回填或转换;运行该 migration,并验证所有行有效;最后在回填完成后收紧校验器,把字段改为必填。
使用方式
资料给出的工作流为:
- 先让新字段成为可选字段,这样部署时不会拒绝已有数据行。
- 安装 @convex-dev/migrations,并编写一个对已有行进行回填/转换的 migration。
- 运行 migration,验证所有行都有效。
- 在回填完成后收紧校验器,把该字段设为必填。
规则
资料明确列出以下约束:
- 在回填完成之前,绝不能收紧校验器——这会拒绝已有行并破坏线上应用。
- 新增字段先设为可选,迁移后再设为必填。
- 在迁移前后核对行数。
适用场景
适用于需要对已部署的 Convex 应用进行 schema 变更、并需要为历史数据补齐或转换字段的场景。
限制
资料仅提供上述流程与规则,未提供具体安装命令、代码示例、价格、平台支持范围或效果保证等信息,这些内容暂未提供。