跳到主要内容

查询优化

本指南介绍如何识别和优化查询性能、调试性能问题以及解决常见挑战。

调试性能问题

一些常见做法可能导致查询缓慢和性能问题,例如

  • 过度获取数据
  • 缺少索引
  • 未缓存重复查询
  • 执行全表扫描
信息

有关更多潜在的性能问题原因,请访问此页面

Prisma Optimize 提供建议来识别和解决上述及更多低效问题,帮助提升查询性能。

要开始使用,请按照集成指南将 Prisma Optimize 添加到您的项目,开始诊断慢查询。

提示

您还可以在客户端级别记录查询事件,以查看生成的查询、其参数和执行时间。

如果您特别关注查询持续时间监控,请考虑使用日志中间件

使用批量查询

通常,批量读写大量数据性能更佳 - 例如,以 1000 条记录为一批插入 50,000 条记录,而不是作为 50,000 次单独插入。PrismaClient 支持以下批量查询

复用 PrismaClient 或使用连接池以避免数据库连接池耗尽

创建多个 PrismaClient 实例可能会耗尽您的数据库连接池,尤其是在无服务器或边缘环境中,这可能导致其他查询变慢。在无服务器挑战中了解更多信息。

对于传统服务器应用程序,只需实例化一次 PrismaClient 并在整个应用程序中复用,而不是创建多个实例。例如,与其这样:

query.ts
async function getPosts() {
const prisma = new PrismaClient()
await prisma.post.findMany()
}

async function getUsers() {
const prisma = new PrismaClient()
await prisma.user.findMany()
}

在专门文件中定义一个 PrismaClient 单例并重新导出以便复用

db.ts
export const prisma = new PrismaClient()

然后导入共享实例

query.ts
import { prisma } from "db.ts"

async function getPosts() {
await prisma.post.findMany()
}

async function getUsers() {
await prisma.user.findMany()
}

对于使用 HMR(模块热替换)框架的无服务器开发环境,请确保您在开发环境中正确处理 Prisma 的单例

解决 n+1 问题

n+1 问题发生在您遍历查询结果并对每个结果执行一个额外查询时,导致总共 n 个查询加上原始查询 (n+1)。这是 ORM 中的常见问题,尤其是在与 GraphQL 结合使用时,因为有时代码生成低效查询并不立即显而易见。

使用 findUnique() 和 Prisma Client 的 dataloader 在 GraphQL 中解决 n+1 问题

Prisma Client 的 dataloader 会自动批量处理在同一tick 中发生且具有相同 whereinclude 参数的 findUnique() 查询,前提是

  • where 过滤器中的所有条件都作用于您正在查询的同一模型的标量字段(唯一或非唯一)。
  • 所有条件都使用 equal 过滤器,无论是通过简写还是显式语法 (where: { field: <val>, field1: { equals: <val> } })
  • 不存在布尔运算符或关系过滤器。

findUnique() 的自动批量处理在 GraphQL 上下文中特别有用。GraphQL 为每个字段运行一个单独的解析器函数,这使得优化嵌套查询变得困难。

例如 - 下面的 GraphQL 运行 allUsers 解析器获取所有用户,然后对每个用户运行 posts 解析器获取该用户的帖子 (n+1)

query {
allUsers {
id,
posts {
id
}
}
}

allUsers 查询使用 user.findMany(..) 返回所有用户

const Query = objectType({
name: 'Query',
definition(t) {
t.nonNull.list.nonNull.field('allUsers', {
type: 'User',
resolve: (_parent, _args, context) => {
return context.prisma.user.findMany()
},
})
},
})

这会产生一个单独的 SQL 查询

{
timestamp: 2021-02-19T09:43:06.332Z,
query: 'SELECT `dev`.`User`.`id`, `dev`.`User`.`email`, `dev`.`User`.`name` FROM `dev`.`User` WHERE 1=1 LIMIT ? OFFSET ?',
params: '[-1,0]',
duration: 0,
target: 'quaint::connector::metrics'
}

然而,posts 的解析器函数随后会对每个用户调用一次。这导致每个用户都执行一个 findMany() 查询 ,而不是执行一个单独的 findMany() 查询来返回所有用户的帖子(展开 CLI 输出查看查询)。

const User = objectType({
name: 'User',
definition(t) {
t.nonNull.int('id')
t.string('name')
t.nonNull.string('email')
t.nonNull.list.nonNull.field('posts', {
type: 'Post',
resolve: (parent, _, context) => {
return context.prisma.post.findMany({
where: { authorId: parent.id || undefined },
})
},
})
},
})
显示CLI结果

解决方案 1:使用 Fluent API 批量查询

结合Fluent API (.posts()) 使用 findUnique(),如示例所示,以返回用户的帖子。尽管解析器是按用户调用的,但 Prisma Client 中的 Prisma dataloader 会 ✔ 批量处理 findUnique() 查询

信息

使用 prisma.user.findUnique(...).posts() 查询返回帖子而不是 prisma.posts.findMany() 可能看起来违反直觉 - 特别是前者会产生两个查询而非一个。

需要使用 Fluent API (user.findUnique(...).posts()) 来返回帖子的唯一原因是,Prisma Client 中的 dataloader 会批量处理 findUnique() 查询,但目前不会批量处理 findMany() 查询

当 dataloader 批量处理 findMany() 查询或者您的查询将 relationStrategy 设置为 join 时,您就不再需要以这种方式将 findUnique() 与 Fluent API 结合使用了。

const User = objectType({
name: 'User',
definition(t) {
t.nonNull.int('id')
t.string('name')
t.nonNull.string('email')
t.nonNull.list.nonNull.field('posts', {
type: 'Post',
resolve: (parent, _, context) => {
return context.prisma.post.findMany({
where: { authorId: parent.id || undefined },
})
return context.prisma.user
.findUnique({
where: { id: parent.id || undefined },
})
.posts()
},
})
},
})
显示CLI结果

如果 posts 解析器按用户调用,Prisma Client 中的 dataloader 会将具有相同参数和选择集的 findUnique() 查询进行分组。每组都会被优化成一个单独的 findMany() 查询。

解决方案 2:使用 JOIN 执行查询

您可以通过将 relationLoadStrategy 设置为 "join" 来使用数据库 JOIN 执行查询,确保只对数据库执行一个查询。

const User = objectType({
name: 'User',
definition(t) {
t.nonNull.int('id')
t.string('name')
t.nonNull.string('email')
t.nonNull.list.nonNull.field('posts', {
type: 'Post',
resolve: (parent, _, context) => {
return context.prisma.post.findMany({
relationLoadStrategy: "join",
where: { authorId: parent.id || undefined },
})
},
})
},
})

其他上下文中的 n+1 问题

n+1 问题最常见于 GraphQL 上下文,因为您必须找到一种方法来跨多个解析器优化单个查询。然而,您也可以通过在自己的代码中使用 forEach 循环遍历结果来轻松引入 n+1 问题。

以下代码会导致 n+1 查询 - 一个 findMany() 用于获取所有用户,以及每个用户一个 findMany() 用于获取该用户的帖子

// One query to get all users
const users = await prisma.user.findMany({})

// One query PER USER to get all posts
users.forEach(async (usr) => {
const posts = await prisma.post.findMany({
where: {
authorId: usr.id,
},
})

// Do something with each users' posts
})
显示CLI结果
SELECT "public"."User"."id", "public"."User"."email", "public"."User"."name" FROM "public"."User" WHERE 1=1 OFFSET $1
SELECT "public"."Post"."id", "public"."Post"."title" FROM "public"."Post" WHERE "public"."Post"."authorId" = $1 OFFSET $2
SELECT "public"."Post"."id", "public"."Post"."title" FROM "public"."Post" WHERE "public"."Post"."authorId" = $1 OFFSET $2
SELECT "public"."Post"."id", "public"."Post"."title" FROM "public"."Post" WHERE "public"."Post"."authorId" = $1 OFFSET $2
SELECT "public"."Post"."id", "public"."Post"."title" FROM "public"."Post" WHERE "public"."Post"."authorId" = $1 OFFSET $2
/* ..and so on .. */

这不是一种高效的查询方式。您可以采取以下措施:

使用 include 解决 n+1 问题

您可以使用 include 返回每个用户的帖子。这只会产生两个 SQL 查询 - 一个用于获取用户,一个用于获取帖子。这称为嵌套读取

const usersWithPosts = await prisma.user.findMany({
include: {
posts: true,
},
})
显示CLI结果
SELECT "public"."User"."id", "public"."User"."email", "public"."User"."name" FROM "public"."User" WHERE 1=1 OFFSET $1
SELECT "public"."Post"."id", "public"."Post"."title", "public"."Post"."authorId" FROM "public"."Post" WHERE "public"."Post"."authorId" IN ($1,$2,$3,$4) OFFSET $5

使用 in 解决 n+1 问题

如果您有一个用户 ID 列表,可以使用 in 过滤器返回所有 authorId 在该 ID 列表中的帖子

const users = await prisma.user.findMany({})

const userIds = users.map((x) => x.id)

const posts = await prisma.post.findMany({
where: {
authorId: {
in: userIds,
},
},
})
显示CLI结果
SELECT "public"."User"."id", "public"."User"."email", "public"."User"."name" FROM "public"."User" WHERE 1=1 OFFSET $1
SELECT "public"."Post"."id", "public"."Post"."createdAt", "public"."Post"."updatedAt", "public"."Post"."title", "public"."Post"."content", "public"."Post"."published", "public"."Post"."authorId" FROM "public"."Post" WHERE "public"."Post"."authorId" IN ($1,$2,$3,$4) OFFSET $5

使用 relationLoadStrategy: "join" 解决 n+1 问题

您可以通过将 relationLoadStrategy 设置为 "join" 来使用数据库 JOIN 执行查询,确保只对数据库执行一个查询。

const users = await prisma.user.findMany({})

const userIds = users.map((x) => x.id)

const posts = await prisma.post.findMany({
relationLoadStrategy: "join",
where: {
authorId: {
in: userIds,
},
},
})