跳到主要内容

参考操作

参考操作决定了当您的应用程序删除或更新相关记录时，记录会发生什么情况。

从 2.26.0 版本开始，您可以在 Prisma schema 中的关系字段上定义参考操作。这允许您在 Prisma ORM 级别定义级联删除和级联更新等参考操作。

信息

版本差异

  • 如果您使用 3.0.1 或更高版本，您可以按照本页面的描述使用参考操作。
  • 如果您使用 2.26.0 到 3.0.0 之间的版本，您可以按照本页面的描述使用参考操作，但您必须启用预览功能标志 referentialActions。
  • 如果您使用 2.25.0 或更早版本，您可以在数据库中手动配置级联删除。

在以下示例中，在 Post 模型上的 author 字段中添加 onDelete: Cascade 意味着删除 User 记录也将删除所有相关的 Post 记录。

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

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

如果您未指定参考操作，Prisma ORM 将使用默认值。

危险

如果您从早于 2.26.0 的版本升级：您必须检查参考操作的升级路径部分，这一点至关重要。Prisma ORM 对参考操作的支持移除了 Prisma Client 中阻止运行时级联删除的安全网。如果您在未升级数据库的情况下使用此功能，则旧的默认操作 - ON DELETE CASCADE - 将变为活动状态。这可能会导致您未预期的级联删除。

什么是参考操作？​

参考操作是策略，用于定义当您运行 update 或 delete 查询时，数据库如何处理被引用的记录。

数据库级别的参考操作

参考操作是外键约束的功能，其存在是为了维护数据库中的引用完整性。

当您在 Prisma schema 中定义数据模型之间的关系时，您使用关系字段（数据库中不存在）和标量字段（数据库中存在）。这些外键在数据库级别连接模型。

引用完整性声明这些外键必须引用相关数据库表中的现有主键值。在您的 Prisma schema 中，这通常由相关模型上的 id 字段表示。

默认情况下，数据库将拒绝任何违反引用完整性的操作，例如，通过删除被引用的记录。

如何使用参考操作​

参考操作在 @relation 属性中定义，并映射到底层数据库中外键约束的操作。如果您未指定参考操作，Prisma ORM 将回退到默认值。

以下模型定义了 User 和 Post 之间的一对多关系，以及 Post 和 Tag 之间的多对多关系，并显式定义了参考操作

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

model Post {
  id     Int          @id @default(autoincrement())
  title  String
  tags   TagOnPosts[]
  User   User?        @relation(fields: [userId], references: [id], onDelete: SetNull, onUpdate: Cascade)
  userId Int?
}

model TagOnPosts {
  id     Int   @id @default(autoincrement())
  post   Post? @relation(fields: [postId], references: [id], onUpdate: Cascade, onDelete: Cascade)
  tag    Tag?  @relation(fields: [tagId], references: [id], onUpdate: Cascade, onDelete: Cascade)
  postId Int?
  tagId  Int?
}

model Tag {
  id    Int          @id @default(autoincrement())
  name  String       @unique
  posts TagOnPosts[]
}

此模型显式定义了以下参考操作

  • 如果您删除 Tag，则相应的标签分配也会在 TagOnPosts 中删除，使用 Cascade 参考操作
  • 如果您删除 User，由于 SetNull 参考操作，作者将从所有帖子中移除，方法是将字段值设置为 Null。为了允许这样做，User 和 userId 必须是 Post 中的可选字段。

Prisma ORM 支持以下参考操作

参考操作默认值​

如果您未指定参考操作，Prisma ORM 将使用以下默认值

条款可选关系强制关系
onDeleteSetNullRestrict
onUpdateCascadeCascade

例如，在以下 schema 中，所有 Post 记录必须通过 author 关系连接到 User

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

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

该 schema 未显式定义强制性 author 关系字段的参考操作，这意味着 onDelete 的默认参考操作为 Restrict，onUpdate 的默认参考操作为 Cascade。

注意事项​

以下注意事项适用

  • 参考操作不支持隐式多对多关系。要使用参考操作，您必须定义显式多对多关系，并在连接表上定义您的参考操作。
  • 参考操作和必需/可选关系的某些组合是不兼容的。例如，在必需关系上使用 SetNull 将在删除被引用记录时导致数据库错误，因为非空约束将被违反。请参阅 此 GitHub issue 以获取更多信息。

参考操作的类型​

下表显示了每个数据库支持的参考操作。

数据库CascadeRestrictNoActionSetNullSetDefault
PostgreSQL✔️✔️✔️✔️⌘✔️
MySQL/MariaDB✔️✔️✔️✔️❌ (✔️†)
SQLite✔️✔️✔️✔️✔️
SQL Server✔️❌‡✔️✔️✔️
CockroachDB✔️✔️✔️✔️✔️
MongoDB††✔️✔️✔️✔️❌

参考操作的特殊情况​

参考操作是 ANSI SQL 标准的一部分。但是，在某些特殊情况下，一些关系数据库会偏离标准。

MySQL/MariaDB​

MySQL/MariaDB 和底层的 InnoDB 存储引擎不支持 SetDefault。确切的行为取决于数据库版本

  • 在 MySQL 8 及更高版本以及 MariaDB 10.5 及更高版本中，SetDefault 实际上充当 NoAction 的别名。您可以使用 SET DEFAULT 参考操作定义表，但在运行时会触发外键约束错误。
  • 在 MySQL 5.6 及更高版本以及 MariaDB 10.5 之前的版本中，尝试创建带有 SET DEFAULT 参考操作的表定义将失败，并显示语法错误。

因此，当您将 mysql 设置为数据库提供程序时，Prisma ORM 会警告用户在 Prisma schema 中将 SetDefault 参考操作替换为另一个操作。

PostgreSQL​

PostgreSQL 是 Prisma ORM 支持的唯一允许您定义引用非空字段的 SetNull 参考操作的数据库。但是，当在运行时触发操作时，这会引发外键约束错误。

因此，当您在（默认）foreignKeys 关系模式中将 postgres 设置为数据库提供程序时，Prisma ORM 会警告用户将任何包含在具有 SetNull 参考操作的 @relation 属性中的字段标记为可选。对于所有其他数据库提供程序，Prisma ORM 将拒绝带有验证错误的 schema。

SQL Server​

Restrict 不适用于 SQL Server 数据库，但您可以改用 NoAction。

Cascade​

  • onDelete: Cascade 删除被引用的记录将触发引用记录的删除。
  • onUpdate: Cascade 如果依赖记录的被引用标量字段被更新，则更新关系标量字段。

用法示例​

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[]
}
使用 Cascade 的结果​

如果 User 记录被删除，则他们的帖子也会被删除。如果用户的 id 被更新，则相应的 authorId 也会被更新。

如何使用级联删除​

Restrict​

  • onDelete: Restrict 如果存在任何引用记录，则阻止删除。
  • onUpdate: Restrict 阻止更改被引用记录的标识符。

用法示例​

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

model User {
  id    Int    @id @default(autoincrement())
  posts Post[]
}
使用 Restrict 的结果​

有帖子的 User 无法删除。User 的 id 无法更改。

警告

Restrict 操作在 Microsoft SQL Server 上不可用，并会触发 schema 验证错误。相反，您可以使用 NoAction，它产生相同的结果并且与 SQL Server 兼容。

NoAction​

NoAction 操作类似于 Restrict，两者之间的区别取决于正在使用的数据库

  • PostgreSQL：NoAction 允许将检查（如果表上存在被引用行）推迟到事务的稍后阶段。有关更多信息，请参阅 PostgreSQL 文档。
  • MySQL：NoAction 的行为与 Restrict 完全相同。有关更多信息，请参阅 MySQL 文档。
  • SQLite：当相关的主键被修改或删除时，不执行任何操作。有关更多信息，请参阅 SQLite 文档。
  • SQL Server：当被引用记录被删除或修改时，会引发错误。有关更多信息，请参阅 SQL Server 文档。
  • MongoDB（从 3.6.0 版本开始预览）：当记录被修改或删除时，不会对任何相关记录执行任何操作。
警告

如果您在 Prisma Client 中管理关系而不是在数据库中使用外键，您应该意识到目前 Prisma ORM 仅实现参考操作。外键还会创建约束，这使得不可能以违反这些约束的方式操作数据：数据库不会执行查询，而是会返回错误。如果您在 Prisma Client 中模拟引用完整性，则不会创建这些约束，因此如果您将参考操作设置为 NoAction，则不会有任何检查来阻止您破坏引用完整性。

用法示例​

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

model User {
  id    Int    @id @default(autoincrement())
  posts Post[]
}
使用 NoAction 的结果​

有帖子的 User 无法删除。User 的 id 无法更改。

SetNull​

  • onDelete: SetNull 引用对象的标量字段将被设置为 NULL。

  • onUpdate: SetNull 当更新被引用对象的标识符时，引用对象的标量字段将被设置为 NULL。

SetNull 仅适用于可选关系。在必需关系上，将抛出运行时错误，因为标量字段不能为 null。

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

model User {
  id    Int    @id @default(autoincrement())
  posts Post[]
}
使用 SetNull 的结果​

当删除 User 时，所有由其发布的帖子的 authorId 将被设置为 NULL。

当更改 User 的 id 时，所有由其发布的帖子的 authorId 将被设置为 NULL。

SetDefault​

  • onDelete: SetDefault 引用对象的标量字段将被设置为字段的默认值。

  • onUpdate: SetDefault 引用对象的标量字段将被设置为字段的默认值。

这些需要使用 @default 为关系标量字段设置默认值。如果未为任何标量字段提供默认值，则会抛出运行时错误。

schema.prisma
model Post {
  id             Int     @id @default(autoincrement())
  title          String
  authorUsername String? @default("anonymous")
  author         User?   @relation(fields: [authorUsername], references: [username], onDelete: SetDefault, onUpdate: SetDefault)
}

model User {
  username String @id
  posts    Post[]
}
使用 SetDefault 的结果​

当删除 User 时，其现有帖子的 authorUsername 字段值将被设置为 'anonymous'。

当 User 的 username 更改时，其现有帖子的 authorUsername 字段值将被设置为 'anonymous'。

数据库特定的要求​

如果您在数据模型中具有自引用关系或循环关系，则 MongoDB 和 SQL Server 对参考操作有特定要求。如果您具有与两个模型之间的多条级联路径的关系，则 SQL Server 也有特定要求。

从 2.25.0 及更早版本的升级路径​

升级时可以采取几种路径，这些路径将根据所需的結果给出不同的结果。

如果您当前使用迁移工作流程，则可以运行内省以检查默认值如何在您的 schema 中反映。然后，如果需要，您可以手动更新数据库。

您也可以决定跳过检查默认值，并运行迁移以使用新的默认值更新您的数据库。

以下假设您已升级到 2.26.0 或更高版本并启用了预览功能标志，或升级到 3.0.0 或更高版本

使用内省​

如果您内省您的数据库，则在数据库级别配置的参考操作将反映在您的 Prisma Schema 中。如果您一直在使用 Prisma Migrate 或 prisma db push 来管理数据库 schema，则这些操作很可能是 2.25.0 及更早版本的默认值。

当您运行内省时，Prisma ORM 会将数据库中的所有外键与 schema 进行比较，如果 SQL 语句 ON DELETE 和 ON UPDATE 与默认值不匹配，它们将在 schema 文件中显式设置。

内省后，您可以查看 schema 中的非默认子句。要查看的最重要子句是 onDelete，在 2.25.0 及更早版本中，它默认为 Cascade。

警告

如果您正在使用 delete() 或 deleteMany() 方法，则级联删除现在将被执行，因为 referentialActions 预览功能移除了 Prisma Client 中先前阻止运行时级联删除的安全网。请务必检查您的代码并进行相应的调整。

确保您对 schema 中 onDelete: Cascade 的每种情况都感到满意。如果不是，请执行以下操作之一

  • 修改您的 Prisma schema 并 db push 或 dev migrate 以更改数据库

或

  • 如果您使用仅内省工作流程，则手动更新底层数据库

以下示例将导致级联删除，如果 User 被删除，则他们的所有 Post 也将被删除。

博客 schema 示例​

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

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

使用迁移​

当运行 迁移（或 prisma db push 命令）时，新的默认值将应用于您的数据库。

信息

与您首次运行内省不同，新的参考操作子句和属性将不会通过 Prisma VSCode 扩展自动添加到您的 prisma schema 中。如果您希望使用除新默认值以外的任何值，则必须手动添加它们。

在您的 Prisma schema 中显式定义参考操作是可选的。如果您未显式定义关系的参考操作，Prisma ORM 将使用新的默认值。

请注意，参考操作可以按个案添加。这意味着您可以将它们添加到单个关系中，并将其余关系设置为默认值，而无需手动指定任何内容。

检查错误​

在升级到 2.26.0 并启用参考操作预览功能之前，Prisma ORM 在使用 delete() 或 deleteMany() 时阻止删除记录以保持引用完整性。Prisma Client 会抛出一个带有错误代码 P2014 的自定义运行时错误。

在升级并启用参考操作预览功能之后，Prisma ORM 不再执行运行时检查。您可以改为指定自定义参考操作以保持关系之间的引用完整性。

当您使用 NoAction 或 Restrict 来阻止删除记录时，与 2.26.0 之前的版本相比，2.26.0 之后的错误消息将有所不同。这是因为它们现在由数据库触发，而不是由 Prisma Client 触发。可以预期的新错误代码是 P2003。

为了确保您捕获到这些新错误，您可以相应地调整您的代码。

捕获错误的示例​

以下示例使用以下博客 schema，其中 Post 和 User 之间存在一对多关系，并在 author 字段上设置了 Restrict 参考操作。

这意味着如果用户有帖子，则该用户（及其帖子）无法删除。

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

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

在升级和启用参考操作预览功能之前，当尝试删除有帖子的用户时，您将收到的错误代码是 P2014，其消息为

"您尝试进行的更改将违反 {model_a_name} 和 {model_b_name} 模型之间所需的 '{relation_name}' 关系。"

import { PrismaClient } from '@prisma/client'

const prisma = new PrismaClient()

async function main() {
  try {
    await prisma.user.delete({
      where: {
        id: 'some-long-id',
      },
    })
  } catch (error) {
    if (error instanceof Prisma.PrismaClientKnownRequestError) {
      if (error.code === 'P2014') {
        console.log(error.message)
      }
    }
  }
}

main()

为了确保您在代码中检查正确的错误，请修改您的检查以查找 P2003，这将传递消息

"外键约束在字段上失败：{field_name}"

import { PrismaClient } from '@prisma/client'

const prisma = new PrismaClient()

async function main() {
  try {
    await prisma.user.delete({
      where: {
        id: 'some-long-id'
      }
    })
  } catch (error) {
    if (error instanceof Prisma.PrismaClientKnownRequestError) {
      if (error.code === 'P2014') {
      if (error.code === 'P2003') {
        console.log(error.message)
      }
    }
  }
}

main()