选择字段
概述
默认情况下,当查询返回记录(而不是计数)时,结果包括
- 模型的所有标量字段(包括枚举)
- 模型上定义的无关联
例如,考虑以下模式
model User {
id Int @id @default(autoincrement())
email String @unique
name String?
role Role @default(USER)
posts Post[]
}
model Post {
id Int @id @default(autoincrement())
published Boolean @default(false)
title String
author User? @relation(fields: [authorId], references: [id])
authorId Int?
}
enum Role {
USER
ADMIN
}
对 User
模型的查询将包括 id
、email
、name
和 role
字段(因为这些是标量字段),但不包括 posts
字段(因为那是关联字段)
const users = await prisma.user.findFirst()
{
id: 42,
name: "Sabelle",
email: "[email protected]",
role: "ADMIN"
}
如果您想自定义结果并返回不同的字段组合,您可以
- 使用
select
返回特定字段。您还可以通过选择关联字段来使用嵌套的select
。 - 使用
omit
从结果中排除特定字段。omit
可以看作是select
的“反义词”。 - 使用
include
额外包含关联。
在所有情况下,查询结果都将是静态类型的,确保您不会意外访问您实际上未从数据库查询的任何字段。
选择您需要的字段和关联,而不是依赖默认选择集,可以减小响应大小并提高查询速度。
自 5.9.0 版本起,当使用 include
或通过在关联字段上使用 select
执行关联查询时,您还可以指定 relationLoadStrategy
来决定是使用数据库级联接还是执行多个查询并在应用程序级别合并数据。此功能目前处于预览状态,您可以在此处了解更多信息。
示例模式
本页上的所有以下示例均基于以下模式
model User {
id Int @id
name String?
email String @unique
password String
role Role @default(USER)
coinflips Boolean[]
posts Post[]
profile Profile?
}
model Post {
id Int @id
title String
published Boolean @default(true)
author User @relation(fields: [authorId], references: [id])
authorId Int
}
model Profile {
id Int @id
biography String
user User @relation(fields: [userId], references: [id])
userId Int @unique
}
enum Role {
USER
ADMIN
}
返回默认字段
以下查询返回默认字段(所有标量字段,无关联)
const user = await prisma.user.findFirst()
{
id: 22,
name: "Alice",
email: "[email protected]",
password: "mySecretPassword42"
role: "ADMIN",
coinflips: [true, false],
}
选择特定字段
使用 select
返回字段的子集而不是所有字段。以下示例仅返回 email
和 name
字段
const user = await prisma.user.findFirst({
select: {
email: true,
name: true,
},
})
{
name: "Alice",
email: "[email protected]",
}
通过选择关联字段返回嵌套对象
您还可以通过在关联字段上多次嵌套 select
来返回关联。
以下查询使用嵌套的 select
来选择每个用户的 name
和每个相关帖子的 title
const usersWithPostTitles = await prisma.user.findFirst({
select: {
name: true,
posts: {
select: { title: true },
},
},
})
{
"name":"Sabelle",
"posts":[
{ "title":"Getting started with Azure Functions" },
{ "title":"All about databases" }
]
}
以下查询在 include
中使用 select
,并返回所有用户字段和每个帖子的 title
字段
const usersWithPostTitles = await prisma.user.findFirst({
include: {
posts: {
select: { title: true },
},
},
})
{
id: 9
name: "Sabelle",
email: "[email protected]",
password: "mySecretPassword42",
role: "USER",
coinflips: [],
posts:[
{ title:"Getting started with Azure Functions" },
{ title:"All about databases" }
]
}
您可以任意深度地嵌套查询。以下查询获取
Post
的title
- 相关
User
的name
- 相关
Profile
的biography
const postsWithAuthorsAndProfiles = await prisma.post.findFirst({
select: {
title: true,
author: {
select: {
name: true,
profile: {
select: { biography: true }
}
},
},
},
})
{
id: 9
title:"All about databases",
author: {
name: "Sabelle",.
profile: {
biography: "I like turtles"
}
}
}
在深度嵌套关联时要小心,因为底层数据库查询可能会变慢,因为它需要访问许多不同的表。为了确保您的查询始终具有最佳速度,请考虑使用 Prisma Accelerate 添加缓存层,或使用 Prisma Optimize 获取查询见解和性能优化建议。
有关查询关联的更多信息,请参阅以下文档
排除特定字段
在某些情况下,您可能想要返回模型的大部分字段,仅排除一小部分子集。一个常见的例子是当您查询 User
但出于安全原因想要排除 password
字段时。
在这些情况下,您可以使用 omit
,它可以被视为 select
的对应物
const users = await prisma.user.findFirst({
omit: {
password: true
}
})
{
id: 9
name: "Sabelle",
email: "[email protected]",
profileViews: 90,
role: "USER",
coinflips: [],
}
请注意,返回的对象不包含 password
字段。