跳到主要内容

心智模型

本指南提供了使用 Prisma Migrate 处理关系数据库时数据库迁移的概念性概述。 它涵盖了：什么是数据库迁移、它们的价值以及 Prisma Migrate 是什么，以及如何在不同的环境中使用 Prisma Migrate 演变您的数据库模式。

如果您正在使用 MongoDB，请使用 prisma db push 来演变您的模式。

什么是数据库迁移？​

数据库迁移是一组受控的更改，它们修改和演变您的数据库模式的结构。 迁移帮助您将数据库模式从一种状态过渡到另一种状态。 例如，在迁移中，您可以创建或删除表和列、拆分表中的字段，或者向数据库添加类型和约束。

演变数据库模式的模式​

本节介绍了演变数据库模式的常规模式迁移模式。

两种主要的模式迁移模式是

  • 模型/实体优先迁移： 使用这种模式，您使用代码定义数据库模式的结构，然后使用迁移工具生成 SQL，例如，用于同步您的应用程序和数据库模式。

Model-first migration flow

  • 数据库优先迁移： 使用这种模式，您定义数据库的结构，并使用 SQL 将其应用于数据库。 然后，您内省数据库以生成描述数据库结构的代码，以同步您的应用程序和数据库模式。

Database-first migration flow

信息

注意

为了简单起见，我们选择了上述术语来描述演变数据库模式的不同模式。 其他工具和库可能会使用不同的术语来描述不同的模式。

迁移文件 (SQL) 最好与您的应用程序代码一起存储。 它们也应该在版本控制中进行跟踪，并与应用程序的其他团队成员共享。

迁移提供状态管理，这有助于您跟踪数据库的状态。

迁移还允许您复制数据库在特定时间点的状态，这在与团队的其他成员协作时很有用，例如在不同分支之间切换。

有关数据库迁移的更多信息，请参阅 Prisma 数据指南。

什么是 Prisma Migrate？​

Prisma Migrate 是一种数据库迁移工具，它支持模型/实体优先迁移模式，用于管理本地环境和生产环境中的数据库模式。

在您的项目中使用 Prisma Migrate 的工作流程将是迭代的，如下所示

本地开发环境（功能分支）

  1. 演变您的 Prisma 模式
  2. 使用 prisma migrate dev 或 prisma db push 将您的 Prisma 模式与本地开发数据库的数据库模式同步

预览/暂存环境（功能拉取请求）

  1. 将您的更改推送到功能拉取请求
  2. 使用 CI 系统（例如 GitHub Actions）使用 prisma migrate deploy 将您的 Prisma 模式和迁移历史与您的预览数据库同步

生产环境（主分支）

  1. 将您的应用程序代码从功能分支合并到您的主分支
  2. 使用 CI 系统（例如 GitHub Actions）使用 prisma migrate deploy 将您的 Prisma 模式和迁移历史与您的生产数据库同步

Prisma Migrate workflow

Prisma Migrate 如何跟踪迁移状态​

Prisma Migrate 使用以下状态信息来跟踪您的数据库模式的状态

  • Prisma 模式：定义数据库模式结构的您的事实来源。
  • 迁移历史：prisma/migrations 文件夹中的 SQL 文件，表示对数据库模式所做更改的历史记录。
  • 迁移表：数据库中的 prisma_migrations 表，用于存储已应用于数据库的迁移的元数据。
  • 数据库模式：数据库的状态。

Prisma Migrate "state management"

使用 Prisma Migrate 时的要求​

  • 理想情况下，您应该为每个环境使用一个数据库。 例如，您可能为开发、预览和生产环境使用单独的数据库。
  • 您在开发环境中使用的数据库是一次性的 — 您可以根据需要轻松地创建、使用和删除数据库。
  • 每个环境中使用的数据库配置应保持一致。 这对于确保跨工作流程移动的特定迁移对数据库产生相同的更改非常重要。
  • Prisma 模式充当事实来源 — 描述您的 数据库模式的形状。

使用 Prisma Migrate 演变您的数据库模式​

本节介绍如何使用 Prisma Migrate 在不同的环境（开发、暂存和生产）中演变您的数据库模式。

开发环境中的 Prisma Migrate（本地）​

使用 prisma migrate dev 跟踪您的迁移历史​

prisma migrate dev 命令允许您跟踪您对数据库所做的更改。 prisma migrate dev 命令会自动生成 SQL 迁移文件（保存在 /prisma/migrations 中）并将其应用于数据库。 当迁移应用于数据库时，数据库中的迁移表 (_prisma_migrations) 也会更新。

Prisma Migrate dev flow

prisma migrate dev 命令使用以下状态信息来跟踪数据库的状态

  • Prisma 模式
  • 迁移历史
  • 迁移表
  • 数据库模式

注意：用于跟踪迁移状态的状态信息与 Prisma Migrate 如何跟踪迁移状态 部分中描述的相同。

您可以使用 --create-only 标志在将迁移应用于数据库之前对其进行自定义。 例如，如果您想重命名列而不造成任何数据丢失，或者加载数据库扩展（在 PostgreSQL 中）和数据库视图（当前不支持），您可能需要编辑迁移。

在幕后，Prisma Migrate 使用 影子数据库 来检测 模式漂移 并生成新的迁移。

注意：prisma migrate dev 仅用于使用一次性数据库的开发环境。

如果 prisma migrate dev 检测到模式漂移或迁移历史冲突，系统会提示您重置（删除并重新创建数据库）数据库以同步迁移历史和数据库模式。

展开以查看使用卡通解释的影子数据库

A cartoon that shows how the shadow database works.

解决模式漂移​

当预期的数据库模式与迁移历史中的模式不同时，就会发生模式漂移。 例如，当您手动更新数据库模式而未相应地更新 Prisma 模式和 prisma/migrations 时，可能会发生这种情况。

对于此类实例，您可以使用 prisma migrate diff 命令来比较您的迁移历史并恢复对数据库模式所做的更改。

Revert database schema with migrate diff

您可以使用 migrate diff 生成以下 SQL

  • 恢复在数据库模式中所做的更改，使其与当前的 Prisma 模式同步
  • 将您的数据库模式向前移动，以应用 Prisma 模式和 /migrations 中缺失的更改

然后，您可以使用 prisma db execute 命令将更改应用于数据库。

原型化您的模式​

prisma db push 命令允许您同步 Prisma 模式和数据库模式，而无需持久化迁移 (/prisma/migrations)。 prisma db push 命令使用以下状态信息来跟踪数据库状态

  • Prisma 模式
  • 数据库模式

prisma db push development flow

prisma db push 命令在以下情况下很有用：

  • 您希望在本地快速原型化和迭代模式设计，而无需将这些更改部署到其他环境，例如其他开发人员、或暂存和生产环境。
  • 您优先考虑达到期望的最终状态，而不是达到该最终状态所执行的更改或步骤（无法预览 prisma db push 所做的更改）。
  • 您不需要控制模式更改如何影响数据。无法编排模式和数据迁移 - 如果 prisma db push 预计更改将导致数据丢失，您可以使用 --accept-data-loss 选项接受数据丢失或停止该过程 - 无法自定义更改。

如果 prisma db push 命令检测到对数据库模式的破坏性更改，它会提示您重置数据库。例如，当您在现有内容的表中添加必需字段而未提供默认值时，就会发生这种情况。

模式漂移发生在数据库模式与迁移历史记录和迁移表不同步时。

在暂存和生产环境中使用 Prisma Migrate​

同步您的迁移历史记录​

prisma migrate deploy 命令允许您将开发环境中的迁移历史记录与暂存或生产环境中的数据库同步。

在底层，migrate deploy 命令会：

  1. 比较已应用的迁移（捕获的 _prisma_migrations）和迁移历史记录 (/prisma/migrations)
  2. 应用待处理的迁移
  3. 使用新迁移更新 _prisma_migrations 表

Workflow of Prisma Migrate

该命令应在自动化的 CI/CD 环境中运行，例如 GitHub Actions。

如果您没有迁移历史记录 (/migrations)，即使用 prisma db push，则必须继续在暂存和生产环境中使用 prisma db push。请注意应用于数据库模式的更改，因为其中一些更改可能是破坏性的。例如，prisma db push 无法分辨您何时执行列重命名。它会提示数据库重置（删除和重新创建）。