跳到主要内容

使用复合 ID 和唯一约束

可以使用 @@id 和 @@unique 属性在你的 Prisma schema 中定义复合 ID 和复合唯一约束。

警告

MongoDB 不支持 @@id
MongoDB 不支持复合 ID，这意味着你不能使用 @@id 属性标识模型。

复合 ID 或复合唯一约束使用两个字段的组合值作为数据库表中的主键或标识符。在以下示例中，postId 字段和 userId 字段被用作 Like 表的复合 ID

model User {
  id    Int    @id @default(autoincrement())
  name  String
  post  Post[]
  likes Like[]
}

model Post {
  id      Int    @id @default(autoincrement())
  content String
  User    User?  @relation(fields: [userId], references: [id])
  userId  Int?
  likes   Like[]
}

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

  @@id([postId, userId])
}

从 Like 表查询记录（例如，使用 prisma.like.findMany()）将返回如下所示的对象

{
  "postId": 1,
  "userId": 1
}

尽管响应中只有两个字段，但这两个字段构成了一个名为 postId_userId 的复合 ID。

你还可以通过使用 @@id 或 @@unique 属性的 name 字段来创建命名的复合 ID 或复合唯一约束。例如

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

  @@id(name: "likeId", [postId, userId])
}

你可以使用复合 ID 和唯一约束的地方​

复合 ID 和复合唯一约束可以在处理唯一数据时使用。

以下是 Prisma Client 函数列表，这些函数在查询的 where 过滤器中接受复合 ID 或复合唯一约束

  • findUnique()
  • findUniqueOrThrow
  • delete
  • update
  • upsert

当使用 connect 和 connectOrCreate 创建关系数据时，复合 ID 和复合唯一约束也是可用的。

通过复合 ID 或唯一约束过滤记录​

尽管你的查询结果不会将复合 ID 或唯一约束显示为字段，但你可以使用这些复合值来过滤你的查询，以查找唯一记录

const like = await prisma.like.findUnique({
  where: {
    likeId: {
      userId: 1,
      postId: 1,
    },
  },
})
信息

请注意，复合 ID 和复合唯一约束键仅可作为唯一查询的过滤器选项，例如 findUnique() 和 findUniqueOrThrow。请参阅上面的章节，了解可以使用这些字段的位置列表。

通过复合 ID 或唯一约束删除记录​

复合 ID 或复合唯一约束可以在 delete 查询的 where 过滤器中使用

const like = await prisma.like.delete({
  where: {
    likeId: {
      userId: 1,
      postId: 1,
    },
  },
})

通过复合 ID 或唯一约束更新和 upsert 记录​

复合 ID 或复合唯一约束可以在 update 查询的 where 过滤器中使用

const like = await prisma.like.update({
  where: {
    likeId: {
      userId: 1,
      postId: 1,
    },
  },
  data: {
    postId: 2,
  },
})

它们也可以在 upsert 查询的 where 过滤器中使用

await prisma.like.upsert({
  where: {
    likeId: {
      userId: 1,
      postId: 1,
    },
  },
  update: {
    userId: 2,
  },
  create: {
    userId: 2,
    postId: 1,
  },
})

通过复合 ID 或唯一约束过滤关系查询​

复合 ID 和复合唯一约束也可以在连接记录以创建关系时使用的 connect 和 connectOrCreate 键中使用。

例如，考虑以下查询

await prisma.user.create({
  data: {
    name: 'Alice',
    likes: {
      connect: {
        likeId: {
          postId: 1,
          userId: 2,
        },
      },
    },
  },
})

likeId 复合 ID 用作 connect 对象中的标识符，该对象用于定位将链接到新用户：“Alice” 的 Like 表记录。

类似地，likeId 可以用于 connectOrCreate 的 where 过滤器中，以尝试定位 Like 表中的现有记录

await prisma.user.create({
  data: {
    name: 'Alice',
    likes: {
      connectOrCreate: {
        create: {
          postId: 1,
        },
        where: {
          likeId: {
            postId: 1,
            userId: 1,
          },
        },
      },
    },
  },
})