Prisma

快速入门   •   网站   •   文档   •   示例   •   博客   •   Slack   •   Twitter   •   Prisma 1

什么是Prisma？

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

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

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

您在寻找 Prisma 1 吗？Prisma 1 存储库已重命名为prisma/prisma1 .

入门

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

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

• 将 Prisma 添加到现有项目
• 从头开始使用 Prisma 建立一个新项目

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

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

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

Prisma 数据模型

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

Prisma 模型的功能

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

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

获取数据模型

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

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

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

使用 Prisma Client 访问您的数据库

生成 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得到更新：

prisma generate

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

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

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

导入并实例化 Prisma 客户端

您可以按如下方式导入和实例化 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从数据库中检索所有记录

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

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

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

过滤所有 Post包含 "prisma"

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

在同一查询中创建新记录 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 客户端生成类型的更多信息。

社区

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

安全

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

支持

询问有关 Prisma 的问题

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

👉 问一个问题

为 Prisma 创建错误报告

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

👉 创建错误报告

提交功能请求

如果 Prisma 当前没有某个功能，请务必查看路线图，看看是否已经为未来计划了这一点。

如果路线图上的功能与 GitHub 问题相关联，请确保在该问题上留下 +1，最好是评论您对该功能的看法！

👉 提交功能请求

贡献

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