rejectOnNotFound 变更
自 Prisma ORM 5.0.0 版本起,已废弃的参数 rejectOnNotFound
已被移除。根据你的项目是按查询还是全局使用 rejectOnNotFound
,更新代码的方式会有所不同。
如果你是按查询使用 rejectOnNotFound
参数,请按照我们在查询层面更新代码的步骤进行操作。
如果你是在客户端层面设置了 rejectOnNotFound
参数,则需要遵循在客户端层面更新代码的步骤。
Prisma ORM 5 的完整变更列表可在我们的发布说明中找到。
替换在查询层面启用的 rejectOnNotFound
如果你之前是按查询启用 rejectOnNotFound
,你需要替换在查询层面的用法。你可以使用我们的 *OrThrow
查询变体,即 findFirstOrThrow
或 findUniqueOrThrow
,而不是向 findFirst
和 findUnique()
提供参数。
简单的 rejectOnNotFound
用法
以下示例
prisma.user.findFirst({
where: { name: 'Alice' },
rejectOnNotFound: true,
})
需要转换为
prisma.user.findFirstOrThrow({
where: { name: 'Alice' },
})
带自定义错误处理器的 rejectOnNotFound
用法
如果你使用以下自定义错误处理器
prisma.user.findFirst({
where: { name: 'Alice' },
rejectOnNotFound: () => new UserNotFoundError(),
})
你需要修改代码来处理 ...OrThrow
方法抛出的错误。
try {
await prisma.user.findFirstOrThrow({
where: { name: 'Alice' },
})
} catch (err) {
if (err.code === 'P2025') {
throw new UserNotFoundError()
}
throw err
}
如果你的错误处理器在多个地方使用,你还可以创建一个可复用的错误适配器,然后在函数上调用的 .catch()
中使用。
const adaptError = (customThrowFn) => (error) => {
if (error.code === 'P2025') {
throw customThrowFn()
}
throw error
}
const user = await prisma.user.findFirstOrThrow({
where: { name: 'Alice' },
}).catch(adaptError(() => new MyCustomError())
替换在客户端层面启用的 rejectOnNotFound
通过 Prisma Client 构造函数使用 rejectOnNotFound
如果你之前通过 Prisma Client 构造函数中的配置全局启用了 rejectOnNotFound
,如下面这些示例所示
// Example 1
const prisma = new PrismaClient({
rejectOnNotFound: true,
})
// Example 2
const prisma = new PrismaClient({
rejectOnNotFound: {
findUnique: true,
},
})
你需要更新你的代码库,使用 findUniqueOrThrow
和 findFirstOrThrow
来代替 findUnique()
和 findFirst
,具体取决于你希望哪些调用抛出错误。
通过 Prisma Client 构造函数使用带自定义错误处理器的 rejectOnNotFound
如果你改为使用带 rejectOnNotFound
属性的自定义错误处理器,如下面这些示例所示
// Example 3
const prisma = new PrismaClient({
rejectOnNotFound: (err) => new Error('something'),
})
// Example 4
const prisma = new PrismaClient({
rejectOnNotFound: {
findUnique: (err) => new Error('something'),
},
})
// Example 5
const prisma = new PrismaClient({
rejectOnNotFound: {
findFirst: {
User: (err) => new Error('User error'),
Post: (err) => new Error('Post error'),
},
findUnique: {
User: (err) => new Error('User error'),
Post: (err) => new Error('Post error'),
},
},
})
你需要将你的方法用法更新为 ...OrThrow
,然后使用客户端扩展 (Client Extension) 来获得相同的行为。
例如,以下扩展将在 Prisma ORM 5 中提供与 Example 5
在 Prisma ORM 4 及更低版本中相同的行为。
import { PrismaClient } from '@prisma/client';
const customErrorFunc = async (model, query, args) => {
try {
await query(args)
} catch (error: any) {
if (error.code === 'P2025') {
throw new Error(`${model} error`)
}
throw error;
}
}
const prisma = (new PrismaClient()).$extends({
query: {
user: {
async findFirstOrThrow({ model, query, args }) {
return await customErrorFunc(model, query, args)
},
async findUniqueOrThrow({ model, query, args }) {
return await customErrorFunc(model, query, args)
},
},
post: {
async findFirstOrThrow({ model, query, args }) {
return await customErrorFunc(model, query, args)
},
async findUniqueOrThrow({ model, query, args }) {
return await customErrorFunc(model, query, args)
},
},
},
})