跳到主要内容

关系

关系是 Prisma schema 中两个模型之间的*连接*。例如，User 和 Post 之间存在一对多关系，因为一个用户可以拥有多篇博客文章。

以下 Prisma schema 定义了 User 和 Post 模型之间的一对多关系。定义关系所涉及的字段已高亮显示

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

model Post {
  id       Int  @id @default(autoincrement())
  author   User @relation(fields: [authorId], references: [id])
  authorId Int // relation scalar field  (used in the `@relation` attribute above)

  title String
}

在 Prisma ORM 层面，User / Post 关系由以下部分组成

  • 两个关系字段：author 和 posts。关系字段在 Prisma ORM 层面定义模型之间的连接，并且在数据库中不存在。这些字段用于生成 Prisma Client。
  • 标量 authorId 字段，由 @relation 属性引用。此字段在数据库中确实存在 - 它是连接 Post 和 User 的外键。

在 Prisma ORM 层面，两个模型之间的连接总是由关系每一侧的关系字段表示。

数据库中的关系​

关系型数据库​

以下实体关系图定义了关系型数据库中 User 和 Post 表之间的相同一对多关系

A one-to-many relationship between a user and posts table.

在 SQL 中，您使用*外键*创建两个表之间的关系。外键存储在关系的一侧。我们的示例由以下部分组成

  • Post 表中名为 authorId 的外键列。
  • User 表中名为 id 的主键列。Post 表中的 authorId 列引用了 User 表中的 id 列。

在 Prisma schema 中，外键/主键关系由 author 字段上的 @relation 属性表示

author     User        @relation(fields: [authorId], references: [id])

注意：Prisma schema 中的关系代表数据库表中存在的关联。如果数据库中不存在该关联，则在 Prisma schema 中也不存在。

MongoDB​

对于 MongoDB，Prisma ORM 目前使用规范化的数据模型设计，这意味着文档通过 ID 相互引用，方式类似于关系型数据库。

以下文档代表一个 User（在 User 集合中）

{ "_id": { "$oid": "60d5922d00581b8f0062e3a8" }, "name": "Ella" }

以下 Post 文档列表（在 Post 集合中）每个都有一个 authorId 字段，引用同一个用户

[
  {
    "_id": { "$oid": "60d5922e00581b8f0062e3a9" },
    "title": "How to make sushi",
    "authorId": { "$oid": "60d5922d00581b8f0062e3a8" }
  },
  {
    "_id": { "$oid": "60d5922e00581b8f0062e3aa" },
    "title": "How to re-install Windows",
    "authorId": { "$oid": "60d5922d00581b8f0062e3a8" }
  }
]

这种数据结构代表了一对多关系，因为多个 Post 文档引用了同一个 User 文档。

在 ID 和关系标量字段上的 @db.ObjectId​

如果您的模型的 ID 是一个 ObjectId（由 String 字段表示），您必须在模型的 ID *和*关系另一侧的关系标量字段上添加 @db.ObjectId

model User {
  id    String @id @default(auto()) @map("_id") @db.ObjectId
  posts Post[]
}

model Post {
  id       String @id @default(auto()) @map("_id") @db.ObjectId
  author   User   @relation(fields: [authorId], references: [id])
  authorId String @db.ObjectId // relation scalar field  (used in the `@relation` attribute above)

  title String
}

Prisma Client 中的关系​

Prisma Client 是从 Prisma schema 生成的。以下示例演示了当您使用 Prisma Client 获取、创建和更新记录时，关系如何体现。

创建记录和嵌套记录​

以下查询创建一个 User 记录和两个关联的 Post 记录

const userAndPosts = await prisma.user.create({
  data: {
    posts: {
      create: [
        { title: 'Prisma Day 2020' }, // Populates authorId with user's id
        { title: 'How to write a Prisma schema' }, // Populates authorId with user's id
      ],
    },
  },
})

在底层数据库中，此查询

  1. 创建一个具有自动生成 id 的 User（例如，20）
  2. 创建两个新的 Post 记录，并将这两个记录的 authorId 设置为 20

以下查询按 id 检索 User 并包含任何相关的 Post 记录

const getAuthor = await prisma.user.findUnique({
  where: {
    id: "20",
  },
  include: {
    posts: true, // All posts where authorId == 20
  },
});

在底层数据库中，此查询

  1. 检索 id 为 20 的 User 记录
  2. 检索所有 authorId 为 20 的 Post 记录

将现有记录与其他现有记录关联​

以下查询将现有 Post 记录与现有 User 记录关联

const updateAuthor = await prisma.user.update({
  where: {
    id: 20,
  },
  data: {
    posts: {
      connect: {
        id: 4,
      },
    },
  },
})

在底层数据库中，此查询使用嵌套的 connect 查询将 id 为 4 的文章链接到 id 为 20 的用户。该查询通过以下步骤完成此操作

  • 查询首先查找 id 为 20 的用户。
  • 然后，查询将 authorID 外键设置为 20。这将 id 为 4 的文章链接到 id 为 20 的用户。

在此查询中，authorID 的当前值无关紧要。无论其当前值如何，查询都会将 authorID 更改为 20。

关系类型​

Prisma ORM 中有三种不同类型（或基数）的关系

以下 Prisma schema 包含了所有类型的关系

  • 一对一：User ↔ Profile
  • 一对多：User ↔ Post
  • 多对多：Post ↔ Category
model User {
  id      Int      @id @default(autoincrement())
  posts   Post[]
  profile Profile?
}

model Profile {
  id     Int  @id @default(autoincrement())
  user   User @relation(fields: [userId], references: [id])
  userId Int  @unique // relation scalar field (used in the `@relation` attribute above)
}

model Post {
  id         Int        @id @default(autoincrement())
  author     User       @relation(fields: [authorId], references: [id])
  authorId   Int // relation scalar field  (used in the `@relation` attribute above)
  categories Category[]
}

model Category {
  id    Int    @id @default(autoincrement())
  posts Post[]
}
信息

此 schema 与示例数据模型相同，但移除了所有标量字段（除了必需的关系标量字段），以便您可以专注于关系字段。

信息

此示例使用隐式多对多关系。除非需要消除关系歧义，否则这些关系不需要 @relation 属性。

请注意，关系型数据库和 MongoDB 之间的语法略有不同 - 特别是对于多对多关系。

对于关系型数据库，以下实体关系图表示与示例 Prisma schema 对应的数据库

The sample schema as an entity relationship diagram

对于 MongoDB，Prisma ORM 使用规范化的数据模型设计，这意味着文档通过 ID 相互引用，方式类似于关系型数据库。更多详情请参阅MongoDB 部分。

隐式和显式多对多关系​

关系型数据库中的多对多关系可以通过两种方式建模

隐式多对多关系要求两个模型都具有单个 @id。请注意以下几点

  • 您不能使用多字段 ID
  • 您不能使用 @unique 代替 @id

要使用这些功能中的任何一个，您必须设置显式多对多关系。

隐式多对多关系仍然在底层数据库中的关系表中体现。然而，Prisma ORM 管理这个关系表。

如果您使用隐式多对多关系而不是显式关系，则会使Prisma Client API 更简单（例如，因为在嵌套写入中嵌套层级会少一层）。

如果您未使用 Prisma Migrate，而是通过内省获取数据模型，您仍然可以遵循 Prisma ORM 的关系表约定来使用隐式多对多关系。

关系字段​

关系字段是 Prisma 模型中不具有标量类型的字段。相反，它们的类型是另一个模型。

每个关系必须恰好有两个关系字段，每个模型上一个。在一对一和一对多关系的情况下，需要一个额外的关系标量字段，该字段通过 @relation 属性中的两个关系字段之一进行链接。这个关系标量字段是底层数据库中外键的直接表示。

model User {
  id    Int    @id @default(autoincrement())
  email String @unique
  role  Role   @default(USER)
  posts Post[] // relation field (defined only at the Prisma ORM level)
}

model Post {
  id       Int    @id @default(autoincrement())
  title    String
  author   User   @relation(fields: [authorId], references: [id]) // relation field (uses the relation scalar field `authorId` below)
  authorId Int // relation scalar field (used in the `@relation` attribute above)
}

posts 和 author 都是关系字段，因为它们的类型不是标量类型而是其他模型。

另请注意，带注解的关系字段 author 需要在 @relation 属性内部链接 Post 模型上的关系标量字段 authorId。关系标量字段代表底层数据库中的外键。

这两个关系字段（即 posts 和 author）纯粹是在 Prisma ORM 层面定义的，它们不会在数据库中体现。

带注解的关系字段​

关系的一侧需要使用 @relation 属性进行*注解*，这类关系被称为*带注解的关系字段*。这包括

  • 一对一关系
  • 一对多关系
  • 仅适用于 MongoDB 的多对多关系

用 @relation 属性注解的关系侧代表了在底层数据库中存储外键的一侧。代表外键的“实际”字段也需要在该关系侧上，它被称为*关系标量字段*，并在 @relation 属性内部被引用

author     User    @relation(fields: [authorId], references: [id])
authorId   Int

当一个标量字段在 @relation 属性的 fields 中被使用时，它就*变成*了一个关系标量字段。

关系标量字段​

关系标量字段命名约定​

因为关系标量字段总是*属于*一个关系字段，所以以下命名约定很常见

  • 关系字段：author
  • 关系标量字段：authorId（关系字段名 + Id）

@relation 属性​

@relation 属性只能应用于关系字段，不能应用于标量字段。

在以下情况下需要 @relation 属性

  • 您定义一对一或一对多关系时，关系中*一侧*需要它（以及相应的关系标量字段）
  • 您需要消除关系歧义（例如，当您在相同模型之间有两个关系时）
  • 您定义自关联时
  • 您定义适用于 MongoDB 的多对多关系时
  • 您需要控制关系表在底层数据库中的表示方式（例如，为关系表使用特定名称）

注意：关系型数据库中的隐式多对多关系不需要 @relation 属性。

消除关系歧义​

当您在相同的两个模型之间定义两个关系时，需要在 @relation 属性中添加 name 参数以消除歧义。为了说明为何需要这样做，请考虑以下模型

// NOTE: This schema is intentionally incorrect. See below for a working solution.

model User {
  id           Int     @id @default(autoincrement())
  name         String?
  writtenPosts Post[]
  pinnedPost   Post?
}

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

在这种情况下，关系是模糊的，有四种不同的解释方式

  • User.writtenPosts ↔ Post.author + Post.authorId
  • User.writtenPosts ↔ Post.pinnedBy + Post.pinnedById
  • User.pinnedPost ↔ Post.author + Post.authorId
  • User.pinnedPost ↔ Post.pinnedBy + Post.pinnedById

为了消除这些关系的歧义，您需要使用 @relation 属性注解关系字段并提供 name 参数。您可以设置任何 name（空字符串 "" 除外），但它必须在关系的双方相同

model User {
  id           Int     @id @default(autoincrement())
  name         String?
  writtenPosts Post[]  @relation("WrittenPosts")
  pinnedPost   Post?   @relation("PinnedPost")
}

model Post {
  id         Int     @id @default(autoincrement())
  title      String?
  author     User    @relation("WrittenPosts", fields: [authorId], references: [id])
  authorId   Int
  pinnedBy   User?   @relation("PinnedPost", fields: [pinnedById], references: [id])
  pinnedById Int?    @unique
}