Prisma 是什么?
Prisma ORM 是下一代 ORM ,由以下工具组成:
- Prisma Client :Node.js 和 TypeScript 的自动生成和类型安全查询构建器
- Prisma Migrate :声明式数据建模和迁移系统
- Prisma Studio :用于查看和编辑数据库中数据的 GUI
Prisma 客户端可用于任何Node.js 或 TypeScript 后端应用程序(包括无服务器应用程序和微服务)。这些应用程序可以是REST API 、 GraphQL API 、gRPC API 或任何其他需要数据库的 API。
如果您需要与 Prisma ORM 一起使用的数据库,请查看Prisma Postgres 。
入门
快速入门(5分钟)
开始使用 Prisma 的最快方法是遵循快速入门指南。您可以选择以下两个数据库之一:
自带数据库
如果您已经有自己的数据库,您可以遵循以下指南:
Prisma ORM 的工作原理
本节概述了 Prisma ORM 的工作原理及其最重要的技术组件。如需更详细的介绍,请访问Prisma 文档。
Prisma 架构
每个使用 Prisma 工具包工具的项目都以Prisma 模式文件开始。Prisma 模式允许开发人员使用直观的数据建模语言定义其应用程序模型。它还包含与数据库的连接并定义了一个生成器:
在此模式中,您可以配置三件事:
- 数据源:指定数据库连接(通过环境变量)
- Generator :表示要生成 Prisma Client
- 数据模型:定义您的应用程序模型
Prisma 数据模型
本页重点介绍数据模型。您可以在相应的文档页面上了解有关数据源和生成器的更多信息。
Prisma 模型的功能
数据模型是 模型的集合。一个模型主要有两大功能:
- 表示底层数据库中的表
- 为 Prisma Client API 中的查询提供基础
获取数据模型
将数据模型“获取”到 Prisma 模式中有两个主要工作流程:
- 通过检查数据库生成数据模型
- 使用Prisma Migrate手动编写数据模型并将其映射到数据库
定义数据模型后,即可生成 Prisma 客户端,它将公开已定义模型的 CRUD 和更多查询。如果您使用 TypeScript,则所有查询都将获得完全类型安全(即使仅检索模型字段的子集)。
使用 Prisma Client 访问数据库
生成 Prisma 客户端
使用 Prisma Client 的第一步是安装其 npm 包:
请注意,安装此软件包时会调用prisma generate
命令,该命令会读取你的 Prisma 模式并生成Prisma 客户端代码。代码位于node_modules/.prisma/client
中,该文件由node_modules/@prisma/client/index.d.ts
导出。
更改数据模型后,您需要手动重新生成 Prisma Client,以确保node_modules/.prisma/client
内的代码得到更新:
有关“生成 Prisma 客户端”的更多信息,请参阅文档。
使用 Prisma Client 向数据库发送查询
Prisma 客户端生成后,您可以将其导入代码并向数据库发送查询。设置代码如下所示。
导入并实例化 Prisma 客户端
您可以按如下方式导入并实例化 Prisma Client:
或者
现在,您可以开始通过生成的 Prisma 客户端 API 发送查询,以下是一些示例查询。请注意,所有 Prisma 客户端查询都返回普通的 JavaScript 对象。
了解有关Prisma Client 文档中可用操作的更多信息或观看此演示视频(2 分钟)。
从数据库中检索所有User
记录
在每个返回的User
对象中包含posts
关系
过滤所有包含"prisma"
Post
记录
在同一个查询中创建一个新的User
和一个新的Post
记录
更新现有的Post
记录
与 TypeScript 一起使用
请注意,使用 TypeScript 时,此查询的结果将被*静态类型化,*这样您就不会意外访问不存在的属性(并且任何拼写错误都会在编译时被捕获)。有关如何利用 Prisma Client 的生成类型的更多信息,请参阅文档中“生成类型的高级用法”页面。
社区
Prisma 拥有一个庞大且充满热情的应用程序开发者社区。您可以通过Discord和GitHub加入我们。
徽章
用 Prisma 打造了很棒的作品?🌟 用这些徽章来炫耀一下,非常适合放在你的 readme 文件或网站上。
MCP 服务器
Prisma CLI 包含一个Prisma MCP 服务器。它通过以下 CLI 命令启动:
大多数 AI 工具支持基于 JSON 的 MCP 服务器配置,如下所示:
Prisma 的 MCP 服务器使 AI 代理能够管理Prisma Postgres数据库(例如启动新的数据库实例或运行模式迁移)。
安全
如果您有安全问题需要报告,请通过security@prisma.io与我们联系。
支持
询问有关 Prisma 的问题
您可以在 GitHub 上的prisma
存储库中提出有关 Prisma 相关主题的问题并发起讨论。
👉提问
为 Prisma 创建错误报告
如果您看到错误消息或遇到问题,请务必创建错误报告!您可以在文档中找到创建错误报告的最佳实践(例如,添加额外的调试输出)。
提交功能请求
如果 Prisma 目前没有某个功能,请务必查看路线图,看看是否已经为未来做好了计划。
如果路线图上的功能与 GitHub 问题相关联,请务必对该问题留下👍反应,最好留下您对该功能的想法的评论!
👉 提交功能请求
贡献
测试状态
This server cannot be installed
local-only server
The server can only run on the client's local machine because it depends on local resources.
轻松管理 Prisma Postgres 数据库