关系模式

在 Prisma 模式中，记录之间的关系使用 @relation 属性定义。例如，在以下模式中，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 关系模式，该模式使用外键在数据库级别强制执行记录之间的关系。外键是表中的一列或一组列，其值基于另一表中的主键。外键允许您

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

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

对于上面的示例模式，如果您使用 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 Client 与启用的 prisma 关系模式一起使用时，查询的行为是相同或类似的，但引用操作和某些约束由 Prisma 引擎而不是数据库处理。

警告

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

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

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

schema.prisma

datasource db {
  provider     = "mysql"
  url          = env("DATABASE_URL")
  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 Migrate 或 db push 对模式应用更改时，Prisma ORM 将向您的数据库添加或删除外键。有关更多信息，请参阅 在关系模式之间切换。

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

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

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

引用完整性

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

外键约束

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

引用操作

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

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

内省

当您使用启用了 foreignKeys 关系模式的 db pull 命令内省关系数据库时，将为存在外键的关系向您的 Prisma 模式添加 @relation 属性。

Prisma Migrate 和 db push

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

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

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

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

警告

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

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

模拟哪些外键约束？

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

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

模拟哪些引用操作？

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

下表显示每个数据库连接器可用的模拟参照操作。

数据库	级联	限制	无操作	设为空	设为默认值
PostgreSQL	✔️	✔️	❌‡	✔️	❌†
MySQL	✔️	✔️	✔️	✔️	❌†
SQLite	✔️	✔️	❌‡	✔️	❌†
SQL Server	✔️	✔️	✔️	✔️	❌†
CockroachDB	✔️	✔️	✔️	✔️	❌†
MongoDB	✔️	✔️	✔️	✔️	❌†

• † SetDefault 参照操作在 prisma 关系模式下不受支持。
• ‡ NoAction 参照操作在 PostgreSQL 和 SQLite 的 prisma 关系模式下不受支持。请改用 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.

内省

当您使用 db pull 命令并启用 prisma 关系模式来内省数据库时，关系不会自动添加到您的模式中。您需要使用 @relation 属性手动添加所有关系。这只需要执行一次——下次您内省数据库时，Prisma ORM 将保留您添加的 @relation 属性。

Prisma Migrate 和 db push

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

索引

在使用外键约束的关系数据库中，数据库通常还会隐式地为外键列创建索引。例如，MySQL 将在外键列上创建索引。这样可以使外键检查快速运行，并且不需要进行表扫描。

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

索引验证

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

schema.prisma

datasource db {
  provider     = "mysql"
  url          = env("DATABASE_URL")
  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 应用模式更改后，Prisma ORM 将在下一次迁移中删除所有先前创建的外键。

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

从 prisma 切换到 foreignKeys

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