prisma

Prisma

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

Prisma是什么？

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

Prisma Client：为Node.js和TypeScript自动生成的类型安全查询构建器
Prisma Migrate：声明式数据建模和迁移系统
Prisma Studio：用于查看和编辑数据库中数据的图形界面

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

Prisma ORM还可以通过以下Prisma产品进行扩展：

Prisma Accelerate：具有可扩展连接池的全局数据库缓存
Prisma Pulse：具有类型安全订阅的实时数据库事件

入门

开始使用Prisma最快的方法是按照快速入门（5分钟）进行操作。

快速入门基于预配置的SQLite数据库。您也可以通过以下指南之一开始使用自己的数据库（PostgreSQL和MySQL）：

Prisma如何工作

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

Prisma架构

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

// 数据源
datasource db {
  provider = "postgresql"
  url      = env("DATABASE_URL")
}

// 生成器
generator client {
  provider = "prisma-client-js"
}

// 数据模型
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 Client
数据模型：定义您的应用程序模型

Prisma数据模型

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

Prisma模型的功能

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

代表底层数据库中的表
为Prisma Client API中的查询提供基础

获取数据模型

有两种主要的工作流程可以将数据模型"获取"到您的Prisma架构中：

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

一旦定义了数据模型，您就可以生成Prisma Client，它将为定义的模型公开CRUD和更多查询。如果您使用TypeScript，您将获得所有查询的完全类型安全（即使只检索模型字段的子集）。

使用Prisma Client访问您的数据库

生成Prisma Client

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

npm install @prisma/client

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

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

npx prisma generate

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

使用Prisma Client向数据库发送查询

生成Prisma Client后，您可以在代码中导入它并向数据库发送查询。以下是设置代码的样子。

导入和实例化Prisma Client

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

import { PrismaClient } from '@prisma/client'

const prisma = new PrismaClient()

或者

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

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

在 Prisma Client 文档中了解更多关于可用操作的信息，或观看这个演示视频（2分钟）。

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

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

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

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

筛选包含 `"prisma"` 的所有 `Post` 记录

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

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

// 在 `async` 函数内运行
const user = await prisma.user.create({
  data: {
    name: 'Alice',
    email: 'alice@prisma.io',
    posts: {
      create: { title: '加入我们参加2021年Prisma日' },
    },
  },
})

更新现有的 `Post` 记录

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

与TypeScript一起使用

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

社区

Prisma拥有一个庞大且支持性强的热情应用开发者社区。您可以在Discord和这里的GitHub上加入我们。

安全

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

支持

询问关于Prisma的问题

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

👉 提问

为Prisma创建错误报告

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

👉 创建错误报告

提交功能请求

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

如果路线图上的功能已链接到GitHub issue，请务必在该issue上留下👍反应，最好还能发表评论说明您对该功能的看法！

👉 提交功能请求

贡献

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

测试状态

Prisma测试状态：
生态系统测试状态：