连接管理
PrismaClient
使用以下两种方法连接和断开数据源
在大多数情况下,你**无需显式调用这些方法**。PrismaClient
在你运行第一个查询时自动连接,创建连接池,并在 Node.js 进程结束时断开连接。
有关不同部署范式(长时间运行的进程和无服务器函数)的连接管理信息,请参阅连接管理指南。
$connect()
由于惰性连接行为,没有必要调用$connect()
:当向 API 发出第一个请求时,PrismaClient
实例会进行惰性连接($connect()
会在底层为你调用)。
显式调用 $connect()
如果你需要第一个请求立即响应,并且不能等待惰性连接建立,你可以显式调用 prisma.$connect()
来建立与数据源的连接
const prisma = new PrismaClient()
// run inside `async` function
await prisma.$connect()
$disconnect()
当你调用$disconnect()
时,Prisma Client 会
- 运行
beforeExit
钩子 - 结束查询引擎子进程并关闭所有连接
在像 GraphQL API 这样持续处理请求的长时间运行应用程序中,每次请求后都调用 $disconnect()
是没有意义的——建立连接需要时间,每次请求都这样做会降低你的应用程序的速度。
为了避免长时间运行的应用程序中出现过多连接,我们建议你在整个应用程序中只使用一个 PrismaClient
实例。
显式调用 $disconnect()
你应该显式调用 $disconnect()
的一个场景是当脚本
- 运行**不频繁**(例如,一个每晚发送电子邮件的计划任务),这意味着它不会从与数据库的长时间运行连接中受益,*并且*
- 存在于**长时间运行的应用程序**上下文中,例如后台服务。如果应用程序从不关闭,Prisma Client 也从不断开连接。
以下脚本创建 PrismaClient
的新实例,执行任务,然后断开连接——这将关闭连接池
import { PrismaClient } from '@prisma/client'
const prisma = new PrismaClient()
const emailService = new EmailService()
async function main() {
const allUsers = await prisma.user.findMany()
const emails = allUsers.map((x) => x.email)
await emailService.send(emails, 'Hello!')
}
main()
.then(async () => {
await prisma.$disconnect()
})
.catch(async (e) => {
console.error(e)
await prisma.$disconnect()
process.exit(1)
})
如果上述脚本在长时间运行的应用程序上下文中多次运行而不调用 $disconnect()
,那么每个新的 PrismaClient
实例都会创建一个新的连接池。
退出钩子
从 Prisma ORM 5.0.0 开始,beforeExit
钩子仅适用于二进制查询引擎。
当 Prisma ORM 被外部触发(例如,通过 SIGINT
信号)以关闭时,beforeExit
钩子会运行,并允许你在 Prisma Client 断开连接之前运行代码——例如,在服务优雅关闭时发出查询
const prisma = new PrismaClient()
prisma.$on('beforeExit', async () => {
console.log('beforeExit hook')
// PrismaClient still available
await prisma.message.create({
data: {
message: 'Shutting down server',
},
})
})