使用 Prisma Optimize 进行查询优化
本指南展示了如何识别和优化查询性能、调试性能问题以及解决常见挑战。
调试性能问题
一些常见做法会导致查询缓慢和性能问题,例如:
- 过度获取数据
- 缺少索引
- 未缓存重复查询
- 执行全表扫描
有关性能问题的更多潜在原因,请访问此页面。
Prisma Optimize 提供建议,以识别和解决上述以及更多低效率问题,从而帮助提高查询性能。
要开始使用,请遵循集成指南,并将 Prisma Optimize 添加到您的项目中,以开始诊断慢查询。
您还可以在客户端级别记录查询事件,以查看生成的查询、其参数和执行时间。
使用批量查询
通常,批量读写大量数据性能更高——例如,以 1000 条记录的批次插入 50,000 条记录,而不是作为 50,000 个单独的插入。PrismaClient 支持以下批量查询:
重用 PrismaClient 或使用连接池以避免数据库连接池耗尽
创建 PrismaClient 的多个实例可能会耗尽您的数据库连接池,尤其是在无服务器或边缘环境中,这可能会降低其他查询的速度。在无服务器挑战中了解更多信息。
对于具有传统服务器的应用程序,请实例化 PrismaClient 一次并在整个应用程序中重用它,而不是创建多个实例。例如, вместо
async function getPosts() {
const prisma = new PrismaClient()
await prisma.post.findMany()
}
async function getUsers() {
const prisma = new PrismaClient()
await prisma.user.findMany()
}
在专用文件中定义单个 PrismaClient 实例并重新导出以供重用
export const prisma = new PrismaClient()
然后导入共享实例
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 的数据加载器在 GraphQL 中解决 n+1 问题
如果满足以下条件,Prisma Client 数据加载器会自动将发生在同一tick中且具有相同 where 和 include 参数的 findUnique() 查询进行批处理:
where过滤器的所有条件都在您查询的同一模型的标量字段(唯一或非唯一)上。- 所有条件都使用
equal过滤器,无论是通过简写还是显式语法(where: { field:。, field1: { equals: } }) - 不存在布尔运算符或关系过滤器。
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 },
})
},
})
},
})
解决方案 1:使用流式 API 批量查询
使用 findUnique() 结合流式 API (.posts())(如所示)返回用户的帖子。即使解析器为每个用户调用一次,Prisma Client 中的 Prisma 数据加载器也会 ✔ 批量处理 findUnique() 查询。
使用 prisma.user.findUnique(...).posts() 查询来返回帖子而不是 prisma.posts.findMany() 可能看起来违反直觉——特别是前者会产生两个查询而不是一个。
您需要使用流式 API (user.findUnique(...).posts()) 返回帖子的唯一原因是 Prisma Client 中的数据加载器会批量处理 findUnique() 查询,目前不批量处理 findMany() 查询。
当数据加载器批量处理 findMany() 查询或您的查询将 relationStrategy 设置为 join 时,您不再需要以这种方式使用带流式 API 的 findUnique()。
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()
},
})
},
})
如果 posts 解析器为每个用户调用一次,Prisma Client 中的数据加载器会将具有相同参数和选择集的 findUnique() 查询分组。每个组都被优化为一个 findMany()。
解决方案 2:使用 JOIN 执行查询
您可以通过将 relationLoadStrategy 设置为 "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
})
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)返回用户和相关帖子 - 使用
in过滤器 - 将
relationLoadStrategy设置为"join"
使用 include 解决 n+1 问题
您可以使用 include 返回每个用户的帖子。这只会导致两个 SQL 查询——一个用于获取用户,一个用于获取帖子。这被称为嵌套读取。
const usersWithPosts = await prisma.user.findMany({
include: {
posts: true,
},
})
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,
},
},
})
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" 来执行数据库连接查询,确保只对数据库执行一个查询。
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,
},
},
})