跳过至主要内容

关于迁移历史

本页解释了 Prisma ORM 如何使用迁移历史记录来跟踪对您的模式的更改。

迁移历史记录

您的迁移历史记录是您数据模型更改的故事,由以下内容表示

  • 一个 prisma/migrations 文件夹,其中包含每个迁移的子文件夹和 migration.sql 文件

    migrations/
    └─ 20210313140442_init/
    └─ migration.sql
    └─ 20210313140442_added_job_title/
    └─ migration.sql

    migrations 文件夹是您数据模型历史记录的真实来源

  • 数据库中的 _prisma_migrations 表,用于检查

    • 是否针对数据库运行了迁移
    • 是否删除了应用的迁移
    • 是否更改了应用的迁移

    如果您更改或删除迁移(推荐),下一步取决于您是在 开发环境(因此使用 migrate dev)还是在 生产/测试环境(因此使用 migrate deploy)。

不要编辑或删除已应用的迁移

一般来说,您不应该编辑或删除已应用的迁移。这样做会导致开发环境和生产环境迁移历史记录之间出现不一致,这可能会产生无法预料的后果——即使更改在最初似乎没有破坏任何内容。

以下场景模拟了导致看似无害的不一致的更改

  1. 通过将 VARCHAR(550) 的值更改为 VARCHAR(560) 来修改已在开发环境中已应用现有迁移

    ./prisma/migrations/20210310143435_default_value/migrations.sql
      -- AlterTable
    ALTER TABLE "Post" ALTER COLUMN "content" SET DATA TYPE VARCHAR(560);

    进行此更改后,迁移历史记录的最终状态不再与 Prisma 模式匹配,该模式仍然具有 @db.VarChar(550)

  2. 运行 prisma migrate dev - Prisma Migrate 检测到迁移已更改,并要求重置数据库

    ? The migration `20210310143435_change_type` was modified after it was applied.

    We need to reset the PostgreSQL database "migrate-example" at "localhost:5432".
    Do you want to continue? All data will be lost. » (y/N)
  3. 如果您接受重置,Prisma Migrate 将重置数据库并重新运行所有迁移,包括您编辑的迁移。

  4. 应用所有现有迁移后,Prisma Migrate 将迁移历史记录的最终状态与 Prisma 模式进行比较,并检测到差异

    • Prisma 模式具有 @db.VarChar(550)
    • 数据库模式具有 VARCHAR(560)
  5. Prisma Migrate 生成一个新的迁移来将值更改回 550,因为迁移历史记录的最终状态应与 Prisma 模式匹配。

  6. 从现在开始,当您使用 prisma migrate deploy 将迁移部署到生产和测试环境时,Prisma Migrate 将始终警告您迁移历史记录不匹配(并且每次运行命令时都会继续警告您)——即使模式最终状态匹配

    6 migrations found in prisma/migrations
    WARNING The following migrations have been modified since they were applied:
    20210310143435_change_type

migrate reset 之后,看似没有破坏任何内容的更改可能会隐藏问题——您最终可能会在生产中遇到无法在开发中复制的错误,反之亦然——特别是如果更改涉及高度自定义的迁移。

如果 Prisma Migrate 报告已应用的迁移丢失或已编辑,我们建议修复根本原因(还原文件或撤消更改),而不是重置。

将迁移历史记录提交到源代码控制

您必须将整个 prisma/migrations 文件夹提交到源代码控制。这包括 prisma/migrations/migration_lock.toml 文件,该文件用于检测您是否尝试更改提供商

schema.prisma 文件进行源代码控制是不够的——您必须包含您的迁移历史记录。这是因为

  • 当您开始自定义迁移时,您的迁移历史记录包含无法在 Prisma 模式中表示的信息。例如,您可以自定义迁移来缓解由重大更改引起的数据丢失。
  • prisma migrate deploy 命令用于将更改部署到暂存、测试和生产环境,它运行迁移文件。它不使用 Prisma 模式来获取模型。