去年六月,我们推出了 Prisma 2.0 的首个预览版本。今天,我们很高兴推出第一个官方 Beta 版,同时发布了新的网站和更新后的Prisma 2.0 文档。
更新: Prisma 现在已准备好用于生产环境。请阅读公告文章了解更多信息:用于 Node.js 和 TypeScript 的完整 ORM。
目录
- 使用 Prisma Client 2.0 进行现代数据库访问
- 此版本包含哪些内容?
- 将
prisma2
存储库重命名为prisma
- 重命名
prisma2
CLI - 我目前正在使用 Prisma 1;我该怎么办?
- 试用 Prisma 2.0 并分享你的反馈
TL;DR
- Prisma 2.0 Beta 版已准备就绪。凭借新的网站和文档,它现在是新开发人员开始使用 Prisma 的默认选择。
- Prisma 2.0 主要由 Prisma Client 组成,它是为 Node.js 和 TypeScript 自动生成且类型安全的查询构建器。Prisma Migrate 被认为是实验性的。
prisma/prisma2
存储库已重命名为prisma/prisma
(并且以前的 Prisma 1 存储库prisma/prisma
存储库现在称为prisma/prisma1
)。
通过遵循新文档中的快速上手,在 5 分钟内试用新的 Prisma Client。
使用 Prisma Client 2.0 进行现代数据库访问
新版本的 Prisma Client 是一个适用于 Node.js 和 TypeScript 的现代数据库访问库。它可以替代传统的 ORM 和 SQL 查询构建器,用于读取和写入数据库中的数据。
要进行设置,你需要一个Prisma 架构文件,并且必须将 Prisma Client 作为依赖项添加到你的项目中
Prisma Client 可用于任何 Node.js 或 TypeScript 后端应用程序(包括无服务器应用程序和微服务)。这可以是REST API、GraphQL API、gRPC API 或任何其他需要数据库的应用程序。
使用数据库提高工作效率
Prisma Client 的主要目标是提高应用程序开发人员在使用数据库时的生产力。它通过提供一个干净的数据访问 API 来实现这一点,该 API 返回普通的 JavaScript 对象。
这种方法可以更简单地推断数据库查询,并提高对可预测(且类型安全)的查询结果的信心。以下是 Prisma Client 提供的一些主要好处
- 代码编辑器中的自动完成,无需查找文档
- 以对象为单位进行思考,而不是映射关系数据
- 可在编译时验证的类型安全数据库查询
- 数据库和应用程序模型的单一事实来源
- 防止常见陷阱和反模式的健康约束
- 使正确的事情变得容易的抽象(“成功之坑”)
- 避免复杂的模型对象的查询而不是类
- 更少的样板代码,因此开发人员可以专注于应用程序的重要部分
在简介中了解有关 Prisma 如何提高开发人员生产力的更多信息,或者通过查看网站上的代码示例来了解 Prisma Client API 的用法。
一个“智能”节点模块 🤓
@prisma/client
模块与“传统”节点模块不同。使用传统的节点模块(例如,lodash
),整个包将下载到你的 node_modules
目录中,并且仅在你重新安装该包时才会更新。
@prisma/client
节点模块不同。它是一个“外观包”(基本上是一个存根),其中不包含任何功能代码。
虽然你确实需要使用 npm install @prisma/client
安装它一次,但是当你开发你的应用程序时,node_modules/@prisma/client
目录中的代码很可能会更频繁地更改。这是因为,每当你更改 Prisma 架构时,你需要重新生成 Prisma Client,这将更新 @prisma/client
节点模块中的代码。
因为 node_modules/@prisma/client
目录包含一些针对你的项目量身定制的代码,因此有时被称为“智能节点模块”
即使在普通 JavaScript 中也能获得自动完成和类型安全的好处
自动完成对于开发人员来说是一个非常强大的工具。它允许他们直接在编辑器中探索 API,而无需查阅文档。Prisma Client 为你的数据库查询带来了自动完成功能!
由于 Prisma Client 生成的类型包含在 @prisma/client
模块的 index.d.ts
中,因此此功能不仅适用于 TypeScript 开发人员,而且也适用于使用普通 JavaScript 开发应用程序时。
部分数据库查询的类型安全
与其他 ORM 和数据库工具相比,Prisma Client 的一个主要好处是,它提供完全的类型安全,即使对于“部分”数据库查询(即,当你只查询模型的字段子集或包含关系时)。
例如,考虑以下 Prisma Client 查询(你可以切换选项卡以查看相应的Prisma 模型)
请注意,生成的 usersWithPartialPosts
将被静态类型化为
这意味着当你输入错误或意外访问未从数据库请求的属性时,TypeScript 将捕获任何错误!
入门
开始使用 Prisma Client 的最佳方式是遵循文档中的快速入门
快速入门 (5 分钟)
或者,你可以
此版本包含什么?
Prisma 2.0 Beta 版本包含以下工具
- Prisma Client:为 Node.js 和 TypeScript 自动生成的类型安全查询构建器
- Prisma Migrate (实验性):声明式模式迁移工具
- Prisma Studio (实验性):用于查看和编辑数据库中数据的 GUI
通过遵循新文档中的快速上手,在 5 分钟内试用新的 Prisma Client。
注意:在发行说明中了解有关 Beta 版本的更多信息。
将 prisma2
存储库重命名为 prisma
自最初发布以来,Prisma 2.0 的主存储库一直被称为 prisma2
。
由于 Prisma 2.0 现在是开始使用 Prisma 的开发人员的默认选择,因此 Prisma 存储库已按如下方式重命名
prisma/prisma2
存储库已重命名为prisma/prisma
prisma/prisma
存储库已重命名为prisma/prisma1
重命名 prisma2
CLI
在预览期间,Prisma 2.0 的 CLI 使用 prisma2
命令调用。由于 Prisma 2.0 是新开发人员开始使用 Prisma 的默认选择,因此该命令已更改为仅 prisma
。现有的 Prisma 1 的 prisma
命令已重命名为 prisma1
。
另请注意,npm 包的安装方式发生了变化
Prisma 版本 | 旧的 CLI 命令 | 新的 CLI 命令 | 旧的 npm 包名称 | 新的 npm 包名称 |
---|---|---|---|---|
2.0 | prisma2 | prisma | prisma2 | @prisma/cli |
1.X | prisma | prisma1 | prisma | prisma1 |
给当前 Prisma 1 用户的提示
如果您目前正在使用带有 prisma
命令的 Prisma 1,您可以像以前一样继续使用它。如果您想升级到 Prisma 2.0,建议卸载当前 prisma
安装,并在需要它们的项目中本地安装新的 CLI 版本
prisma2
npm 包已弃用
prisma2
npm 包现已弃用。为了防止安装期间出现混淆,当您尝试安装它时,它现在会输出以下内容
我目前使用 Prisma 1;我该怎么办?
首先,我们要非常感谢所有现有的 Prisma 1 用户!🙏 我们非常感谢在 GitHub 和 Slack 上形成的强大支持和活跃的社区!
Prisma 2.0 与 Prisma 1 相比如何?
与 Prisma 1 相比,Prisma 2.0 带来了一些变化。以下是主要差异的高级概述
- Prisma 2.0 不需要托管数据库代理服务器(即 Prisma 服务器)。
- Prisma 2.0 不再公开“数据库的 GraphQL API”,而仅允许通过 Prisma Client API 进行程序化访问。
- Prisma 2.0 使 Prisma 1 的功能更加模块化,并将其拆分为专用工具
- Prisma Client:Prisma 客户端 1.0 的改进版本
- Prisma Migrate:数据建模和迁移(以前为
prisma deploy
)。
- 更强大的内省功能允许将 Prisma 2.0 连接到任何现有数据库。
- Prisma 1 数据模型和
prisma.yml
已合并到 Prisma 模式中。 - Prisma 2.0 使用自己的建模语言,而不是基于 GraphQL SDL。
- 您可以使用 Nexus 或您选择的任何其他 GraphQL 库来构建带有 Prisma 的 GraphQL 服务器。
如何访问 Prisma 1 文档?
您可以通过在 https://prisma.org.cn/docs
后附加版本号来继续访问 Prisma 1 文档的特定版本。例如,要查看 Prisma 1.34 版本的文档,您可以访问 https://v1.prisma.io/docs/1.34/
。
Prisma 1 示例已移动到 prisma1-examples
存储库。
我应该升级吗?
您是否应该升级取决于您的项目上下文。总的来说,一个主要的考虑因素是 Prisma Migrate 仍然是实验性的。这意味着您可能需要使用 SQL 或其他迁移工具对数据库模式进行任何未来的调整。
另请注意,我们将在未来几周内整理升级指南以及专用工具,以进行升级过程。因此,如果您确实想升级,尽管 Prisma Migrate 尚未准备就绪,但可能值得等待这些资源到位。
我将 Prisma 1 与 Prisma 客户端和 nexus-prisma
一起使用,我应该升级吗?
当然可以将运行在 Prisma 1 和 nexus-prisma
上的项目升级到 Prisma 2.0。
如果您决定升级,请注意,在升级到 Prisma 2.0 后更改数据库模式,将需要使用 SQL 或第三方迁移工具运行迁移。另外请注意,nexus-prisma
API 会随着 Prisma 2.0 的变化而改变。
以下是升级所需步骤的高级概述
- 在您的项目中安装 Prisma 2.0 CLI:
npm install @prisma/cli --save-dev
- 使用指向您的 Prisma 1 数据库的
datasource
创建 Prisma 模式 - 内省您的 Prisma 1 数据库以获取您的数据模型:
npx prisma introspect
- 安装 Prisma Client npm 包:
npm install @prisma/client
- 生成 Prisma Client JS:
npx prisma generate
- 升级到最新版本的
nexus-prisma
并调整您的解析器。
注意:您可以在用于部署 Prisma 服务器的 Docker Compose 文件中找到您的数据库凭据。需要这些凭据来构成 Prisma 2.0 的连接 URL。
我将 Prisma 1 与 Prisma 客户端(没有 nexus-prisma
)一起使用,我应该升级吗?
当然可以将运行在 Prisma 1 上的项目升级。
如果您决定升级,请注意在升级到 Prisma 2.0 后更改数据库模式将需要使用 SQL 或第三方迁移工具运行迁移。以下是升级所需步骤的高级概述
- 导航到您的项目目录
- 在您的项目中安装 Prisma 2.0 CLI:
npm install @prisma/cli --save-dev
- 使用指向您的 Prisma 1 数据库的
datasource
创建 Prisma 模式 - 内省您的 Prisma 1 数据库以获取您的数据模型:
npx prisma introspect
- 安装 Prisma Client npm 包:
npm install @prisma/client
- 生成 Prisma Client JS:
npx prisma generate
- 将您之前使用的 Prisma 客户端 1.0 更新为新的 Prisma 客户端 2.0
注意:您可以在用于部署 Prisma 服务器的 Docker Compose 文件中找到您的数据库凭据。需要这些凭据来构成 Prisma 2.0 的连接 URL。
我将 Prisma 1 与 prisma-binding
一起使用,我应该升级吗?
当然可以将运行在 Prisma 1 和 prisma-binding
上的项目升级到 Prisma 2.0。
如果您决定升级,请注意在升级到 Prisma 2.0 后更改数据库模式将需要使用 SQL 或第三方迁移工具运行迁移。
另请注意,GraphQL 解析器的实现方式会随着 Prisma 2.0 的变化而改变。由于 Prisma 2.0 不会为您的数据库公开 GraphQL API,因此您不能再使用 prisma-binding
npm 包。这主要与实现关系有关,这些关系的解析器现在需要在类型级别上实现。要了解更多关于为什么这是必要的,请务必阅读这篇关于 GraphQL 模式基础知识的文章。
以下是升级所需步骤的高级概述
- 在您的项目中安装 Prisma 2.0 CLI:
npm install @prisma/cli --save-dev
- 使用指向您的 Prisma 1 数据库的
datasource
创建 Prisma 模式 - 内省您的 Prisma 1 数据库以获取您的数据模型:
npx prisma introspect
- 安装 Prisma Client npm 包:
npm install @prisma/client
- 生成 Prisma Client JS:
npx prisma generate
- 调整您的解析器以使用 Prisma 客户端,而不是
prisma-binding
如果您想切换到代码优先方法,请查看 GraphQL Nexus。
注意:您可以在用于部署 Prisma 服务器的 Docker Compose 文件中找到您的数据库凭据。需要这些凭据来构成 Prisma 2.0 的连接 URL。
试用 Prisma 2.0 并分享您的反馈
我们非常高兴最终能分享 Prisma 2.0 的 Beta 版本,并迫不及待地想看看大家用它构建什么。
开始使用 Prisma 2.0
如果您想留下反馈、分享想法、创建功能请求或提交错误报告,请在 GitHub 上(已重命名的)prisma
存储库中进行,并加入 Prisma Slack上的(已重命名的)#prisma2-beta
频道!
不要错过下一篇文章!
注册 Prisma 新闻通讯