新数据模型语法：更强的模式控制 & 更简单的迁移

⚠️ 本文已过时，因为它与 Prisma 1 有关，而 Prisma 1 现已弃用。 要了解有关最新版本的 Prisma 的更多信息，请阅读文档。 ⚠️

在过去的几个月中，我们与社区合作定义了一个改进的 datamodel specification for Prisma。这个新版本称为 datamodel v1.1，并且在今天的稳定版本中可用。查看文档这里。

截至今天，Prisma的公共演示服务器将使用新的数据模型语法。查看文档 或本 教程视频 了解如何升级现有项目。

---

一种更灵活的数据建模方法

数据模型 是每个 Prisma 项目的基础。它充当基础数据库模式的基础。

当前的数据模型对数据库布局有主观性，例如，对于关系、表/列的命名或系统字段。新的数据模型语法消除了许多限制，因此开发人员可以更好地控制其模式。

更好地控制你的数据库布局

以下是新的数据模型语法启用的一些功能

• 指定关系应使用关系表还是外键
• 模型/字段名称可以与基础表/列的名称不同
• 使用任何字段作为 id 字段并“自带 ID”
• 使用任何字段作为 createdAt 或 updatedAt 字段

更简单的迁移 & 改进的内省

在以前的 Prisma 版本中，开发人员必须决定是否让 Prisma 为他们执行数据库迁移，方法是在 PRISMA_CONFIG 中设置 migrations 标志。

最新的 Prisma 版本中已删除 migrations 标志，这意味着开发人员现在始终可以手动迁移数据库或使用 Prisma 进行迁移。

我们还在现有数据库的内省方面投入了大量资金，从而为使用 Prisma 的开发人员提供了流畅的工作流程，他们需要使用旧版数据库或需要在某个时候执行手动迁移。

---

改进的数据模型语法中的新增功能？

将模型和字段名称映射到基础表和列

使用旧的数据模型语法，表和列始终完全按照数据模型中的模型和字段命名。使用新的 @db 指令，你可以控制在基础数据库中应调用哪些表和列

在这种情况下，基础表将称为 user，列将称为 full_name。

决定关系如何在数据库模式中表示

旧的数据模型对数据库模式中的关系有主观性：它们始终表示为关系表。

一方面，这使得可以轻松地将任何现有关系迁移到多对多关系，而无需额外的工作。但是，对于这种灵活性，可能会付出性能代价，因为关系表的查询通常更昂贵。

虽然 1:1 和 1:n 关系现在可以通过外键表示，但 m:n 关系将继续表示为关系表。

使用新的数据模型，开发人员可以完全控制在基础数据库中表达关系。有两种选择

• 通过内联引用（即外键）表示关系
• 通过关系表表示关系

这是一个带有两个关系的示例（一个是内联，另一个使用关系表）

对于内联关系，@relation(link: INLINE) 指令的位置决定了外键存储在关系的哪一端，在此示例中，它存储在 User 表中。

使用任何字段作为 id、createdAt 或 updatedAt

使用旧的数据模型，如果开发人员希望自动生成唯一 ID 或跟踪记录的创建/上次更新时间，则必须使用保留字段。

使用新的 @id、@createdAt 和 @updatedAt 指令，现在可以将此功能添加到模型的任何字段

更灵活的 ID

当前的数据模型始终使用 CUID 来生成和存储数据库记录的全局唯一 ID。 数据模型 v1.1 现在可以维护自定义 ID 以及使用其他 ID 类型（例如，整数、序列或 UUID）。

---

开始使用新的数据模型语法

我们为你准备了两个简短的教程，以探索新的数据模型

• 选项 A: 升级旧的 Prisma 项目 到新的数据模型语法
• 选项 B: 从头开始 使用新的数据模型语法

有关使用现有数据库的更多详细教程和说明，请访问文档。

前提条件：安装最新的 Prisma CLI

要安装最新版本的 Prisma CLI，请运行

当使用 Docker 运行 Prisma 时，你需要将其 Docker 镜像升级到 1.31。

选项 A: 从旧的 Prisma 版本升级

升级现有 Prisma 项目时，你可以简单地运行 prisma introspect 来生成具有新语法的数据模型。以下部分中的示例和此视频中描述了确切的过程

1. 旧的数据模型设置

假设你已经有一个使用（旧）数据模型的正在运行的 Prisma 项目。

2. 升级你的 Prisma 服务器

在用于部署你的 Prisma 服务器的 Docker Compose 文件中，请确保为 prismagraphql/prisma 镜像使用最新的 1.31 Prisma 版本。 例如

现在升级正在运行的 Prisma 服务器

3. 通过内省生成新的数据模型

如果你现在运行 prisma deploy，你的 Prisma CLI 将抛出一个错误，因为你正试图将使用旧语法的数据模型部署到已更新的 Prisma 服务器。

解决这些错误的最简单方法是通过内省生成一个使用新语法编写的数据模型。 在你的 prisma.yml 所在的目录中运行以下命令

这将内省你的数据库并生成另一个使用新语法的数据模型，称为 datamodel-TIMESTAMP.prisma（例如 datamodel-1554394432089.prisma）。 对于上面的例子，将生成以下数据模型

4. 部署新的数据模型

最后一步是删除旧的 datamodel.prisma 文件，并将生成的数据模型重命名为 datamodel.prisma（以便 prisma.yml 中的 datamodel 属性指向使用新语法的生成文件）。

完成后，你可以运行

5. 优化你的数据库模式

因为内省没有改变你的数据库布局，所以所有的关系仍然表示为关系表。 如果你想了解如何迁移旧的 1:1 和 1:n 关系以使用外键，请查看此处的文档。

选项 B: 从头开始

在学习了如何升级现有的 Prisma 项目之后，我们将带你完成一个简单的设置，我们从头开始。

1. 创建一个新的 Prisma 项目

让我们首先设置一个新的 Prisma 项目

在交互式向导中，选择以下内容

1. 选择创建新数据库
2. 选择PostgreSQL（或 MySQL，如果你喜欢）
3. 以你喜欢的语言选择一个客户端（可选，因为我们不会使用客户端）

在通过 Docker 启动 Prisma 服务器和数据库之前，为你的数据库启用端口映射。 这将允许你稍后使用本地数据库客户端（例如 Postico 或 TablePlus）连接到数据库。

在生成的 docker-compose.yml 中，取消注释数据库的 Docker 镜像配置中的以下行

2. 定义数据模型

让我们定义一个利用新的 Prisma 功能的数据模型。 打开 datamodel.prisma 并将内容替换为以下内容

以下是关于此数据模型定义的一些重要信息

• 每个模型都映射到一个表，该表的名称与模型相同，但使用 @db 指令小写。
• 有以下关系
  • 1:1 User 和 Profile 之间
  • 1:n User 和 Post 之间
  • n:m Post 和 Category 之间
• User 和 Profile 之间的1:1 关系使用 @relation(link: INLINE) 在 User 模型上进行注释。 这意味着如果关系存在，数据库中的 user 记录具有对 profile 记录的引用（因为 profile 字段不是必需的，关系可能只是 NULL）。 INLINE 的替代方法是 TABLE，在这种情况下，Prisma 将通过专用的关系表跟踪关系。
• User 和 Post 之间的1:n 关系通过 post 表的 author 列内联跟踪关系，即 @relation(link: INLINE) 指令是在 Post 模型的 author 字段上推断出来的。
• Post 和 Category 之间的n:m 关系通过名为 PostToCategory 的专用关系表跟踪。 此关系表是数据模型的一部分，并使用 @relationTable 指令进行注释。
• 每个模型都有一个使用 @id 指令注释的 id 字段。
• 对于 User 模型，数据库会自动跟踪何时通过使用 @createdAt 指令注释的字段创建记录。
• 对于 Post 模型，数据库会自动跟踪何时通过使用 @createdAt 和 @updatedAt 指令注释的字段创建和更新记录。

3. 部署数据模型

在下一步中，Prisma 会将此数据模型映射到底层数据库

4. 在 Prisma Admin 中查看和编辑数据

从现在开始，如果你想以编程方式访问数据库中的数据，可以使用Prisma 客户端。 下面，我们将重点介绍如何使用 Prisma Admin 与数据进行交互。

访问文档以了解如何使用 TablePlus 连接到数据库并浏览底层数据库模式。

要在Prisma Admin中访问你的数据，你需要导航到你的 Prisma 项目的管理终端节点：http://localhost:4466/_admin

---

分享你的反馈和想法

虽然新的数据模型语法已经包含了我们社区要求的许多功能，但我们仍然看到了进一步改进它的机会。 例如，数据模型尚未提供多列索引和多态关系。

我们目前正在开发一种新的数据建模语言，它将是当前使用的SDL的变体。

我们很乐意听取你对新数据模型的看法。 请通过在反馈仓库中打开一个 issue 或加入Spectrum上的对话来分享你的反馈。