什么是 Prisma ORM？
Prisma ORM 是一个 开源 新一代 ORM。它包含以下部分
-
Prisma 客户端：为 Node.js & TypeScript 自动生成的类型安全的查询构建器
-
Prisma 迁移：迁移系统
-
Prisma Studio：用于查看和编辑数据库中数据的 GUI。
infoPrisma Studio 是 Prisma ORM 中唯一一个不是开源的部分。你只能在本地运行 Prisma Studio。
Prisma 客户端可以在任何 Node.js（支持的版本）或 TypeScript 后端应用程序（包括无服务器应用程序和微服务）中使用。这可以是 REST API、GraphQL API、gRPC API 或任何其他需要数据库的应用程序。
Prisma ORM 如何工作？
Prisma 模式
每个使用 Prisma ORM 工具包中工具的项目都从一个 Prisma 模式 开始。Prisma 模式允许开发人员使用直观的数据建模语言来定义他们的应用程序模型。它还包含与数据库的连接并定义一个生成器
- 关系型数据库
- MongoDB
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[]
}
datasource db {
provider = "mongodb"
url = env("DATABASE_URL")
}
generator client {
provider = "prisma-client-js"
}
model Post {
id String @id @default(auto()) @map("_id") @db.ObjectId
title String
content String?
published Boolean @default(false)
author User? @relation(fields: [authorId], references: [id])
authorId String @db.ObjectId
}
model User {
id String @id @default(auto()) @map("_id") @db.ObjectId
email String @unique
name String?
posts Post[]
}
注意：Prisma 模式具有强大的数据建模功能。例如，它允许你定义“Prisma 级”的 关系字段，这将使在 Prisma 客户端 API 中处理关系 变得更加容易。在上面的例子中，
User上的posts字段仅在“Prisma 级”定义，这意味着它不会在底层数据库中体现为外键。
在这个模式中，你配置了三件事
- 数据源：通过环境变量指定你的数据库连接
- 生成器：指示你想要生成 Prisma 客户端
- 数据模型：定义你的应用程序模型
Prisma 模式数据模型
此页面重点介绍数据模型。你可以在相应的文档页面上了解有关 数据源 和 生成器 的更多信息。
Prisma 模式数据模型的功能
数据模型是 模型 的集合。模型有两个主要功能
- 在关系型数据库中表示表或在 MongoDB 中表示集合
- 为 Prisma 客户端 API 中的查询提供基础
获取数据模型
有两种主要的工作流程可以将数据模型“获取”到你的 Prisma 模式中
一旦数据模型被定义，你就可以 生成 Prisma 客户端，它将公开针对已定义模型的 CRUD 和更多查询。如果你使用的是 TypeScript，你将获得所有查询的完全类型安全（即使只检索模型字段的子集）。
使用 Prisma 客户端访问你的数据库
生成 Prisma 客户端
使用 Prisma 客户端的第一步是安装 @prisma/client npm 包
npm install @prisma/client
安装 @prisma/client 包会调用 prisma generate 命令，该命令会读取你的 Prisma 模式并生成 Prisma 客户端代码。代码默认情况下 生成到 node_modules/.prisma/client 文件夹中。
更改数据模型后，你需要手动重新生成 Prisma 客户端以确保 node_modules/.prisma/client 中的代码得到更新
prisma generate
使用 Prisma 客户端将查询发送到你的数据库
一旦 Prisma 客户端生成，你就可以在你的代码中导入它并将查询发送到你的数据库。这就是设置代码的样子。
导入并实例化 Prisma 客户端
- import
- require
import { PrismaClient } from '@prisma/client'
const prisma = new PrismaClient()
const { PrismaClient } = require('@prisma/client')
const prisma = new PrismaClient()
现在你可以通过生成的 Prisma 客户端 API 开始发送查询了，以下是一些示例查询。请注意，所有 Prisma 客户端查询都返回普通旧的 JavaScript 对象。
在 Prisma 客户端 API 参考 中了解更多有关可用操作的信息。
从数据库中检索所有 User 记录
// Run inside `async` function
const allUsers = await prisma.user.findMany()
在每个返回的 User 对象上包含 posts 关系
// Run inside `async` function
const allUsers = await prisma.user.findMany({
include: { posts: true },
})
过滤所有包含 "prisma" 的 Post 记录
// 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: '[email protected]',
posts: {
create: { title: 'Join us for Prisma Day 2020' },
},
},
})
更新现有的 Post 记录
// Run inside `async` function
const post = await prisma.post.update({
where: { id: 42 },
data: { published: true },
})
与 TypeScript 一起使用
请注意，使用 TypeScript 时，此查询的结果将是静态类型的，因此你无法意外地访问不存在的属性（任何错误都会在编译时被捕获）。在文档的 生成类型的进阶用法 页面上了解有关利用 Prisma 客户端的生成类型的更多信息。
典型的 Prisma ORM 工作流程
如上所述，有两种方法可以将数据模型“获取”到 Prisma 模式中。根据你选择的方法，你的主要 Prisma ORM 工作流程可能会有所不同。
Prisma 迁移
使用Prisma 迁移，Prisma ORM 的集成数据库迁移工具，工作流程如下所示
- 手动调整你的 Prisma 模式数据模型
- 使用
prisma migrate devCLI 命令迁移你的开发数据库 - 在你的应用程序代码中使用 Prisma 客户端来访问你的数据库
要了解有关 Prisma 迁移工作流程的更多信息，请参阅
SQL 迁移和内省
如果由于某种原因你无法或不想使用 Prisma 迁移，你仍然可以使用内省从你的数据库模式更新你的 Prisma 模式。使用SQL 迁移和内省时，典型的工作流程略有不同
- 使用 SQL 或第三方迁移工具手动调整你的数据库模式
- （重新）内省你的数据库
- 可选地 （重新）配置你的 Prisma 客户端 API)
- （重新）生成 Prisma 客户端
- 在你的应用程序代码中使用 Prisma 客户端来访问你的数据库
要了解有关内省工作流程的更多信息，请参考 内省部分。