Prisma

<div align="center"> <h1>Prisma</h1> <a href="https://www.npmjs.com/package/prisma"><img src="https://img.shields.io/npm/v/prisma.svg?style=flat" /></a> <a href="https://github.com/prisma/prisma/blob/main/CONTRIBUTING.md"><img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg" /></a> <a href="https://github.com/prisma/prisma/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-Apache%202-blue" /></a> <a href="https://pris.ly/discord"><img alt="Discord" src="https://img.shields.io/discord/937751382725886062?label=Discord"></a> <br /> <br /> <a href="https://www.prisma.io/docs/getting-started/quickstart">快速开始</a> <span>  •  </span> <a href="https://www.prisma.io/">网站</a> <span>  •  </span> <a href="https://www.prisma.io/docs/">文档</a> <span>  •  </span> <a href="https://github.com/prisma/prisma-examples/">示例</a> <span>  •  </span> <a href="https://www.prisma.io/blog">博客</a> <span>  •  </span> <a href="https://pris.ly/discord?utm_source=github&utm_medium=prisma&utm_content=repo_readme">Discord</a> <span>  •  </span> <a href="https://pris.ly/x?utm_source=github&utm_medium=prisma&utm_content=repo_readme">Twitter</a> <span>  •  </span> <a href="https://pris.ly/youtube?utm_source=github&utm_medium=prisma&utm_content=repo_readme">Youtube</a> <br /> <hr /> </div>

什么是 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 或任何其他需要数据库的东西。

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

快速开始

快速开始 (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 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 记录

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: 'Join us for Prisma Day 2021' },
    },
  },
})

更新现有的 Post 记录

const post = await 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)

MCP 服务器

Prisma CLI 包含一个 Prisma MCP 服务器。 它通过以下 CLI 命令启动：

npx prisma mcp

大多数 AI 工具都支持基于 JSON 的 MCP 服务器配置，如下所示：

{
  "mcpServers": {
    "Prisma": {
      "command": "npx",
      "args": ["-y", "prisma", "mcp"]
    }
  }
}

Prisma 的 MCP 服务器使 AI 代理能够管理 Prisma Postgres 数据库（例如，启动新的数据库实例或运行模式迁移）。

安全

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

支持

提出关于 Prisma 的问题

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

👉 提出问题

为 Prisma 创建错误报告

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

👉 创建错误报告

提交功能请求

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

如果路线图上的功能链接到 GitHub 问题，请务必在该问题上留下 👍 反应，最好留下评论，说明您对该功能的想法！

👉 提交功能请求

贡献

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

测试状态

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