Prisma关系查询：如何使用include获取关联数据

理解Prisma关系查询的默认行为

在使用prisma进行数据库操作时，一个常见的误解是，当您定义了模型之间的关系（例如，一对多或多对多），查询主模型时会自动带回所有关联数据。然而，prisma的设计哲学倾向于性能优化和显式控制。默认情况下，prisma查询只会返回当前模型的数据，而不会自动加载其关联模型的数据。

例如，在以下Prisma Schema中，ShoppingList模型与ShoppingListItem模型之间存在一对多的关系：

model ShoppingListItem {
  id             String       @id @default(cuid())
  name           String
  shoppingList   ShoppingList @relation(fields: [shoppingListId], references: [id])
  shoppingListId String
  // ... 其他字段
}

model ShoppingList {
  id          String             @id @default(cuid())
  name        String
  items       ShoppingListItem[] // 定义了与ShoppingListItem的关系
  testArray   String[]           // 一个简单的字符串数组字段
  // ... 其他字段
}

当您执行一个针对ShoppingList的查询，例如：

const list = await prisma.shoppingList.findUnique({
  where: {
    id: input.id,
  },
});

您可能会发现，尽管ShoppingList模型中定义了items ShoppingListItem[]这个字段，但返回的list对象中却不包含items数组（无论是空数组还是包含数据的数组）。然而，像testArray这种直接定义在模型上的原始类型数组字段，却会正常返回。这是因为items是一个关系字段，它代表了与另一个模型（ShoppingListItem）的关联，而testArray只是ShoppingList模型自身的一个属性。

Prisma之所以采取这种默认行为，是为了避免不必要的数据加载，从而提高查询性能。如果每次查询都自动加载所有关联数据，可能会导致返回大量冗余信息，尤其是在复杂的数据模型中。因此，Prisma要求您明确指定需要加载哪些关联数据。

解决方案：使用include选项

要解决上述问题，即在查询主模型时获取其关联模型的数据，您需要使用Prisma查询的include选项。include选项允许您显式地指定要包含在查询结果中的关联关系。

将之前的shoppingList.findUnique查询修改为：

const list = await prisma.shoppingList.findUnique({
  where: {
    id: input.id,
  },
  include: {
    items: true // 明确指定包含 'items' 关联数据
  }
});

通过添加include: { items: true }，Prisma会在执行查询时，同时从ShoppingListItem表中获取与当前ShoppingList关联的所有ShoppingListItem记录，并将它们作为items数组添加到返回的list对象中。

Prisma

Prisma是一款照片编辑工具，用户可以轻松地将照片转换成数字艺术。

50

查看详情

深入理解include的用法

include选项不仅限于简单的布尔值true，它还支持更复杂的配置，以满足不同的数据加载需求。

1. 嵌套关联（Nested Includes）

如果您的关联模型自身也包含其他关联，您可以进行嵌套include。例如，如果ShoppingListItem模型还有一个与User模型关联的addedBy字段，您可以在查询ShoppingList时同时包含items及其addedBy信息：

const list = await prisma.shoppingList.findUnique({
  where: {
    id: input.id,
  },
  include: {
    items: {
      include: {
        addedBy: true // 嵌套包含 ShoppingListItem 的 addedBy 关系
      }
    }
  }
});

2. 选择性字段（Selective Fields within include）

有时您不需要关联模型的所有字段，而只希望获取其中的一部分。您可以在include内部使用select选项来指定要包含的字段：

const list = await prisma.shoppingList.findUnique({
  where: {
    id: input.id,
  },
  include: {
    items: {
      select: {
        id: true,
        name: true,
        markedDone: true // 只选择 items 的 id, name, markedDone 字段
      }
    }
  }
});

这有助于减少数据传输量，提高查询效率。

3. 结合where、orderBy、take、skip等选项

您还可以在include的关联查询中应用过滤、排序和分页等操作，这对于处理大量关联数据非常有用：

const list = await prisma.shoppingList.findUnique({
  where: {
    id: input.id,
  },
  include: {
    items: {
      where: {
        markedDone: false // 只包含未完成的购物项
      },
      orderBy: {
        createdAt: 'asc' // 按创建时间升序排列
      },
      take: 10 // 最多获取10个购物项
    }
  }
});

最佳实践与注意事项

• 性能考量：虽然include非常方便，但过度使用或嵌套过深可能会导致性能问题，尤其是在涉及大量数据或多层嵌套关系时。每次include都会触发额外的数据库联接（JOIN）操作。
• select与include的优先级：
  • 在顶层查询中，select和include不能同时用于同一个字段。例如，您不能同时select: { items: true }和include: { items: true }。
  • 如果您在顶层使用了select来选择特定字段，并且这些字段中包含关系字段，那么您需要在这个关系字段内部使用include来加载其关联数据。
  • 通常，如果您需要获取所有字段，但要包含特定关联，使用include是合适的。如果您只需要特定字段（包括某些关联的特定字段），则可以考虑在顶层使用select，并在select内部嵌套include或select来精细控制。
• 按需加载 vs. 预加载：include实现了“预加载”（Eager Loading），即在主查询中一次性加载所有关联数据。对于某些场景，如果关联数据不总是需要，或者数据量非常大，可以考虑“按需加载”（Lazy Loading），即在需要时再单独执行查询来获取关联数据。但Prisma本身不直接支持传统的延迟加载模式，include是其主要的关系数据加载方式。
• 清晰的Schema定义：确保您的Prisma Schema清晰地定义了模型之间的关系，这是include选项能够正确工作的基础。

总结

Prisma的include选项是处理模型间关系查询的核心工具。它允许开发者精确控制哪些关联数据需要被加载，从而平衡数据完整性与查询性能。理解并熟练运用include，包括其基本用法、嵌套关联以及与select等选项的结合，是高效使用Prisma进行数据操作的关键。始终记住，显式地指定所需数据，是编写高性能、可维护的Prisma查询的最佳实践。

以上就是Prisma关系查询：如何使用include获取关联数据的详细内容，更多请关注php中文网其它相关文章！