什么是 Prisma？

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；如果您正在寻找我们的 MCP 服务器，请访问 此处。

入门

快速入门（5 分钟）

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

• Prisma Postgres
• SQLite

自带数据库

如果您已经拥有自己的数据库，可以按照以下指南操作：

• 将 Prisma 添加到现有项目
• 使用 Prisma 从头开始​​创建新项目

Prisma ORM 的工作原理

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

Prisma Schema

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

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

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

// Data model
model Post {
  id        Int     @id @default(autoincrement())
  title     String
  content   String?
  published Boolean @default(false)
  author    User?   @relation(fields:  [authorId], references: [id])
  authorId  Int?
}

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

在此架构中，您需要配置三项内容：

• 数据源：指定您的数据库连接（通过环境变量）
• 生成器：指示您要生成 Prisma 客户端
• 数据模型：定义您的应用程序模型

Prisma 数据模型

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

Prisma 模型的功能

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

• 表示底层数据库中的表
• 为 Prisma 客户端 API 中的查询提供基础

获取数据模型

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

• 通过 自检 数据库生成数据模型
• 手动编写数据模型并使用 Prisma Migrate 将其映射到数据库

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

使用 Prisma 客户端访问数据库

生成 Prisma 客户端

使用 Prisma 客户端的第一步是安装其 npm 包：

npm install @prisma/client

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

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

npx prisma generate

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

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

Prisma 客户端生成后，您可以将其导入代码并向数据库发送查询。设置代码如下所示。

导入并实例化 Prisma 客户端

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

import { PrismaClient } from '@prisma/client'

const prisma = new PrismaClient()

or

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

const prisma = new PrismaClient()

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

请参阅 Prisma 客户端文档 或观看此 演示视频（2 分钟），详细了解可用的操作。

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

const allUsers = await prisma.user.findMany()

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

const allUsers = await prisma.user.findMany({
include: { posts: true },
})

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

const filteredPosts = await prisma.post.findMany({
where: {
OR: [{ title: { contains: 'prisma' } }, { content: { contains: 'prisma' } }],
},
})

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

const user = await prisma.user.create({
data: {
name: 'Alice',
email: 'alice@prisma.io',
posts: {
create: { title: '加入我们参加 2021 年 Prisma Day' },
},
},
})

更新现有的 Post 记录

const post = await prisma.post.update({
where: { id: 42 },
data: { published: true },
})

与 TypeScript 结合使用

请注意，使用 TypeScript 时，此查询的结果将是_静态类型_的，这样您就不会意外访问不存在的属性（任何拼写错误都会在编译时被捕获）。欲了解更多关于如何利用 Prisma 客户端的生成类型，请参阅文档中生成类型的高级用法页面。

社区

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

安全

如果您有安全问题需要报告，请通过 security@prisma.io 与我们联系。

支持

咨询 Prisma 相关问题

您可以在 GitHub 上的 prisma 代码库中咨询并发起有关 Prisma 相关主题的讨论。

👉 提问

为 Prisma 创建错误报告

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

👉 创建错误报告

提交功能请求

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

如果路线图上的功能与 GitHub 问题相关，请务必在该问题上留下👍回复，最好在评论中分享您对该功能的看法！

👉 提交功能请求

贡献

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