跳到主要内容

分页

Prisma Client 同时支持偏移分页和基于游标的分页。

偏移分页​

偏移分页使用 skip 和 take 来跳过一定数量的结果并选择有限的范围。以下查询跳过前 3 个 Post 记录，并返回记录 4 - 7

const results = await prisma.post.findMany({
  skip: 3,
  take: 4,
})

要实现结果页面，您只需 skip 页面数乘以每页显示的结果数即可。

✔ 偏移分页的优点​

  • 您可以立即跳转到任何页面。例如，您可以 skip 200 条记录并 take 10 条，这模拟了直接跳转到结果集的第 21 页（底层 SQL 使用 OFFSET）。基于游标的分页无法做到这一点。
  • 您可以按任何排序顺序对相同的结果集进行分页。例如，您可以跳转到按名字排序的 User 记录列表的第 21 页。基于游标的分页无法做到这一点，它需要按唯一的顺序排列的列进行排序。

✘ 偏移分页的缺点​

  • 偏移分页在数据库级别无法扩展。 例如，如果您跳过 200,000 条记录并获取前 10 条，数据库仍然必须遍历前 200,000 条记录，然后才能返回您请求的 10 条记录 - 这会对性能产生负面影响。

偏移分页的使用案例​

  • 小型结果集的浅分页。例如，一个博客界面，允许您按作者过滤 Post 记录并对结果进行分页。

示例：过滤和偏移分页​

以下查询返回 email 字段包含 prisma.io 的所有记录。该查询跳过前 40 条记录，并返回记录 41 - 50。

const results = await prisma.post.findMany({
  skip: 40,
  take: 10,
  where: {
    email: {
      contains: 'prisma.io',
    },
  },
})

示例：排序和偏移分页​

以下查询返回 email 字段包含 Prisma 的所有记录，并按 title 字段对结果进行排序。该查询跳过前 200 条记录，并返回记录 201 - 220。

const results = await prisma.post.findMany({
  skip: 200,
  take: 20,
  where: {
    email: {
      contains: 'Prisma',
    },
  },
  orderBy: {
    title: 'desc',
  },
})

基于游标的分页​

基于游标的分页使用 cursor 和 take 返回给定游标之前或之后的有限结果集。游标标记您在结果集中的位置，并且必须是唯一的顺序排列的列 - 例如 ID 或时间戳。

以下示例返回前 4 个包含单词 "Prisma" 的 Post 记录，并将最后一条记录的 ID 保存为 myCursor

注意：由于这是第一个查询，因此没有游标可以传入。

const firstQueryResults = await prisma.post.findMany({
  take: 4,
  where: {
    title: {
      contains: 'Prisma' /* Optional filter */,
    },
  },
  orderBy: {
    id: 'asc',
  },
})

// Bookmark your location in the result set - in this
// case, the ID of the last post in the list of 4.

const lastPostInResults = firstQueryResults[3] // Remember: zero-based index! :)
const myCursor = lastPostInResults.id // Example: 29

下图显示了前 4 个结果（即第 1 页）的 ID。下一个查询的游标是 29

第二个查询返回在提供的游标之后（换句话说 - ID 大于 29）包含单词 "Prisma" 的前 4 个 Post 记录

const secondQueryResults = await prisma.post.findMany({
  take: 4,
  skip: 1, // Skip the cursor
  cursor: {
    id: myCursor,
  },
  where: {
    title: {
      contains: 'Prisma' /* Optional filter */,
    },
  },
  orderBy: {
    id: 'asc',
  },
})

const lastPostInResults = secondQueryResults[3] // Remember: zero-based index! :)
const myCursor = lastPostInResults.id // Example: 52

下图显示了 ID 为 29 的记录之后的前 4 个 Post 记录。在此示例中，新游标为 52

常见问题解答​

我是否总是必须 skip: 1？​

如果您不 skip: 1，您的结果集将包含您之前的游标。第一个查询返回四个结果，游标为 29

如果没有 skip: 1，第二个查询将返回游标之后（包括）的 4 个结果

如果您 skip: 1，则不包括游标

您可以根据您想要的分页行为选择是否 skip: 1。

我可以猜测游标的值吗？​

如果您猜测下一个游标的值，您将分页到结果集中的未知位置。尽管 ID 是顺序的，但您无法预测增量速率（2、20、32 比 1、2、3 更可能，尤其是在过滤后的结果集中）。

基于游标的分页是否在底层数据库中使用游标的概念？​

不，游标分页不在底层数据库中使用游标（例如 PostgreSQL）。

如果游标值不存在会发生什么？​

使用不存在的游标将返回 null。 Prisma Client 不会尝试查找相邻值。

✔ 基于游标的分页的优点​

  • 基于游标的分页是可扩展的。 底层 SQL 不使用 OFFSET，而是查询 ID 大于 cursor 值的所有 Post 记录。

✘ 基于游标的分页的缺点​

  • 您必须按游标排序，游标必须是唯一的顺序排列的列。
  • 您无法仅使用游标跳转到特定页面。 例如，如果不先请求第 1 - 399 页，您无法准确预测哪个游标代表第 400 页的开头（页面大小为 20）。

基于游标的分页的使用案例​

  • 无限滚动 - 例如，按日期/时间降序排序博客文章，一次请求 10 篇博客文章。
  • 分批浏览整个结果集 - 例如，作为长时间运行的数据导出的一部分。

示例：过滤和基于游标的分页​

const secondQuery = await prisma.post.findMany({
  take: 4,
  cursor: {
    id: myCursor,
  },
  where: {
    title: {
      contains: 'Prisma' /* Optional filter */,
    },
  },
  orderBy: {
    id: 'asc',
  },
})

排序和基于游标的分页​

基于游标的分页要求您按顺序排列的唯一列（例如 ID 或时间戳）进行排序。此值（称为游标）标记您在结果集中的位置，并允许您请求下一组。

示例：使用基于游标的分页向后分页​

要向后分页，请将 take 设置为负值。以下查询返回 4 个 id 小于 200 的 Post 记录，不包括游标

const myOldCursor = 200

const firstQueryResults = await prisma.post.findMany({
  take: -4,
  skip: 1,
  cursor: {
    id: myOldCursor,
  },
  where: {
    title: {
      contains: 'Prisma' /* Optional filter */,
    },
  },
  orderBy: {
    id: 'asc',
  },
})