跳至主要内容

模型

在 Prisma 模式 的数据模型定义部分定义了应用程序模型（也称为 **Prisma 模型**）。模型

  • 表示应用程序域的 **实体**
  • 映射到数据库中的 **表**（PostgreSQL 等关系数据库）或 **集合**（MongoDB）
  • 构成在生成的 Prisma Client API 中可用的 **查询** 的基础
  • 当与 TypeScript 一起使用时，Prisma Client 为您的模型和任何 变体 提供生成的 **类型定义**，以使数据库访问完全类型安全。

以下模式描述了一个博客平台 - 数据模型定义突出显示

datasource db {
  provider = "postgresql"
  url      = env("DATABASE_URL")
}

generator client {
  provider = "prisma-client-js"
}

model User {
  id      Int      @id @default(autoincrement())
  email   String   @unique
  name    String?
  role    Role     @default(USER)
  posts   Post[]
  profile Profile?
}

model Profile {
  id     Int    @id @default(autoincrement())
  bio    String
  user   User   @relation(fields: [userId], references: [id])
  userId Int    @unique
}

model Post {
  id         Int        @id @default(autoincrement())
  createdAt  DateTime   @default(now())
  updatedAt  DateTime   @updatedAt
  title      String
  published  Boolean    @default(false)
  author     User       @relation(fields: [authorId], references: [id])
  authorId   Int
  categories Category[]
}

model Category {
  id    Int    @id @default(autoincrement())
  name  String
  posts Post[]
}

enum Role {
  USER
  ADMIN
}

数据模型定义由以下组成

相应的数据库如下所示

Sample database

模型映射到数据源的基础结构。
  • 在 PostgreSQL 和 MySQL 等关系数据库中，model 映射到 **表**
  • 在 MongoDB 中，model 映射到 **集合**

**注意**：将来可能会有非关系数据库和其他数据源的连接器。例如，对于 REST API，它将映射到一个资源。

以下查询使用从此数据模型生成的 Prisma Client 来创建

  • 一个 User 记录
  • 两个嵌套的 Post 记录
  • 三个嵌套的 Category 记录
const user = await prisma.user.create({
  data: {
    email: '[email protected]',
    name: 'Ariadne',
    posts: {
      create: [
        {
          title: 'My first day at Prisma',
          categories: {
            create: {
              name: 'Office',
            },
          },
        },
        {
          title: 'How to connect to a SQLite database',
          categories: {
            create: [{ name: 'Databases' }, { name: 'Tutorials' }],
          },
        },
      ],
    },
  },
})

您的数据模型反映了您的应用程序域。例如

  • 在 **电子商务** 应用程序中，您可能具有 Customer、Order、Item 和 Invoice 等模型。
  • 在 **社交媒体** 应用程序中，您可能具有 User、Post、Photo 和 Message 等模型。

内省和迁移​

有两种方法可以定义数据模型

  • **手动编写数据模型并使用 Prisma Migrate**：您可以手动编写数据模型，并使用 Prisma Migrate 将其映射到您的数据库。在这种情况下，数据模型是应用程序模型的唯一真相来源。
  • **通过内省生成数据模型**：当您拥有现有的数据库或更喜欢使用 SQL 迁移数据库模式时，您可以通过 内省 数据库来生成数据模型。在这种情况下，数据库模式是应用程序模型的唯一真相来源。

定义模型​

模型表示应用程序域的实体。模型由 model 块表示，并定义多个 字段。在上例数据模型中，User、Profile、Post 和 Category 是模型。

博客平台可以通过以下模型扩展

model Comment {
  // Fields
}

model Tag {
  // Fields
}

将模型名称映射到表或集合​

Prisma 模型 命名约定（单数形式，PascalCase） 并不总是与数据库中的表名匹配。数据库中命名表/集合的常用方法是使用复数形式和 snake_case 表示法 - 例如：comments。当您内省名称为 comments 的数据库表时，结果 Prisma 模型将如下所示

model comments {
  // Fields
}

但是，您仍然可以通过使用 @@map 属性来遵守命名约定，而无需重命名数据库中的基础 comments 表

model Comment {
  // Fields

  @@map("comments")
}

使用此模型定义，Prisma ORM 会自动将 Comment 模型映射到基础数据库中的 comments 表。

**注意**：您还可以 @map 列名或枚举值，以及 @@map 枚举名。

@map 和 @@map 允许您通过将模型和字段名称与基础数据库中的表和列名称解耦来 调整 Prisma Client API 的形状。

定义字段​

模型的属性称为字段，由以下组成

字段的类型决定了它的结构，并分为以下两类

  • 标量类型（包括 枚举）映射到数据库中的列（关系数据库）或文档字段（MongoDB） - 例如，String 或 Int
  • 模型类型（然后字段称为 关系字段） - 例如 Post 或 Comment[]。

下表描述了示例模式中 User 模型的字段

展开以查看表格
名称类型标量与关系类型修饰符属性
idInt标量-@id 和 @default(autoincrement())
emailString标量-@unique
nameString标量?-
roleRole标量 (enum)-@default(USER)
postsPost关系（Prisma 级别字段）[]-
profileProfile关系（Prisma 级别字段）?-

标量字段​

以下示例使用多个标量类型扩展了 Comment 和 Tag 模型。某些字段包含 属性

model Comment {
  id      Int    @id @default(autoincrement())
  title   String
  content String
}

model Tag {
  name String @id
}

请参阅 标量字段类型的完整列表。

关系字段​

关系字段的类型是另一个模型 - 例如，帖子 (Post) 可以有多个评论 (Comment[])

model Post {
  id       Int       @id @default(autoincrement())
  // Other fields
  comments Comment[] // A post can have many comments
}

model Comment {
  id     Int
  // Other fields
  post   Post? @relation(fields: [postId], references: [id]) // A comment can have one post
  postId Int?
}

请参阅 关系文档 以获取有关模型之间关系的更多示例和信息。

原生类型映射​

版本 2.17.0 及更高版本支持 **原生数据库类型属性**（类型属性）来描述底层数据库类型

model Post {
  id      Int    @id
  title   String @db.VarChar(200)
  content String
}

类型属性是

  • 特定于底层提供程序 - 例如，PostgreSQL 使用 @db.Boolean 表示 Boolean，而 MySQL 使用 @db.TinyInt(1)
  • 以 PascalCase 编写（例如，VarChar 或 Text）
  • 以 @db 为前缀，其中 db 是模式中 datasource 块的名称

此外，在 内省 期间，只有当底层原生类型 **不是默认类型** 时，才会将类型属性添加到模式中。例如，如果您使用的是 PostgreSQL 提供程序，则底层原生类型为 text 的 String 字段将没有类型属性。

请参阅 每个标量类型和提供程序的原生数据库类型属性的完整列表。

优势和工作流程​

  • 控制 Prisma Migrate 在数据库中创建的 **确切原生类型** - 例如，String 可以是 @db.VarChar(200) 或 @db.Char(50)
  • 在您内省时查看 **增强的模式**

类型修饰符​

可以通过附加以下两个修饰符之一来修改字段的类型

  • [] 将字段设为列表
  • ? 将字段设为可选

**注意**：您 **不能** 组合类型修饰符 - 不支持可选列表。

列表​

以下示例包含标量列表和相关模型的列表

model Post {
  id       Int       @id @default(autoincrement())
  // Other fields
  comments Comment[] // A list of comments
  keywords String[] // A scalar list
}

注意：标量列表仅在数据库连接器原生支持或 Prisma ORM 层支持标量列表的情况下才受支持。

可选字段和必填字段​

model Comment {
  id      Int     @id @default(autoincrement())
  title   String
  content String?
}

model Tag {
  name String @id
}

当不使用?类型修饰符注释字段时，该字段在模型的每个记录中都将是必填的。这在两个层面上都有影响

  • 数据库
    • 关系型数据库：必填字段在底层数据库中通过NOT NULL约束表示。
    • MongoDB：必填字段不是 MongoDB 数据库级别的概念。
  • Prisma Client：Prisma Client 生成的TypeScript 类型，用于表示应用程序代码中的模型，也将定义这些字段为必填字段，以确保它们在运行时始终携带值。

注意：可选字段的默认值为null。

不受支持的类型​

当您内省关系型数据库时，不受支持的数据类型将作为Unsupported添加

location    Unsupported("POLYGON")?

Unsupported类型允许您在 Prisma 模式中为 Prisma ORM 尚未支持的数据库类型定义字段。例如，MySQL 的POLYGON类型目前不受 Prisma ORM 支持，但现在可以使用Unsupported("POLYGON")类型将其添加到 Prisma 模式中。

类型为Unsupported的字段不会出现在生成的 Prisma Client API 中，但您仍然可以使用 Prisma ORM 的原始数据库访问功能来查询这些字段。

注意：如果模型具有必填的Unsupported字段，则生成的客户端将不包含该模型的create或update方法。

注意：MongoDB 连接器不支持也不需要Unsupported类型，因为它支持所有标量类型。

定义属性​

属性修改字段或模型块的行为。以下示例包含三个字段属性（@id、@default和@unique）和一个块属性（@@unique）

model User {
  id        Int     @id @default(autoincrement())
  firstName String
  lastName  String
  email     String  @unique
  isAdmin   Boolean @default(false)

  @@unique([firstName, lastName])
}

某些属性接受参数 - 例如，@default接受true或false

isAdmin   Boolean @default(false) // short form of @default(value: false)

请参阅字段和块属性的完整列表

定义 ID 字段​

ID 唯一标识模型的单个记录。一个模型只能有一个ID

  • 在关系型数据库中，ID 可以是单个字段或基于多个字段。如果模型没有@id或@@id，则必须定义一个必填的@unique字段或@@unique块。
  • 在MongoDB中，ID 必须是定义了@id属性和@map("_id")属性的单个字段。

在关系型数据库中定义 ID​

在关系型数据库中，可以使用@id属性通过单个字段定义 ID，或者使用@@id属性通过多个字段定义 ID。

单字段 ID​

在以下示例中，User ID 由id整数字段表示

model User {
  id      Int      @id @default(autoincrement())
  email   String   @unique
  name    String?
  role    Role     @default(USER)
  posts   Post[]
  profile Profile?
}
复合 ID​

在以下示例中，User ID 由firstName和lastName字段的组合表示

model User {
  firstName String
  lastName  String
  email     String  @unique
  isAdmin   Boolean @default(false)

  @@id([firstName, lastName])
}

默认情况下，Prisma Client 查询中此字段的名称将为firstName_lastName。

您还可以使用@@id属性的name字段为复合 ID 提供您自己的名称

model User {
  firstName String
  lastName  String
  email     String  @unique
  isAdmin   Boolean @default(false)

  @@id(name: "fullName", fields: [firstName, lastName])
}

firstName_lastName字段现在将命名为fullName。

信息

请参阅有关使用复合 ID的文档，以了解如何在 Prisma Client 中与复合 ID 进行交互。

@unique字段作为唯一标识符​

在以下示例中，用户通过@unique字段唯一标识。由于email字段充当模型的唯一标识符（这是必需的），因此它必须是必填字段

model User {
  email   String   @unique
  name    String?
  role    Role     @default(USER)
  posts   Post[]
  profile Profile?
}
信息

关系型数据库中的约束名称
您可以在底层数据库中可选地定义自定义主键约束名称。

在 MongoDB 中定义 ID​

MongoDB 连接器对定义 ID 字段有特定的规则，这与关系型数据库有所不同。ID 必须使用@id属性通过单个字段定义，并且必须包含@map("_id")。

在以下示例中，User ID 由接受自动生成的ObjectId的id字符串字段表示

model User {
  id      String   @id @default(auto()) @map("_id") @db.ObjectId
  email   String   @unique
  name    String?
  role    Role     @default(USER)
  posts   Post[]
  profile Profile?
}

在以下示例中，User ID 由接受除ObjectId之外的其他内容（例如，唯一的用户名）的id字符串字段表示

model User {
  id      String   @id @map("_id")
  email   String   @unique
  name    String?
  role    Role     @default(USER)
  posts   Post[]
  profile Profile?
}
警告

MongoDB 不支持@@id
MongoDB 不支持复合 ID，这意味着您无法使用@@id块标识模型。

定义默认值​

您可以使用@default属性为模型的标量字段定义默认值

model Post {
  id         Int        @id @default(autoincrement())
  createdAt  DateTime   @default(now())
  title      String
  published  Boolean    @default(false)
  data       Json       @default("{ \"hello\": \"world\" }")
  author     User       @relation(fields: [authorId], references: [id])
  authorId   Int
  categories Category[] @relation(references: [id])
}

@default属性要么

  • 在底层数据库中表示DEFAULT值（仅限关系型数据库）或
  • 使用 Prisma ORM 级别函数。例如，cuid()和uuid()由 Prisma Client 的查询引擎为所有连接器提供。

默认值可以是

  • 与字段类型相对应的静态值，例如5（Int）、Hello（String）或false（Boolean）
  • 列表静态值，例如[5, 6, 8]（Int[]）或["Hello", "Goodbye"]（String[]）。这些在使用支持的数据库（PostgreSQL、CockroachDB 和 MongoDB）时，在 Prisma ORM 4.0.0 及更高版本中可用。
  • 函数，例如now()或uuid()
  • JSON 数据。请注意，JSON 需要在@default属性内用双引号括起来，例如：@default("[]")。如果要提供 JSON 对象，则需要用双引号将其括起来，然后使用反斜杠转义任何内部双引号，例如：@default("{ \"hello\": \"world\" }")。
信息

请参阅属性函数参考文档，了解连接器对函数的支持信息。

定义唯一字段​

您可以向模型添加唯一属性，以便能够唯一地识别该模型的单个记录。唯一属性可以使用@unique属性在单个字段上定义，或者使用@@unique属性在多个字段上定义（也称为复合或组合唯一约束）。

在以下示例中，email字段的值必须是唯一的

model User {
  id    Int     @id @default(autoincrement())
  email String  @unique
  name  String?
}

在以下示例中，authorId和title的组合必须是唯一的

model Post {
  id         Int        @id @default(autoincrement())
  createdAt  DateTime   @default(now())
  title      String
  published  Boolean    @default(false)
  author     User       @relation(fields: [authorId], references: [id])
  authorId   Int
  categories Category[] @relation(references: [id])

  @@unique([authorId, title])
}
信息

关系型数据库中的约束名称
您可以在底层数据库中可选地定义自定义唯一约束名称。

默认情况下，Prisma Client 查询中此字段的名称将为authorId_title。

您还可以使用@@unique属性的name字段为复合唯一约束提供您自己的名称

model Post {
  id         String     @id @default(auto()) @map("_id") @db.ObjectId
  createdAt  DateTime   @default(now())
  title      String
  published  Boolean    @default(false)
  author     User       @relation(fields: [authorId], references: [id])
  authorId   String     @db.ObjectId
  categories Category[] @relation(references: [id])

  @@unique(name: "authorTitle", [authorId, title])
}

authorId_title字段现在将命名为authorTitle。

信息

请参阅有关使用复合唯一标识符的文档，以了解如何在 Prisma Client 中与复合唯一约束进行交互。

复合类型唯一约束​

当在 3.12.0 及更高版本中使用 MongoDB 提供程序时，您可以使用语法@@unique([compositeType.field])在复合类型的字段上定义唯一约束。与其他字段一样，复合类型字段可以用作多列唯一约束的一部分。

以下示例定义了一个基于User模型的email字段和用于User.address的Address复合类型的number字段的多列唯一约束

schema.prisma
type Address {
  street String
  number Int
}

model User {
  id      Int     @id
  email   String
  address Address

  @@unique([email, address.number])
}

如果存在多个嵌套复合类型，则可以链接此表示法

schema.prisma
type City {
  name String
}

type Address {
  number Int
  city   City
}

model User {
  id      Int       @id
  address Address[]

  @@unique([address.city.name])
}

定义索引​

您可以通过模型上的@@index在模型的一个或多个字段上定义索引。以下示例定义了一个基于title和content字段的多列索引

model Post {
  id      Int     @id @default(autoincrement())
  title   String
  content String?

  @@index([title, content])
}
信息

关系型数据库中的索引名称


您可以在底层数据库中选择性地定义自定义索引名称。

定义复合类型索引​

在 3.12.0 及更高版本的 MongoDB 提供程序中，您可以使用语法 @@index([compositeType.field]) 定义复合类型字段上的索引。与其他字段一样，复合类型字段可以作为多列索引的一部分使用。

以下示例定义了一个基于 User 模型的 email 字段和 Address 复合类型的 number 字段的多列索引。

schema.prisma
type Address {
  street String
  number Int
}

model User {
  id      Int     @id
  email   String
  address Address

  @@index([email, address.number])
}

如果存在多个嵌套复合类型，则可以链接此表示法

schema.prisma
type City {
  name String
}

type Address {
  number Int
  city   City
}

model User {
  id      Int       @id
  address Address[]

  @@index([address.city.name])
}

定义枚举​

如果您的数据库连接器支持枚举，您可以在数据模型中定义枚举，无论是在原生级别还是在 Prisma ORM 级别。

枚举在 Prisma 模式数据模型中被视为标量类型。因此，它们默认情况下包含在Prisma Client 查询的返回值中。

枚举通过enum 块定义。例如，一个 User 有一个 Role。

model User {
  id    Int     @id @default(autoincrement())
  email String  @unique
  name  String?
  role  Role    @default(USER)
}

enum Role {
  USER
  ADMIN
}

定义复合类型​

信息

复合类型是在版本 3.10.0 中添加的，作为 mongodb 预览功能的一部分，并且从版本 3.12.0 开始正式可用。

警告

复合类型目前仅在 MongoDB 上可用。

复合类型（在 MongoDB 中称为嵌入式文档）通过允许您定义新的对象类型，支持在其他记录内嵌入记录。复合类型的结构和类型化方式类似于模型。

要定义复合类型，请使用 type 块。例如，请查看以下模式。

schema.prisma
model Product {
  id     String  @id @default(auto()) @map("_id") @db.ObjectId
  name   String
  photos Photo[]
}

type Photo {
  height Int
  width  Int
  url    String
}

在这种情况下，Product 模型在 photos 中存储了一个 Photo 复合类型的列表。

使用复合类型时的注意事项​

复合类型仅支持有限的属性集。支持以下属性：

以下属性在复合类型中不受支持：

  • @unique
  • @id
  • @relation
  • @ignore
  • @updatedAt

但是，仍然可以通过在使用复合类型的模型级别上使用 @@unique 属性来定义唯一约束。有关更多详细信息，请参阅复合类型唯一约束。

可以通过在使用复合类型的模型级别上使用 @@index 属性来定义索引。有关更多详细信息，请参阅复合类型索引。

使用函数​

Prisma 模式支持许多函数。这些函数可用于指定模型字段的默认值。

例如，createdAt 的默认值为now()。

model Post {
  id        Int      @id @default(autoincrement())
  createdAt DateTime @default(now())
}

cuid() 和uuid() 由 Prisma ORM 实现，因此在底层数据库模式中“不可见”。使用内省时，您仍然可以使用它们，方法是手动更改 Prisma 模式并生成 Prisma Client，在这种情况下，值将由 Prisma Client 的查询引擎生成。

对autoincrement()、now() 和dbgenerated(...) 的支持因数据库而异。

**关系型数据库连接器**在数据库级别实现 autoincrement()、dbgenerated(...) 和 now()。**MongoDB 连接器**不支持 autoincrement() 或 dbgenerated(...)，并且 now() 在 Prisma ORM 级别实现。 auto() 函数用于生成 ObjectId。

关系​

请参阅 关系文档 以获取有关模型之间关系的更多示例和信息。

Prisma Client 中的模型​

查询（CRUD）​

数据模型定义中的每个模型都将在生成的Prisma Client API中产生一些 CRUD 查询。

可以通过 Prisma Client 实例上的生成属性访问这些操作。默认情况下，属性名称是模型名称的小写形式，例如 User 模型的 user 或 Post 模型的 post。

以下是一个说明如何使用 Prisma Client API 中的 user 属性的示例。

const newUser = await prisma.user.create({
  data: {
    name: 'Alice',
  },
})
const allUsers = await prisma.user.findMany()

类型定义​

Prisma Client 还生成反映模型结构的**类型定义**。这些是生成的@prisma/client 节点模块的一部分。

在使用 TypeScript 时，这些类型定义可确保所有数据库查询都完全类型安全并在编译时进行验证（即使是使用select 或include 的部分查询）。

即使在使用纯 JavaScript 时，类型定义仍然包含在 @prisma/client 节点模块中，从而启用诸如IntelliSense/自动完成等功能。

注意：实际类型存储在 .prisma/client 文件夹中。@prisma/client/index.d.ts 导出此文件夹的内容。

例如，上面 User 模型的类型定义如下所示。

export type User = {
  id: number
  email: string
  name: string | null
  role: string
}

请注意，关系字段 posts 和 profile 默认情况下不包含在类型定义中。但是，如果您需要 User 类型的变体，您仍然可以使用一些Prisma Client 的生成助手类型来定义它们（在这种情况下，这些助手类型将被称为 UserGetIncludePayload 和 UserGetSelectPayload）。

限制​

记录必须是唯一可识别的​

Prisma ORM 目前仅支持至少具有一个唯一字段或字段组合的模型。在实践中，这意味着每个 Prisma 模型都必须至少具有以下属性之一：

  • @id 或 @@id 用于单字段或多字段主键约束（每个模型最多一个）。
  • @unique 或 @@unique 用于单字段或多字段唯一约束。