跳到主要内容

关于影子数据库

影子数据库是一个临时的第二个数据库，它在您每次运行prisma migrate dev时自动创建和删除，主要用于检测诸如模式漂移或生成的迁移可能导致数据丢失等问题。

migrate diff命令在使用--from-migrations或--to-migrations与本地migrations目录进行差异化比较时，也需要影子数据库。

警告

影子数据库在生产环境中不是必需的，并且不会被面向生产的命令（如prisma migrate resolve和prisma migrate deploy）使用。

注意

由于migrate dev没有在 MongoDB 中使用，因此影子数据库永远不会用于 MongoDB。

影子数据库的工作原理​

当您运行prisma migrate dev来创建新的迁移时，Prisma Migrate 使用影子数据库来

🎨 展开查看用卡通解释的影子数据库。

A cartoon that shows how the shadow database works.

检测模式漂移​

为了在开发过程中检测漂移，Prisma Migrate

  1. 创建影子数据库的新副本（或者如果影子数据库是通过shadowDatabaseUrl配置的，则执行软重置）。
  2. 在影子数据库中重新运行当前已有的迁移历史。
  3. 内省影子数据库以生成 Prisma 模式“当前状态”。
  4. 将当前迁移历史的最终状态与开发数据库进行比较。
  5. 如果当前迁移历史的最终状态（通过影子数据库）与开发数据库不匹配（例如，由于手动更改），则报告模式漂移

如果 Prisma Migrate 没有检测到模式漂移，则它将继续进行生成新的迁移。

注意：影子数据库不负责检查迁移文件是否已被编辑或删除。这是使用_prisma_migrations表中的checksum字段完成的。

如果 Prisma Migrate 检测到模式漂移，它将输出有关数据库中哪些部分发生漂移的详细信息。当开发数据库被手动修改时，可能会显示以下示例输出：Color枚举缺少预期的变体RED，并且包含意外的变体TRANSPARENT

[*] Changed the `Color` enum
  [+] Added variant `TRANSPARENT`
  [-] Removed variant `RED`

生成新的迁移​

假设 Prisma Migrate 没有检测到模式漂移，它将继续从 Prisma 模式更改中生成新的迁移。为了生成新的迁移，Prisma Migrate

  1. 将目标数据库模式计算为当前 Prisma 模式的函数。
  2. 比较现有迁移历史的最终状态和目标模式，并生成从一个状态到另一个状态的步骤。
  3. 将这些步骤呈现为 SQL 字符串，并将其保存在新的迁移文件中。
  4. 评估 SQL 导致的数据丢失并发出警告。
  5. 将生成的迁移应用于开发数据库（假设您没有指定--create-only标志）。
  6. 删除影子数据库（通过shadowDatabaseUrl配置的影子数据库不会被删除，而是在migrate dev命令开始时被重置）。

手动配置影子数据库​

在某些情况下，可能需要（例如，当在云托管数据库上不允许创建和删除数据库时）手动定义应该用作migrate dev的影子数据库的连接字符串和数据库名称。在这种情况下，您可以

  1. 创建一个应该用作影子数据库的专用数据库
  2. 将该数据库的连接字符串添加到您的环境变量SHADOW_DATABASE_URL（或.env文件）中。
  3. 添加一个shadowDatabaseUrl字段来读取此环境变量。
datasource db {
  provider          = "postgresql"
  url               = env("DATABASE_URL")
  shadowDatabaseUrl = env("SHADOW_DATABASE_URL")
}

重要提示：不要为url和shadowDatabaseUrl使用完全相同的，因为这可能会删除您数据库中的所有数据。

云托管的影子数据库必须手动创建​

一些云提供商不允许您使用 SQL 删除和创建数据库。有些需要通过在线界面创建或删除数据库，而有些则真正限制您使用一个数据库。如果您在这种云托管环境中进行开发，则必须

  1. 创建一个专用的云托管影子数据库
  2. 将 URL 添加到您的环境变量SHADOW_DATABASE_URL中。
  3. 添加一个shadowDatabaseUrl字段来读取此环境变量。
datasource db {
  provider          = "postgresql"
  url               = env("DATABASE_URL")
  shadowDatabaseUrl = env("SHADOW_DATABASE_URL")
}

重要提示：不要为url和shadowDatabaseUrl使用相同的。

影子数据库用户权限​

为了在使用migrate dev时创建和删除影子数据库，Prisma Migrate 目前要求在您的datasource中定义的数据库用户拥有创建数据库的权限。

数据库数据库用户需求
SQLite没有特殊要求。
MySQL/MariaDB数据库用户必须具有CREATE, ALTER, DROP, REFERENCES ON *.*权限
PostgreSQL用户必须是超级用户或拥有CREATEDB权限。请参阅CREATE ROLE（PostgreSQL 官方文档）。
Microsoft SQL Server用户必须是站点管理员或拥有SERVER可保护对象。请参阅官方文档。

如果您使用云托管数据库进行开发并且无法使用这些权限，请参阅：云托管影子数据库

注意：例如，在 Azure SQL 上会禁用影子数据库的自动创建。

如果 Prisma Migrate 无法使用您的连接 URL 提供的凭据创建影子数据库，它将抛出以下错误

Error: A migration failed when applied to the shadow database
Database error: Error querying the database: db error: ERROR: permission denied to create database

要解决此错误

  • 如果您是在本地工作，我们建议您更新数据库用户的权限。
  • 如果您正在开发的数据库不允许创建和删除数据库（无论出于何种原因），请参阅手动配置影子数据库
  • 如果您正在开发云托管数据库（例如，在 Heroku、Digital Ocean 或 Vercel Postgres 上），请参阅：云托管影子数据库。
  • 如果您正在开发云托管数据库（例如，在 Heroku、Digital Ocean 或 Vercel Postgres 上）并且当前处于原型设计阶段，因此您不关心生成的迁移文件，只需要将 Prisma 模式应用于数据库模式，您可以运行prisma db push而不是prisma migrate dev命令。

重要提示：影子数据库仅在开发环境中（特别是对于prisma migrate dev命令）是必需的 - 您不需要对生产环境进行任何更改。