Select fields (Prisma ORM v6) (/docs/orm/v6/prisma-client/queries/select-fields)
For the complete Prisma documentation index, see llms.txt. A markdown version of any docs page is available by appending
.mdto its URL.
This page explains how to select only a subset of a model's fields and/or include relations ("eager loading") in a Prisma Client query.
Location: ORM > v6 > Prisma Client > Queries > Select fields
Overview
Section titled “Overview”By default, when a query returns records (as opposed to a count), the result includes:
- All scalar fields of a model (including enums)
- No relations defined on a model
As an example, consider this schema:
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
}A query to the User model will include the id, email, name and role fields (because these are scalar fields), but not the posts field (because that's a relation field):
const users = await prisma.user.findFirst();{
id: 42,
name: "Sabelle",
email: "sabelle@prisma.io",
role: "ADMIN"
}If you want to customize the result and have a different combination of fields returned, you can:
- Use
selectto return specific fields. You can also use a nestedselectby selecting relation fields. - Use
omitto exclude specific fields from the result.omitcan be seen as the "opposite" toselect. - Use
includeto additionally include relations.
In all cases, the query result will be statically typed, ensuring that you don't accidentally access any fields that you did not actually query from the database.
Selecting only the fields and relations that you require rather than relying on the default selection set can reduce the size of the response and improve query speed.
Since version 5.9.0, when doing a relation query with include or by using select on a relation field, you can also specify the relationLoadStrategy to decide whether you want to use a database-level join or perform multiple queries and merge the data on the application level. This feature is currently in Preview, you can learn more about it in Relation load strategies (Preview).
Example schema
Section titled “Example schema”All following examples on this page are based on the following schema:
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
}Return the default fields
Section titled “Return the default fields”The following query returns the default fields (all scalar fields, no relations):
const user = await prisma.user.findFirst();{
id: 22,
name: "Alice",
email: "alice@prisma.io",
password: "mySecretPassword42"
role: "ADMIN",
coinflips: [true, false],
}Select specific fields
Section titled “Select specific fields”Use select to return a subset of fields instead of all fields. The following example returns the email and name fields only:
const user = await prisma.user.findFirst({
select: {
email: true,
name: true,
},
});{
name: "Alice",
email: "alice@prisma.io",
}Return nested objects by selecting relation fields
Section titled “Return nested objects by selecting relation fields”You can also return relations by nesting select multiple times on relation fields.
The following query uses a nested select to select each user's name and the title of each related post:
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" }
]
}The following query uses select within an include, and returns all user fields and each post's title field:
const usersWithPostTitles = await prisma.user.findFirst({
include: {
posts: {
select: { title: true },
},
},
});{
id: 9
name: "Sabelle",
email: "sabelle@prisma.io",
password: "mySecretPassword42",
role: "USER",
coinflips: [],
posts:[
{ title:"Getting started with Azure Functions" },
{ title:"All about databases" }
]
}You can nest your queries arbitrarily deep. The following query fetches:
- the
titleof aPost - the
nameof the relatedUser - the
biographyof the relatedProfile
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"
}
}
}[!NOTE] Be careful when deeply nesting relations because the underlying database query may become slow due to it needing to access a lot of different tables. To keep these queries fast, consider adding a caching layer with Prisma Accelerate, or use Query Insights to identify slow queries and optimize them.
For more information about querying relations, refer to the following documentation:
Omit specific fields
Section titled “Omit specific fields”There may be situations when you want to return most fields of a model, excluding only a small subset. A common example for this is when you query a User but want to exclude the password field for security reasons.
In these cases, you can use omit, which can be seen as the counterpart to select:
const users = await prisma.user.findFirst({
omit: {
password: true,
},
});{
id: 9
name: "Sabelle",
email: "sabelle@prisma.io",
profileViews: 90,
role: "USER",
coinflips: [],
}Notice how the returned object does not contain the password field.
Relation count
Section titled “Relation count”In 3.0.1 and later, you can include or select a count of relations alongside fields. For example, a user's post count.
Related pages
Section titled “Related pages”Aggregation, grouping, and summarizing: Use Prisma Client to aggregate, group by, count, and select distinct.Case sensitivity: How Prisma Client handles case sensitivity when filtering and sorting.Computed fields: This page explains how to use client extensions to add computed fields to Prisma models.CRUD: How to perform CRUD with Prisma Client.Custom models: This page explains how to wrap Prisma Client in custom models