关系模式

本页面回答的问题

• Prisma 中的 relationMode 是什么？
• 我应该何时使用 prisma 或 foreignKeys？
• 关系模拟如何影响约束？

在 Prisma Schema 中，记录之间的关系通过 @relation 属性定义。例如，在以下 Schema 中，User 和 Post 模型之间存在一对多关系。

schema.prisma

model Post {
  id       Int    @id @default(autoincrement())
  title    String
  author   User   @relation(fields: [authorId], references: [id], onDelete: Cascade, onUpdate: Cascade)
  authorId Int
}

model User {
  id    Int    @id @default(autoincrement())
  posts Post[]
}

Prisma ORM 有两种关系模式：foreignKeys 和 prisma，它们指定了如何强制执行记录之间的关系。

如果您将 Prisma ORM 与关系数据库一起使用，Prisma ORM 默认使用foreignKeys 关系模式，该模式通过外键在数据库级别强制执行记录之间的关系。外键是表中的一列或一组列，其值基于另一个表中的主键。外键允许您：

• 设置约束以防止您进行破坏引用的更改
• 设置引用操作，定义如何处理记录的更改

这些约束和引用操作共同保证了数据的引用完整性。

对于上述示例 Schema，如果您使用 PostgreSQL 连接器，Prisma Migrate 将默认生成以下 SQL：

-- CreateTable
CREATE TABLE "Post" (
    "id" SERIAL NOT NULL,
    "title" TEXT NOT NULL,
    "authorId" INTEGER NOT NULL,

    CONSTRAINT "Post_pkey" PRIMARY KEY ("id")
);

-- CreateTable
CREATE TABLE "User" (
    "id" SERIAL NOT NULL,

    CONSTRAINT "User_pkey" PRIMARY KEY ("id")
);

-- AddForeignKey
//highlight-start
ALTER TABLE "Post"
  ADD CONSTRAINT "Post_authorId_fkey"
  FOREIGN KEY ("authorId")
  REFERENCES "User"("id") ON DELETE CASCADE ON UPDATE CASCADE;
//highlight-end

在这种情况下，Post 表的 authorId 列上的外键约束引用了 User 表的 id 列，并保证帖子必须有一个存在的作者。如果您更新或删除用户，ON DELETE 和 ON UPDATE 引用操作指定了 CASCADE 选项，这也会删除或更新属于该用户的所有帖子。

某些数据库，如 MongoDB 或 PlanetScale，不支持外键。此外，在某些情况下，开发人员可能更喜欢不在通常支持外键的关系数据库中使用外键。对于这些情况，Prisma ORM 提供了prisma 关系模式，它模拟了关系数据库中关系的一些属性。当您在启用 prisma 关系模式的情况下使用 Prisma Client 时，查询行为相同或相似，但引用操作和一些约束由 Prisma 引擎而不是数据库处理。

警告

Prisma Client 中引用完整性和引用操作的模拟对性能有影响。在底层数据库支持外键的情况下，通常首选外键。

如何在 Prisma Schema 中设置关系模式

要设置关系模式，请在 datasource 块中添加 relationMode 字段。

schema.prisma

datasource db {
  provider     = "mysql"
  relationMode = "prisma"
}

信息

设置关系模式的功能作为 Prisma ORM 3.1.1 版本中 referentialIntegrity 预览功能的一部分引入，并在 Prisma ORM 4.8.0 及更高版本中普遍可用。

relationMode 字段在 Prisma ORM 4.5.0 版本中更名，之前名为 referentialIntegrity。

对于关系数据库，可用选项包括：

• foreignKeys：这通过外键在数据库中处理关系。这是所有关系数据库连接器的默认选项，如果 datasource 块中没有明确设置 relationMode，则此选项处于活动状态。
• prisma：这在 Prisma Client 中模拟关系。当您将 MySQL 连接器与 PlanetScale 数据库一起使用，并且未在 PlanetScale 数据库设置中启用原生外键约束时，您还应该启用此选项。

对于 MongoDB，唯一可用的选项是 prisma 关系模式。如果 datasource 块中未明确设置 relationMode，此模式也处于活动状态。

警告

如果您在关系模式之间切换，Prisma ORM 将在下次使用 Prisma Migrate 或 db push 应用 Schema 更改时，向数据库添加或删除外键。有关更多信息，请参阅切换关系模式。

使用 foreignKeys 关系模式在关系数据库中处理关系

foreignKeys 关系模式通过外键在关系数据库中处理关系。这是您使用关系数据库连接器（PostgreSQL、MySQL、SQLite、SQL Server、CockroachDB）时的默认选项。

当您使用 MongoDB 连接器时，foreignKeys 关系模式不可用。一些关系数据库，例如 PlanetScale，也禁止使用外键。在这些情况下，您应该使用 prisma 关系模式在 Prisma ORM 中模拟关系。

引用完整性

foreignKeys 关系模式通过外键约束和引用操作在数据库级别维护引用完整性。

外键约束

当您创建或更新与另一条记录有关系的记录时，相关记录需要存在。外键约束在数据库中强制执行此行为。如果记录不存在，数据库将返回错误消息。

引用操作

当您更新或删除与另一条记录有关系的记录时，数据库中会触发引用操作。为了维护相关记录中的引用完整性，引用操作会阻止破坏引用完整性的更改，将更改级联到相关记录，或将引用已更新或已删除记录的字段值设置为 null 或默认值。

有关更多信息，请参阅引用操作页面。

自省

当您在启用 foreignKeys 关系模式的情况下使用 db pull 命令自省关系数据库时，对于存在外键的关系，@relation 属性将添加到您的 Prisma Schema 中。

Prisma Migrate 和 db push

当您在启用 foreignKeys 关系模式的情况下使用 Prisma Migrate 或 db push 应用 Prisma Schema 更改时，数据库中将为 Schema 中的所有 @relation 属性创建外键。

使用 prisma 关系模式在 Prisma ORM 中模拟关系

prisma 关系模式为每个 Prisma Client 查询模拟一些外键约束和引用操作，以维护引用完整性，这会使用一些额外的数据库查询和逻辑。

prisma 关系模式是 MongoDB 连接器的默认选项。如果您使用的关系数据库不支持外键，也应该设置此模式。例如，如果您使用 PlanetScale 而没有外键约束，则应该使用 prisma 关系模式。

警告

Prisma Client 中引用完整性模拟对性能有影响，因为它使用额外的数据库查询来维护引用完整性。在底层数据库可以使用外键处理引用完整性的情况下，通常首选外键。

关系的模拟仅适用于 Prisma Client 查询，不适用于原始查询。

哪些外键约束被模拟？

当您更新记录时，Prisma ORM 将模拟外键约束。这意味着当您更新与另一条记录有关系的记录时，相关记录需要存在。如果记录不存在，Prisma Client 将返回错误消息。

然而，当您创建记录时，Prisma ORM 不会模拟任何外键约束。您将能够创建无效数据。

哪些引用操作被模拟？

当您更新或删除具有相关记录的记录时，Prisma ORM 将模拟引用操作。

下表显示了每个数据库连接器可用的模拟引用操作：

数据库	Cascade	Restrict	NoAction	SetNull	SetDefault
PostgreSQL	✔️	✔️	❌‡	✔️	❌†
MySQL	✔️	✔️	✔️	✔️	❌†
SQLite	✔️	✔️	❌‡	✔️	❌†
SQL Server	✔️	✔️	✔️	✔️	❌†
CockroachDB	✔️	✔️	✔️	✔️	❌†
MongoDB	✔️	✔️	✔️	✔️	❌†

• † 在 prisma 关系模式中不支持 SetDefault 引用操作。
• ‡ 在 PostgreSQL 和 SQLite 的 prisma 关系模式中不支持 NoAction 引用操作。请改用 Restrict 操作。

错误消息

在 prisma 关系模式中，模拟约束和引用操作返回的错误消息由 Prisma Client 生成，与 foreignKeys 关系模式中的错误消息略有不同。

Example:
// foreignKeys:
... Foreign key constraint failed on the field: `ProfileOneToOne_userId_fkey (index)`
// prisma:
... The change you are trying to make would violate the required relation 'ProfileOneToOneToUserOneToOne' between the `ProfileOneToOne` and `UserOneToOne` models.

自省

当您在启用 prisma 关系模式的情况下使用 db pull 命令自省数据库时，关系不会自动添加到您的 Schema 中。您需要使用 @relation 属性手动添加任何关系。这只需要做一次 – 下次您自省数据库时，Prisma ORM 将保留您添加的 @relation 属性。

Prisma Migrate 和 db push

当您在启用 prisma 关系模式的情况下使用 Prisma Migrate 或 db push 应用 Prisma Schema 更改时，Prisma ORM 不会使用数据库中的外键。

索引

在使用外键约束的关系数据库中，数据库通常也会隐式地为外键列创建索引。例如，MySQL 将在所有外键列上创建索引。这是为了让外键检查快速运行，而不需要进行全表扫描。

prisma 关系模式不使用外键，因此当您使用 Prisma Migrate 或 db push 应用数据库更改时，不会创建索引。您需要使用 @@index 属性（或适用的 @unique、@@unique 或 @@id 属性）手动在关系标量字段上添加索引。

索引验证

如果您不手动添加索引，查询可能需要进行全表扫描。这可能会很慢，并且对于按访问行数计费的数据库提供商来说也很昂贵。为了帮助避免这种情况，当您的 Schema 包含用于 @relation 但未定义索引的字段时，Prisma ORM 会发出警告。例如，以下 Schema 在 User 和 Post 模型之间有一个关系：

schema.prisma

datasource db {
  provider     = "mysql"
  relationMode = "prisma"
}

model User {
  id    Int    @id
  posts Post[]
}

model Post {
  id     Int  @id
  userId Int
  user   User @relation(fields: [userId], references: [id])
}

当您运行 prisma format 或 prisma validate 时，Prisma ORM 会显示以下警告：

With `relationMode = "prisma"`, no foreign keys are used, so relation fields will not benefit from the index usually created by the relational database under the hood. This can lead to poor performance when querying these fields. We recommend adding an index manually.

要解决此问题，请向 Post 模型添加索引：

schema.prisma

model Post {
  id     Int  @id
  userId Int
  user   User @relation(fields: [userId], references: [id])

  @@index([userId])
}

如果您使用 Prisma VS Code 扩展（或其他编辑器中的语言服务器），警告会通过快速修复增强，自动为您添加所需的索引。

切换关系模式

只有在使用关系数据库连接器（PostgreSQL、MySQL、SQLite、SQL Server、CockroachDB）时，才能在关系模式之间切换。

从 foreignKeys 切换到 prisma

如果您使用关系数据库且未在 datasource 块中包含 relationMode 字段，则默认关系模式为 foreignKeys。要切换到 prisma 关系模式，请添加 relationMode 字段并将其值设置为 prisma，如果它已经存在，则将其值更新为 prisma。

当您将关系模式从 foreignKeys 切换到 prisma 后，首次使用 Prisma Migrate 或 db push 应用 Schema 更改后，Prisma ORM 将在下一次迁移中删除所有以前创建的外键。

如果您保持相同的数据库，则可以继续正常工作。如果您切换到根本不支持外键的数据库，则现有的迁移历史记录包含创建外键的 SQL DDL，这可能会在您需要重新运行这些迁移时触发错误。在这种情况下，我们建议您删除 migrations 目录。（如果您使用不支持外键的 PlanetScale，我们通常建议您使用 db push 而不是 Prisma Migrate。）

从 prisma 切换到 foreignKeys

要从 prisma 关系模式切换到 foreignKeys 关系模式，请将 relationMode 字段值从 prisma 更新为 foreignKeys。为此，数据库必须支持外键。当您在切换关系模式后首次使用 Prisma Migrate 或 db push 应用 Schema 更改时，Prisma ORM 将在下一次迁移中为所有关系创建外键。