使用 TypeScript 和 Prisma ORM 查询您现有的 MongoDB 数据库
使用 Prisma Client 编写您的第一个查询
生成 Prisma Client 后,您可以开始编写查询来读取和写入数据库中的数据。在本指南中,您将使用一个简单的 Node.js 脚本来探索 Prisma Client 的一些基本功能。
如果您正在构建 REST API,可以在路由处理程序中使用 Prisma Client,根据传入的 HTTP 请求读取和写入数据库中的数据。如果您正在构建 GraphQL API,可以在解析器中使用 Prisma Client,根据传入的查询和变更操作读取和写入数据库中的数据。
然而,为了本指南的目的,您将创建一个简单的 Node.js 脚本来学习如何使用 Prisma Client 向数据库发送查询。一旦您了解了 API 的工作方式,就可以开始将其集成到您的实际应用程序代码中(例如 REST 路由处理程序或 GraphQL 解析器)。
创建一个名为 index.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)
})
以下是代码片段不同部分的快速概览
- 从
@prisma/client
Node 模块导入PrismaClient
构造函数 - 实例化
PrismaClient
- 定义一个名为
main
的async
函数,用于向数据库发送查询 - 连接到数据库
- 调用
main
函数 - 脚本终止时关闭数据库连接
在 main
函数中,添加以下查询以从数据库读取所有 User
记录并打印结果
async function main() {
// ... you will write your Prisma Client queries here
+ const allUsers = await prisma.user.findMany()
+ console.log(allUsers)
}
现在使用此命令运行代码
npx tsx index.ts
如果您内省了一个包含记录的现有数据库,查询应该返回一个 JavaScript 对象数组。
将数据写入数据库
您在上一节中使用的 findMany
查询仅从数据库中 读取 数据(尽管它当时还是空的)。在本节中,您将学习如何编写查询以向 Post
、User
和 Comment
表中 写入 新记录。
调整 main
函数,向数据库发送一个 create
查询
async function main() {
await prisma.user.create({
data: {
name: 'Rich',
email: 'hello@prisma.com',
posts: {
create: {
title: 'My first post',
body: 'Lots of really interesting stuff',
slug: 'my-first-post',
},
},
},
})
const allUsers = await prisma.user.findMany({
include: {
posts: true,
},
})
console.dir(allUsers, { depth: null })
}
此代码使用嵌套写入查询创建一个新的 User
记录以及一个新的 Post
记录。User
记录通过 Post.author
↔ User.posts
关联字段分别连接到另一条记录。
请注意,您向 findMany
传递了 include
选项,这告诉 Prisma Client 在返回的 User
对象中包含 posts
关联。
使用此命令运行代码
npx tsx index.ts
输出应类似于这样
[
{
id: '60cc9b0e001e3bfd00a6eddf',
email: 'hello@prisma.com',
name: 'Rich',
posts: [
{
id: '60cc9bad005059d6007f45dd',
slug: 'my-first-post',
title: 'My first post',
body: 'Lots of really interesting stuff',
userId: '60cc9b0e001e3bfd00a6eddf',
},
],
},
]
另请注意,得益于 Prisma Client 生成的类型,allUsers
是 静态类型 的。您可以将鼠标悬停在编辑器中的 allUsers
变量上以观察其类型。它应如下所示
const allUsers: (User & {
posts: Post[]
})[]
export type Post = {
id: number
title: string
body: string | null
published: boolean
authorId: number | null
}
该查询将新记录添加到了 User
和 Post
集合中
Prisma 模式中的 id
字段映射到底层 MongoDB 数据库中的 _id
。
User 集合
_id | name | |
---|---|---|
60cc9b0e001e3bfd00a6eddf | "hello@prisma.com" | "Rich" |
Post 集合
_id | createdAt | title | content | published | authorId |
---|---|---|---|---|---|
60cc9bad005059d6007f45dd | 2020-03-21T16:45:01.246Z | "我的第一篇帖子" | 许多非常有趣的内容 | false | 60cc9b0e001e3bfd00a6eddf |
注意:
Post
文档字段中authorId
的唯一标识符引用了User
集合中的_id
文档字段,这意味着_id
值60cc9b0e001e3bfd00a6eddf
列因此指向数据库中第一个(也是唯一一个)User
记录。
在继续下一节之前,您将使用 update
查询向刚刚创建的 Post
记录添加几个评论。请按如下方式调整 main
函数
async function main() {
await prisma.post.update({
where: {
slug: 'my-first-post',
},
data: {
comments: {
createMany: {
data: [
{ comment: 'Great post!' },
{ comment: "Can't wait to read more!" },
],
},
},
},
})
const posts = await prisma.post.findMany({
include: {
comments: true,
},
})
console.dir(posts, { depth: Infinity })
}
现在使用与之前相同的命令运行代码
npx tsx index.ts
您将看到以下输出
[
{
id: '60cc9bad005059d6007f45dd',
slug: 'my-first-post',
title: 'My first post',
body: 'Lots of really interesting stuff',
userId: '60cc9b0e001e3bfd00a6eddf',
comments: [
{
id: '60cca420008a21d800578793',
postId: '60cca40300af8bf000f6ca99',
comment: 'Great post!',
},
{
id: '60cca420008a21d800578794',
postId: '60cca40300af8bf000f6ca99',
comment: "Can't wait to try this!",
},
],
},
]
太棒了,您刚刚首次使用 Prisma Client 将新数据写入了您的数据库 🚀