棱镜

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

什么是棱镜？

Prisma 是下一代 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 产品进一步扩展：

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

入门

开始使用 Prisma 的最快方法是遵循快速入门（5 分钟）。

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

Prisma 的工作原理

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

Prisma 架构

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

// 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[]
}

  <svg aria-hidden="true" height="16" viewBox="0 0 16 16" version="1.1" width="16" data-view-component="true" class="octicon octicon-copy js-clipboard-copy-icon">
<path d="M0 6.75C0 5.784.784 5 1.75 5h1.5a.75.75 0 0 1 0 1.5h-1.5a.25.25 0 0 0-.25.25v7.5c0 .138.112.25.25.25h7.5a.25.25 0 0 0 .25-.25v-1.5a.75.75 0 0 1 1.5 0v1.5A1.75 1.75 0 0 1 9.25 16h-7.5A1.75 1.75 0 0 1 0 14.25Z"></path><path d="M5 1.75C5 .784 5.784 0 6.75 0h7.5C15.216 0 16 .784 16 1.75v7.5A1.75 1.75 0 0 1 14.25 11h-7.5A1.75 1.75 0 0 1 5 9.25Zm1.75-.25a.25.25 0 0 0-.25.25v7.5c0 .138.112.25.25.25h7.5a.25.25 0 0 0 .25-.25v-7.5a.25.25 0 0 0-.25-.25Z"></path>

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

数据源：指定您的数据库连接（通过环境变量）
Generator：表示要生成Prisma Client
数据模型：定义您的应用程序模型

Prisma 数据模型

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

Prisma 型号的功能

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

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

获取数据模型

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

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

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

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

生成 Prisma 客户端

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

npm install @prisma/client

  <svg aria-hidden="true" height="16" viewBox="0 0 16 16" version="1.1" width="16" data-view-component="true" class="octicon octicon-copy js-clipboard-copy-icon">
<path d="M0 6.75C0 5.784.784 5 1.75 5h1.5a.75.75 0 0 1 0 1.5h-1.5a.25.25 0 0 0-.25.25v7.5c0 .138.112.25.25.25h7.5a.25.25 0 0 0 .25-.25v-1.5a.75.75 0 0 1 1.5 0v1.5A1.75 1.75 0 0 1 9.25 16h-7.5A1.75 1.75 0 0 1 0 14.25Z"></path><path d="M5 1.75C5 .784 5.784 0 6.75 0h7.5C15.216 0 16 .784 16 1.75v7.5A1.75 1.75 0 0 1 14.25 11h-7.5A1.75 1.75 0 0 1 5 9.25Zm1.75-.25a.25.25 0 0 0-.25.25v7.5c0 .138.112.25.25.25h7.5a.25.25 0 0 0 .25-.25v-7.5a.25.25 0 0 0-.25-.25Z"></path>

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

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

npx prisma generate

  <svg aria-hidden="true" height="16" viewBox="0 0 16 16" version="1.1" width="16" data-view-component="true" class="octicon octicon-copy js-clipboard-copy-icon">
<path d="M0 6.75C0 5.784.784 5 1.75 5h1.5a.75.75 0 0 1 0 1.5h-1.5a.25.25 0 0 0-.25.25v7.5c0 .138.112.25.25.25h7.5a.25.25 0 0 0 .25-.25v-1.5a.75.75 0 0 1 1.5 0v1.5A1.75 1.75 0 0 1 9.25 16h-7.5A1.75 1.75 0 0 1 0 14.25Z"></path><path d="M5 1.75C5 .784 5.784 0 6.75 0h7.5C15.216 0 16 .784 16 1.75v7.5A1.75 1.75 0 0 1 14.25 11h-7.5A1.75 1.75 0 0 1 5 9.25Zm1.75-.25a.25.25 0 0 0-.25.25v7.5c0 .138.112.25.25.25h7.5a.25.25 0 0 0 .25-.25v-7.5a.25.25 0 0 0-.25-.25Z"></path>

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

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

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

导入并实例化 Prisma 客户端

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

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

const prisma = new PrismaClient()" tabindex="0" role="button">

或者

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

  <svg aria-hidden="true" height="16" viewBox="0 0 16 16" version="1.1" width="16" data-view-component="true" class="octicon octicon-copy js-clipboard-copy-icon">
<path d="M0 6.75C0 5.784.784 5 1.75 5h1.5a.75.75 0 0 1 0 1.5h-1.5a.25.25 0 0 0-.25.25v7.5c0 .138.112.25.25.25h7.5a.25.25 0 0 0 .25-.25v-1.5a.75.75 0 0 1 1.5 0v1.5A1.75 1.75 0 0 1 9.25 16h-7.5A1.75 1.75 0 0 1 0 14.25Z"></path><path d="M5 1.75C5 .784 5.784 0 6.75 0h7.5C15.216 0 16 .784 16 1.75v7.5A1.75 1.75 0 0 1 14.25 11h-7.5A1.75 1.75 0 0 1 5 9.25Zm1.75-.25a.25.25 0 0 0-.25.25v7.5c0 .138.112.25.25.25h7.5a.25.25 0 0 0 .25-.25v-7.5a.25.25 0 0 0-.25-.25Z"></path>

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

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

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

// Run inside `async` function
const allUsers = await prisma.user.findMany()

  <svg aria-hidden="true" height="16" viewBox="0 0 16 16" version="1.1" width="16" data-view-component="true" class="octicon octicon-copy js-clipboard-copy-icon">
<path d="M0 6.75C0 5.784.784 5 1.75 5h1.5a.75.75 0 0 1 0 1.5h-1.5a.25.25 0 0 0-.25.25v7.5c0 .138.112.25.25.25h7.5a.25.25 0 0 0 .25-.25v-1.5a.75.75 0 0 1 1.5 0v1.5A1.75 1.75 0 0 1 9.25 16h-7.5A1.75 1.75 0 0 1 0 14.25Z"></path><path d="M5 1.75C5 .784 5.784 0 6.75 0h7.5C15.216 0 16 .784 16 1.75v7.5A1.75 1.75 0 0 1 14.25 11h-7.5A1.75 1.75 0 0 1 5 9.25Zm1.75-.25a.25.25 0 0 0-.25.25v7.5c0 .138.112.25.25.25h7.5a.25.25 0 0 0 .25-.25v-7.5a.25.25 0 0 0-.25-.25Z"></path>

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

// Run inside `async` function
const allUsers = await prisma.user.findMany({
  include: { posts: true },
})

  <svg aria-hidden="true" height="16" viewBox="0 0 16 16" version="1.1" width="16" data-view-component="true" class="octicon octicon-copy js-clipboard-copy-icon">
<path d="M0 6.75C0 5.784.784 5 1.75 5h1.5a.75.75 0 0 1 0 1.5h-1.5a.25.25 0 0 0-.25.25v7.5c0 .138.112.25.25.25h7.5a.25.25 0 0 0 .25-.25v-1.5a.75.75 0 0 1 1.5 0v1.5A1.75 1.75 0 0 1 9.25 16h-7.5A1.75 1.75 0 0 1 0 14.25Z"></path><path d="M5 1.75C5 .784 5.784 0 6.75 0h7.5C15.216 0 16 .784 16 1.75v7.5A1.75 1.75 0 0 1 14.25 11h-7.5A1.75 1.75 0 0 1 5 9.25Zm1.75-.25a.25.25 0 0 0-.25.25v7.5c0 .138.112.25.25.25h7.5a.25.25 0 0 0 .25-.25v-7.5a.25.25 0 0 0-.25-.25Z"></path>

过滤所有`Post`包含以下内容的记录`"prisma"`

// Run inside `async` function
const filteredPosts = await prisma.post.findMany({
  where: {
    OR: [{ title: { contains: 'prisma' } }, { content: { contains: 'prisma' } }],
  },
})

  <svg aria-hidden="true" height="16" viewBox="0 0 16 16" version="1.1" width="16" data-view-component="true" class="octicon octicon-copy js-clipboard-copy-icon">
<path d="M0 6.75C0 5.784.784 5 1.75 5h1.5a.75.75 0 0 1 0 1.5h-1.5a.25.25 0 0 0-.25.25v7.5c0 .138.112.25.25.25h7.5a.25.25 0 0 0 .25-.25v-1.5a.75.75 0 0 1 1.5 0v1.5A1.75 1.75 0 0 1 9.25 16h-7.5A1.75 1.75 0 0 1 0 14.25Z"></path><path d="M5 1.75C5 .784 5.784 0 6.75 0h7.5C15.216 0 16 .784 16 1.75v7.5A1.75 1.75 0 0 1 14.25 11h-7.5A1.75 1.75 0 0 1 5 9.25Zm1.75-.25a.25.25 0 0 0-.25.25v7.5c0 .138.112.25.25.25h7.5a.25.25 0 0 0 .25-.25v-7.5a.25.25 0 0 0-.25-.25Z"></path>

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

// Run inside `async` function
const user = await prisma.user.create({
  data: {
    name: 'Alice',
    email: 'alice@prisma.io',
    posts: {
      create: { title: 'Join us for Prisma Day 2021' },
    },
  },
})

更新现有`Post`记录

// Run inside `async` function
const post = await prisma.post.update({
  where: { id: 42 },
  data: { published: true },
})

与 TypeScript 一起使用

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

社区

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

安全

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

支持

询问关于 Prisma 的问题

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

👉问一个问题

为 Prisma 创建错误报告

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

👉创建错误报告

提交功能请求

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

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

👉提交功能请求

贡献

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

测试状态

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

Name		Name	Last commit message	Last commit date
Latest commit History 10,475 Commits
.devcontainer		.devcontainer
.github		.github
.husky		.husky
.vscode		.vscode
docker		docker
eslint-local-rules		eslint-local-rules
examples		examples
graphs		graphs
helpers		helpers
packages		packages
patches		patches
sandbox		sandbox
scripts		scripts
.db.env		.db.env
.dockerignore		.dockerignore
.envrc		.envrc
.eslintignore		.eslintignore
.eslintrc.js		.eslintrc.js
.gitignore		.gitignore
.npmrc		.npmrc
.prettierignore		.prettierignore
.prettierrc.yml		.prettierrc.yml
ARCHITECTURE.md		ARCHITECTURE.md
CODE_OF_CONDUCT.md		CODE_OF_CONDUCT.md
CONTRIBUTING.md		CONTRIBUTING.md
LICENSE		LICENSE
README.md		README.md
SECURITY.md		SECURITY.md
TESTING.md		TESTING.md
package.json		package.json
pnpm-lock.yaml		pnpm-lock.yaml
pnpm-workspace.yaml		pnpm-workspace.yaml
tsconfig.build.bundle.json		tsconfig.build.bundle.json
tsconfig.build.regular.json		tsconfig.build.regular.json
tsconfig.json		tsconfig.json
tsconfig.utils.typecheck.json		tsconfig.utils.typecheck.json

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Repository files navigation

棱镜

什么是棱镜？

入门

Prisma 的工作原理

Prisma 架构

Prisma 数据模型

Prisma 型号的功能

获取数据模型

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

生成 Prisma 客户端

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

导入并实例化 Prisma 客户端

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

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

过滤所有`Post`包含以下内容的记录`"prisma"`

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

更新现有`Post`记录

与 TypeScript 一起使用

社区

安全

支持

询问关于 Prisma 的问题

为 Prisma 创建错误报告

提交功能请求

贡献

测试状态

About

Uh oh!

Releases

Packages

Languages

License

yuanxiaoming8899/prisma-cn

Folders and files

Latest commit

History

Repository files navigation

棱镜

什么是棱镜？

入门

Prisma 的工作原理

Prisma 架构

Prisma 数据模型

Prisma 型号的功能

获取数据模型

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

生成 Prisma 客户端

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

导入并实例化 Prisma 客户端

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

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

过滤所有Post包含以下内容的记录"prisma"

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

更新现有Post记录

与 TypeScript 一起使用

社区

安全

支持

询问关于 Prisma 的问题

为 Prisma 创建错误报告

提交功能请求

贡献

测试状态

About

Resources

License

Code of conduct

Contributing

Security policy

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Languages

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

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

过滤所有`Post`包含以下内容的记录`"prisma"`

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

更新现有`Post`记录

Packages