prisma

棱镜

快速入门 • 网站 • 文档 • 示例 • 博客 • Discord • Twitter

---

什么是棱镜？

Prisma ORM 是下一代 ORM ，由以下工具组成：

• Prisma Client ：适用于 Node.js 和 TypeScript 的自动生成且类型安全的查询构建器

• Prisma Migrate ：声明式数据建模和迁移系统

• Prisma Studio ：用于查看和编辑数据库中数据的 GUI

Prisma Client 可在任何Node.js 或 TypeScript 后端应用程序（包括无服务器应用程序和微服务）中使用。这可以是 REST API、GraphQL API、gRPC API 或任何其他需要数据库的 API。

如果您需要与 Prisma ORM 一起使用的数据库，请查看 Prisma Postgres。

Prisma ORM 可以通过以下 Prisma 产品进一步扩展：

• Prisma Accelerate：具有可扩展连接池的全局数据库缓存

• Prisma Pulse：具有类型安全订阅的实时数据库事件

• Prisma Optimize：人工智能驱动的查询优化和性能洞察

• Prisma Studio：数据库中数据的可视化编辑器

入门

快速入门（5 分钟）

开始使用 Prisma 的最快方法是遵循快速入门指南。您可以选择以下两个数据库之一：

• Prisma Postgres

• SQLite

自带数据库

如果您已经拥有自己的数据库，则可以遵循以下指南：

• 将 Prisma 添加到现有项目

• 从头开始使用 Prisma 建立一个新项目

Prisma ORM 的工作原理

本节提供了 Prisma ORM 的工作原理及其最重要的技术组件的高级概述。如需更全面的介绍，请访问 Prisma 文档。

Prisma 架构

每个使用 Prisma 工具包中的工具的项目都以 Prisma 架构文件开始。 Prisma 架构允许开发人员以直观的数据建模语言定义其应用程序模型。它还包含与数据库的连接并定义了一个生成器：

 // 数据源datasource db {provider = "postgresql" url = env("DATABASE_URL")}// Generator生成器客户端{provider = "prisma-client-js"}//数据模型model Post { id Int @id @default(autoincrement(autoincrement( )) 标题字符串 内容字符串？  已发布 布尔值 @default(false) 作者 用户？   @relation（字段：[authorId]，引用：[id]）authorId Int？}模型用户{ id Int @id @default（autoincrement（））电子邮件字符串@唯一名称字符串？  帖子 帖子[]}

在此架构中，您配置三件事：

• 数据源：指定您的数据库连接（通过环境变量）

• Generator ：表示要生成Prisma Client

• 数据模型：定义您的应用程序模型

---

Prisma 数据模型

在此页面上，重点是数据模型。您可以在相应的文档页面上了解有关数据源和生成器的更多信息。

Prisma 型号的功能

数据模型是模型的集合。模型有两个主要功能：

• 代表底层数据库中的一张表

• 为 Prisma 客户端 API 中的查询提供基础

获取数据模型

将数据模型“获取”到 Prisma 架构中有两个主要工作流程：

• 通过内省数据库生成数据模型

• 手动编写数据模型并使用 Prisma Migrate 将其映射到数据库

定义数据模型后，您可以生成 Prisma 客户端，它将公开 CRUD 和对定义的模型的更多查询。如果您使用 TypeScript，您将获得所有查询的完整类型安全性（即使仅检索模型字段的子集）。

---

使用 Prisma 客户端访问您的数据库

生成 Prisma 客户端

使用 Prisma Client 的第一步是安装其 npm 包：

npm install @prisma/client

请注意，此软件包的安装会调用prisma generate命令，该命令会读取您的 Prisma 架构并生成Prisma 客户端代码。该代码将位于node_modules/.prisma/client中，由node_modules/@prisma/client/index.d.ts导出。

更改数据模型后，您需要手动重新生成 Prisma Client 以确保node_modules/.prisma/client内的代码得到更新：

npx prisma generate

有关“生成 Prisma 客户端”的更多信息，请参阅文档。

使用 Prisma 客户端向数据库发送查询

生成 Prisma 客户端后，您可以将其导入代码中并向数据库发送查询。这就是设置代码的样子。

导入并实例化 Prisma 客户端

您可以按如下方式导入并实例化 Prisma Client：

从 '@prisma/client' 导入 { PrismaClient } const prisma = new PrismaClient()

或者

const { PrismaClient } = require('@prisma/client')const prisma = new PrismaClient()

现在您可以开始通过生成的 Prisma 客户端 API 发送查询，以下是一些示例查询。请注意，所有 Prisma 客户端查询都会返回普通的旧 JavaScript 对象。

了解有关 Prisma 客户端文档中可用操作的更多信息或观看此演示视频（2 分钟）。

从数据库中检索所有User记录

// 在 `async` 函数中运行 const allUsers = wait prisma.user.findMany()

在每个返回的User对象上包含posts关系

// 在 `async` 函数中运行 const allUsers = wait prisma.user.findMany({ include: { posts: true },})

过滤所有包含"prisma" Post记录

// 在 `async` 函数中运行 const FilteredPosts = wait prisma.post.findMany({ where: { OR: [{ title: { contains: 'prisma' } }, { content: { contains: 'prisma' } }], } ,})

在同一查询中创建新User和新Post记录

// 在 `async` 函数中运行 const user = wait prisma.user.create({ data: { name: 'Alice', email: '[email protected]', posts: { create: { title: '加入我们的 Prisma 2021 年' }, }, },})

更新现有的Post记录

// 在 `async` 函数中运行 const post = wait prisma.post.update({ where: { id: 42 }, data: {published: true },})

与 TypeScript 一起使用

请注意，使用 TypeScript 时，此查询的结果将是静态类型的，这样您就不会意外访问不存在的属性（并且在编译时捕获任何拼写错误）。在文档中生成类型的高级用法页面上了解有关利用 Prisma Client 生成类型的更多信息。

社区

Prisma 拥有一个由热情的应用程序开发人员组成的庞大且支持性的社区。您可以在 Discord 和 GitHub 上加入我们。

徽章

用 Prisma 打造了一些很棒的东西？ ？用这些徽章展示它，非常适合您的自述文件或网站。

[![Made with Prisma](http://made-with.prisma.io/dark.svg)](https://prisma.io)

[![Made with Prisma](http://made-with.prisma.io/indigo.svg)](https://prisma.io)

安全

如果您有安全问题需要报告，请通过 [email protected] 联系我们。

支持

询问关于 Prisma 的问题

您可以在 GitHub 上的prisma存储库中提出有关 Prisma 相关主题的问题并发起讨论。

？问一个问题

为 Prisma 创建错误报告

如果您看到错误消息或遇到问题，请务必创建错误报告！您可以在文档中找到创建错误报告（例如包括附加调试输出）的最佳实践。

？创建错误报告

提交功能请求

如果 Prisma 目前没有某个功能，请务必查看路线图，看看未来是否已计划好。

如果路线图上的功能链接到 GitHub 问题，请确保留下 ?对这个问题的反应，最好是包含您对该功能的想法的评论！

？提交功能请求

贡献

请参阅我们的贡献指南和贡献者行为准则。

测试状态

• Prisma 测试状态：
  

• 生态系统测试状态：