跳到主要内容

引用操作

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

从 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 将使用以下默认值

子句可选关系强制关系
onDelete (删除时)SetNull (设为 Null)Restrict (限制)
onUpdate (更新时)Cascade (级联)Cascade (级联)

例如，在以下 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 问题。

引用操作类型​

下表显示了每种数据库支持的引用操作。

数据库Cascade (级联)Restrict (限制)NoAction (无操作)SetNull (设为 Null)SetDefault (设为默认值)
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​

SQL Server 数据库不提供Restrict，但您可以使用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 无法更改。

警告

Microsoft SQL Server上不提供 Restrict 操作，并且会触发 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。

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

捕获错误示例​

以下示例使用下面显示具有 Post 和 User 之间一对多关系的博客 schema，并在 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()
© . All rights reserved.