快速入门
在本快速入门指南中，您将学习如何从零开始使用 Prisma ORM，使用纯 TypeScript 项目和本地 SQLite 数据库文件。它涵盖了 数据建模、迁移 和 查询 数据库。
如果您想将 Prisma ORM 与您自己的 PostgreSQL、MySQL、MongoDB 或任何其他受支持的数据库一起使用，请转到此处
先决条件
您需要在您的机器上安装 Node.js（请参阅 系统要求 以了解官方支持的版本）。
1. 创建 TypeScript 项目并设置 Prisma ORM
第一步，创建一个项目目录并导航到其中
mkdir hello-prisma
cd hello-prisma
接下来，使用 npm 初始化一个 TypeScript 项目
npm init -y
npm install typescript tsx @types/node --save-dev
这将创建一个 package.json 文件，其中包含您的 TypeScript 应用程序的初始设置。
请参阅 安装说明，了解如何使用不同的包管理器安装 Prisma。
现在，初始化 TypeScript
npx tsc --init
然后，在项目中安装 Prisma CLI 作为开发依赖项
npm install prisma --save-dev
最后，使用 Prisma CLI 的 init 命令设置 Prisma ORM
npx prisma init --datasource-provider sqlite
这将创建一个新的 prisma 目录，其中包含 schema.prisma 文件，并将 SQLite 配置为您的数据库。您现在可以对数据进行建模并创建包含一些表数据库了。
2. 在 Prisma schema 中对数据进行建模
Prisma schema 提供了一种直观的数据建模方式。将以下模型添加到您的 schema.prisma 文件中
model User {
id Int @id @default(autoincrement())
email String @unique
name String?
posts Post[]
}
model Post {
id Int @id @default(autoincrement())
title String
content String?
published Boolean @default(false)
author User @relation(fields: [authorId], references: [id])
authorId Int
}
Prisma schema 中的模型有两个主要目的
- 表示底层数据库中的表
- 作为生成的 Prisma Client API 的基础
在下一节中，您将使用 Prisma Migrate 将这些模型映射到数据库表。
3. 运行迁移以使用 Prisma Migrate 创建数据库表
此时，您有了一个 Prisma schema，但还没有数据库。在您的终端中运行以下命令以创建 SQLite 数据库以及由您的模型表示的 User 和 Post 表
npx prisma migrate dev --name init
此命令执行了三件事
- 它在此迁移的
prisma/migrations目录中创建了一个新的 SQL 迁移文件。 - 它针对数据库执行了 SQL 迁移文件。
- 它在后台运行了
prisma generate（这安装了@prisma/client包并基于您的模型生成了定制的 Prisma Client API）。
由于 SQLite 数据库文件之前不存在，因此该命令还在 prisma 目录中创建了它，名称为 dev.db，这通过 .env 文件中的环境变量定义。
恭喜您，您现在已经准备好数据库和表。让我们学习如何发送一些查询来读取和写入数据！
4. 探索如何使用 Prisma Client 向数据库发送查询
要向数据库发送查询，您将需要一个 TypeScript 文件来执行您的 Prisma Client 查询。为此创建一个名为 script.ts 的新文件
touch script.ts
然后，将以下样板代码粘贴到其中
import { PrismaClient } from '@prisma/client'
const prisma = new PrismaClient()
async function main() {
// ... you will write your Prisma Client queries here
}
main()
.then(async () => {
await prisma.$disconnect()
})
.catch(async (e) => {
console.error(e)
await prisma.$disconnect()
process.exit(1)
})
此代码包含一个在脚本末尾调用的 main 函数。它还实例化了 PrismaClient，它表示数据库的查询接口。
4.1. 创建新的 User 记录
让我们从一个小查询开始，在数据库中创建一个新的 User 记录，并将结果对象记录到控制台。将以下代码添加到您的 script.ts 文件中
import { PrismaClient } from '@prisma/client'
const prisma = new PrismaClient()
async function main() {
const user = await prisma.user.create({
data: {
name: 'Alice',
email: '[email protected]',
},
})
console.log(user)
}
main()
.then(async () => {
await prisma.$disconnect()
})
.catch(async (e) => {
console.error(e)
await prisma.$disconnect()
process.exit(1)
})
您可以手动在编辑器中键入代码，而不是复制代码，以体验 Prisma Client 提供的自动完成功能。您还可以通过按键盘上的 CTRL+SPACE 键主动调用自动完成功能。
接下来，使用以下命令执行脚本
npx tsx script.ts
{ id: 1, email: '[email protected]', name: 'Alice' }
干得好，您刚刚使用 Prisma Client 创建了您的第一个数据库记录！🎉
在下一节中，您将学习如何从数据库中读取数据。
4.2. 检索所有 User 记录
Prisma Client 提供了各种查询来从数据库中读取数据。在本节中，您将使用 findMany 查询，该查询返回给定模型在数据库中的所有记录。
删除之前的 Prisma Client 查询，并添加新的 findMany 查询
import { PrismaClient } from '@prisma/client'
const prisma = new PrismaClient()
async function main() {
const users = await prisma.user.findMany()
console.log(users)
}
main()
.then(async () => {
await prisma.$disconnect()
})
.catch(async (e) => {
console.error(e)
await prisma.$disconnect()
process.exit(1)
})
再次执行脚本
npx tsx script.ts
[{ id: 1, email: '[email protected]', name: 'Alice' }]
请注意，控制台中如何用方括号括起了单个 User 对象。这是因为 findMany 返回了一个包含单个对象的数组。
4.3. 探索 Prisma Client 的关系查询
Prisma Client 的主要功能之一是易于使用关系。在本节中，您将学习如何在嵌套写入查询中创建 User 和 Post 记录。之后，您将看到如何使用 include 选项从数据库中检索关系。
首先，调整您的脚本以包含嵌套查询
import { PrismaClient } from '@prisma/client'
const prisma = new PrismaClient()
async function main() {
const user = await prisma.user.create({
data: {
name: 'Bob',
email: '[email protected]',
posts: {
create: [
{
title: 'Hello World',
published: true
},
{
title: 'My second post',
content: 'This is still a draft'
}
],
},
},
})
console.log(user)
}
main()
.then(async () => {
await prisma.$disconnect()
})
.catch(async (e) => {
console.error(e)
await prisma.$disconnect()
process.exit(1)
})
通过再次执行脚本来运行查询
npx tsx script.ts
{ id: 2, email: '[email protected]', name: 'Bob' }
默认情况下，Prisma Client 仅在查询的结果对象中返回标量字段。这就是为什么，即使您还为新的 User 记录创建了一个新的 Post 记录，控制台也只打印了一个包含三个标量字段的对象：id、email 和 name。
为了也检索属于 User 的 Post 记录，您可以使用 include 选项通过 posts 关系字段
import { PrismaClient } from '@prisma/client'
const prisma = new PrismaClient()
async function main() {
const usersWithPosts = await prisma.user.findMany({
include: {
posts: true,
},
})
console.dir(usersWithPosts, { depth: null })
}
main()
.then(async () => {
await prisma.$disconnect()
})
.catch(async (e) => {
console.error(e)
await prisma.$disconnect()
process.exit(1)
})
再次运行脚本以查看嵌套读取查询的结果
npx tsx script.ts
[
{ id: 1, email: '[email protected]', name: 'Alice', posts: [] },
{
id: 2,
email: '[email protected]',
name: 'Bob',
posts: [
{
id: 1,
title: 'Hello World',
content: null,
published: true,
authorId: 2
},
{
id: 2,
title: 'My second post',
content: 'This is still a draft',
published: false,
authorId: 2
}
]
}
]
这次，您将看到打印了两个 User 对象。它们都具有 posts 字段（对于 "Alice" 为空，对于 "Bob" 则填充了两个 Post 对象），表示与它们关联的 Post 记录。
请注意，usersWithPosts 数组中的对象也已完全类型化。这意味着您将获得自动完成功能，并且 TypeScript 编译器将阻止您意外地键入它们。
5. 后续步骤
在本快速入门指南中，您学习了如何在纯 TypeScript 项目中开始使用 Prisma ORM。请随意自行探索更多 Prisma Client API，例如，在 findMany 查询中包含过滤、排序和分页选项，或探索更多操作，如 update 和 delete 查询。
在 Prisma Studio 中探索数据
Prisma ORM 配备了内置 GUI，用于查看和编辑数据库中的数据。您可以使用以下命令打开它
npx prisma studio
使用您自己的数据库设置 Prisma ORM
如果您想使用您自己的 PostgreSQL、MySQL、MongoDB 或任何其他受支持的数据库继续使用 Prisma ORM，请按照设置 Prisma ORM 指南进行操作
通过 Prisma Optimize 获取查询洞察和分析
Prisma Optimize 帮助您生成洞察并提供建议，这些建议可以帮助您更快地进行数据库查询。
Optimize 旨在帮助所有技能水平的开发人员编写高效的数据库查询，从而减少数据库负载并使应用程序更具响应性。
探索即用型 Prisma ORM 示例
查看 GitHub 上的 prisma-examples 仓库，了解 Prisma ORM 如何与您最喜欢的库一起使用。该仓库包含 Express、NestJS、GraphQL 的示例，以及 Next.js 和 Vue.js 的全栈示例等等。
使用 Prisma Pulse 构建实时应用程序
Prisma Pulse 使您能够创建对数据库中的更改立即做出反应的应用程序，从而使您能够轻松构建类型安全的实时功能和应用程序
| 演示 | 描述 |
|---|---|
starter | Prisma Pulse 入门应用程序 |
email-with-resend | 一个示例应用程序，用于使用 Prisma Pulse 和 Resend 向新用户发送电子邮件 |
fullstack-leaderboard | 实时排行榜（使用 Next.js 构建） |
fullstack-simple-chat | 一个简单的聊天应用程序（使用 Next.js 和 Express 构建） |
product-search-with-typesense | 一个将数据同步到 Typesense 的 cron 任务（使用 Hono.js 构建） |
data-sync-with-bigquery | 一个自动将数据同步到 Google BigQuery 的脚本 |
使用 Prisma Accelerate 加速数据库查询
Prisma Accelerate 是一个连接池和全局数据库缓存，可以显著加速您的数据库查询。查看 速度测试 或尝试将 Accelerate 与您最喜欢的框架一起使用
| 演示 | 描述 |
|---|---|
nextjs-starter | 一个使用 Prisma Accelerate 的缓存和连接池的 Next.js 项目 |
svelte-starter | 一个使用 Prisma Accelerate 的缓存和连接池的 SvelteKit 项目 |
solidstart-starter | 一个使用 Prisma Accelerate 的缓存和连接池的 Solidstart 项目 |
remix-starter | 一个使用 Prisma Accelerate 的缓存和连接池的 Remix 项目 |
nuxt-starter | 一个使用 Prisma Accelerate 的缓存和连接池的 Nuxt.js 项目 |
astro-starter | 一个使用 Prisma Accelerate 的缓存和连接池的 Astro 项目 |
使用 Prisma ORM 构建应用程序
Prisma 博客包含有关 Prisma ORM 的综合教程，请查看我们最新的教程
加入 Prisma 社区 💚
Prisma 拥有庞大的开发者社区。在 Discord 上加入我们，或使用 GitHub Discussions 提问。