`query`：创建自定义 Prisma Client 查询
Prisma Client 扩展自 4.16.0 及更高版本起正式发布。它们在 4.7.0 版本中以预览形式引入。如果您运行的版本早于 4.16.0，请确保启用 clientExtensions 预览功能标志。
您可以使用 query Prisma Client 扩展组件类型来hook到查询生命周期中，并修改传入的查询或其结果。
您可以使用 Prisma Client 扩展 query 组件来创建独立的客户端。这提供了 中间件 的替代方案。您可以将一个客户端绑定到特定的过滤器或用户，并将另一个客户端绑定到另一个过滤器或用户。例如，您可能会这样做以在行级安全性（RLS）扩展中获得 用户隔离。此外，与中间件不同，query 扩展组件为您提供端到端的类型安全。了解有关 query 扩展与中间件的更多信息。
扩展 Prisma Client 查询操作
使用 $extends 客户端级别方法 来创建 扩展客户端。扩展客户端是标准 Prisma Client 的变体，它被一个或多个扩展包装。
使用 query 扩展组件来修改查询。您可以在以下方面修改自定义查询
要创建自定义查询，请使用以下结构
const prisma = new PrismaClient().$extends({
name?: 'name',
query?: {
user: { ... } // in this case, we add a query to the `user` model
},
});
属性如下：
name：（可选）指定扩展的名称，该名称会出现在错误日志中。query：定义自定义查询。
修改特定模型中的特定操作
query 对象可以包含映射到 Prisma Client 操作 名称的函数，例如 findUnique()、findFirst、findMany、count 和 create。以下示例修改 user.findMany 以使用自定义查询，该查询仅查找年龄大于 18 岁的用户
const prisma = new PrismaClient().$extends({
query: {
user: {
async findMany({ model, operation, args, query }) {
// take incoming `where` and set `age`
args.where = { ...args.where, age: { gt: 18 } }
return query(args)
},
},
},
})
await prisma.user.findMany() // returns users whose age is greater than 18
在上面的示例中，调用 prisma.user.findMany 会触发 query.user.findMany。每个回调都会收到一个类型安全的 { model, operation, args, query } 对象，该对象描述了查询。此对象具有以下属性
-
model：我们要扩展的查询的包含模型的名称。在上面的示例中，
model是类型为"User"的字符串。 -
operation：正在扩展和执行的操作的名称。在上面的示例中，
operation是类型为"findMany"的字符串。 -
args：要扩展的特定查询输入信息。这是一个类型安全的对象，您可以在查询发生之前对其进行修改。您可以修改
args中的任何属性。例外：您不能修改include或select，因为这会更改预期的输出类型并破坏类型安全。 -
query：查询结果的 promise。- 您可以使用
await，然后修改此 promise 的结果，因为它的值是类型安全的。TypeScript 会捕获对象上的任何不安全修改。
- 您可以使用
修改模式中所有模型的特定操作
要扩展模式中所有模型的查询，请使用 $allModels 而不是特定的模型名称。例如
const prisma = new PrismaClient().$extends({
query: {
$allModels: {
async findMany({ model, operation, args, query }) {
// set `take` and fill with the rest of `args`
args = { ...args, take: 100 }
return query(args)
},
},
},
})
修改特定模型中的所有操作
使用 $allOperations 扩展特定模型中的所有操作。
例如，以下代码将自定义查询应用于 user 模型上的所有操作
const prisma = new PrismaClient().$extends({
query: {
user: {
$allOperations({ model, operation, args, query }) {
/* your custom logic here */
return query(args)
},
},
},
})
修改所有 Prisma Client 操作
使用 $allOperations 方法修改 Prisma Client 中存在的所有查询方法。$allOperations 可以用于模型操作和原始查询。
您可以按如下方式修改所有方法
const prisma = new PrismaClient().$extends({
query: {
$allOperations({ model, operation, args, query }) {
/* your custom logic for modifying all Prisma Client operations here */
return query(args)
},
},
})
如果调用了 原始查询，则传递给回调的 model 参数将为 undefined。
例如，您可以使用 $allOperations 方法记录查询，如下所示
const prisma = new PrismaClient().$extends({
query: {
async $allOperations({ operation, model, args, query }) {
const start = performance.now()
const result = await query(args)
const end = performance.now()
const time = end - start
console.log(
util.inspect(
{ model, operation, args, time },
{ showHidden: false, depth: null, colors: true }
)
)
return result
},
},
})
修改模式中所有模型的所有操作
使用 $allModels 和 $allOperations 扩展模式中所有模型的所有操作。
要将自定义查询应用于模式中所有模型的所有操作
const prisma = new PrismaClient().$extends({
query: {
$allModels: {
$allOperations({ model, operation, args, query }) {
/* your custom logic for modifying all operations on all models here */
return query(args)
},
},
},
})
修改顶级原始查询操作
要将自定义行为应用于特定的顶级原始查询操作，请使用顶级原始查询函数的名称而不是模型名称
- 关系数据库
- MongoDB
const prisma = new PrismaClient().$extends({
query: {
$queryRaw({ args, query, operation }) {
// handle $queryRaw operation
return query(args)
},
$executeRaw({ args, query, operation }) {
// handle $executeRaw operation
return query(args)
},
$queryRawUnsafe({ args, query, operation }) {
// handle $queryRawUnsafe operation
return query(args)
},
$executeRawUnsafe({ args, query, operation }) {
// handle $executeRawUnsafe operation
return query(args)
},
},
})
const prisma = new PrismaClient().$extends({
query: {
$runCommandRaw({ args, query, operation }) {
// handle $runCommandRaw operation
return query(args)
},
},
})
改变查询结果
您可以使用 await，然后修改 query promise 的结果。
const prisma = new PrismaClient().$extends({
query: {
user: {
async findFirst({ model, operation, args, query }) {
const user = await query(args)
if (user.password !== undefined) {
user.password = '******'
}
return user
},
},
},
})
我们包含上面的示例是为了说明这是可能的。但是，出于性能原因，我们建议您使用 result 组件类型 来覆盖现有字段。在这种情况下，result 组件类型通常提供更好的性能，因为它仅在访问时计算。query 组件类型在查询执行后计算。
将查询包装到批量事务中
您可以将扩展查询包装到 批量事务 中。例如，您可以使用它来实施行级安全性（RLS）。
以下示例扩展了 findFirst，使其在批量事务中运行。
const transactionExtension = Prisma.defineExtension((prisma) =>
prisma.$extends({
query: {
user: {
// Get the input `args` and a callback to `query`
async findFirst({ args, query, operation }) {
const [result] = await prisma.$transaction([query(args)]) // wrap the query in a batch transaction, and destructure the result to return an array
return result // return the first result found in the array
},
},
},
})
)
const prisma = new PrismaClient().$extends(transactionExtension)
查询扩展与中间件
您可以使用查询扩展或 中间件 来hook到查询生命周期中，并修改传入的查询或其结果。客户端扩展和中间件在以下方面有所不同
- 中间件始终全局应用于同一客户端。客户端扩展是隔离的，除非您有意地将它们组合起来。了解有关客户端扩展的更多信息。
- 例如，在行级安全性（RLS）方案中，您可以将每个用户保留在完全独立的客户端中。使用中间件，所有用户都在同一客户端中处于活动状态。
- 在应用程序执行期间，使用扩展，您可以从一个或多个扩展客户端或标准 Prisma Client 中进行选择。使用中间件，您无法选择要使用的客户端，因为只有一个全局客户端。
- 扩展受益于端到端的类型安全和推断，但中间件则不然。
您可以在可以使用中间件的所有场景中使用 Prisma Client 扩展。
如果您使用 query 扩展组件和中间件
如果您在项目中使用 query 扩展组件和中间件，则以下规则和优先级适用
- 在您的应用程序代码中，您必须在主 Prisma Client 实例上声明所有中间件。您不能在扩展客户端上声明它们。
- 在中间件和具有
query组件的扩展执行的情况下，Prisma Client 在执行具有query组件的扩展之前执行中间件。Prisma Client 按照您使用$use或$extends实例化它们的顺序执行各个中间件和扩展。