过滤和排序
Prisma Client 支持使用 where 查询选项进行过滤,以及使用 orderBy 查询选项进行排序。
过滤
Prisma Client 允许您根据模型字段的任意组合(包括相关模型)过滤记录,并支持各种过滤条件。
某些过滤条件使用 SQL 运算符 LIKE 和 ILIKE,这可能会在您的查询中导致意外行为。请参阅我们的过滤常见问题解答以获取更多信息。
以下查询
- 返回所有满足以下条件的
User记录:- 电子邮件地址以
prisma.io结尾 并且 - 至少有一篇已发布的帖子(一个关系查询)
- 电子邮件地址以
- 返回所有
User字段 - 包括所有相关的
Post记录,其中published等于true
const result = await prisma.user.findMany({
where: {
email: {
endsWith: 'prisma.io',
},
posts: {
some: {
published: true,
},
},
},
include: {
posts: {
where: {
published: true,
},
},
},
})
过滤条件和运算符
请参阅 Prisma Client 的参考文档,获取完整的运算符列表,例如 startsWith 和 contains。
组合运算符
您可以使用运算符(例如NOT 和OR)通过条件组合进行过滤。以下查询返回所有 email 以 gmail.com 或 company.com 结尾的用户,但排除以 admin.company.com 结尾的任何电子邮件
const result = await prisma.user.findMany({
where: {
OR: [
{
email: {
endsWith: 'gmail.com',
},
},
{ email: { endsWith: 'company.com' } },
],
NOT: {
email: {
endsWith: 'admin.company.com',
},
},
},
select: {
email: true,
},
})
过滤空字段
以下查询返回所有 content 字段为 null 的帖子
const posts = await prisma.post.findMany({
where: {
content: null,
},
})
过滤非空字段
以下查询返回所有 content 字段不为 null 的帖子
const posts = await prisma.post.findMany({
where: {
content: { not: null },
},
})
按关系过滤
Prisma Client 支持按相关记录进行过滤。例如,在以下模式中,一个用户可以拥有多个博客帖子
model User {
id Int @id @default(autoincrement())
name String?
email String @unique
posts Post[] // User can have many posts
}
model Post {
id Int @id @default(autoincrement())
title String
published Boolean @default(true)
author User @relation(fields: [authorId], references: [id])
authorId Int
}
User 和 Post 之间的一对多关系允许您根据帖子查询用户——例如,以下查询返回所有至少有一篇帖子(some)的浏览量超过 10 的用户
const result = await prisma.user.findMany({
where: {
posts: {
some: {
views: {
gt: 10,
},
},
},
},
})
您还可以根据作者的属性查询帖子。例如,以下查询返回所有作者的 email 包含 "prisma.io" 的帖子
const res = await prisma.post.findMany({
where: {
author: {
email: {
contains: 'prisma.io',
},
},
},
})
过滤标量列表/数组
标量列表(例如 String[])有一组特殊的过滤条件——例如,以下查询返回所有 tags 数组包含 databases 的帖子
const posts = await client.post.findMany({
where: {
tags: {
has: 'databases',
},
},
})
不区分大小写的过滤
不区分大小写的过滤作为 PostgreSQL 和 MongoDB 提供程序的一项功能提供。MySQL、MariaDB 和 Microsoft SQL Server 默认不区分大小写,不需要 Prisma Client 功能即可实现不区分大小写的过滤。
要使用不区分大小写的过滤,请向特定过滤器添加 mode 属性并指定 insensitive
const users = await prisma.user.findMany({
where: {
email: {
endsWith: 'prisma.io',
mode: 'insensitive', // Default value: default
},
name: {
equals: 'Archibald', // Default mode
},
},
})
另请参阅:大小写敏感性
过滤常见问题解答
过滤在数据库层面如何工作?
对于 MySQL 和 PostgreSQL,Prisma Client 利用 LIKE(和 ILIKE)运算符来搜索给定模式。这些运算符使用 LIKE 特有的符号进行内置模式匹配。模式匹配符号包括 % 代表零个或多个字符(类似于其他正则表达式实现中的 *)和 _ 代表一个字符(类似于 .)
要匹配字面字符 % 或 _,请确保转义这些字符。例如
const users = await prisma.user.findMany({
where: {
name: {
startsWith: '_benny',
},
},
})
上述查询将匹配名字以一个字符后跟 benny 开头的任何用户,例如 7benny 或 &benny。如果您想查找名字以字面字符串 _benny 开头的任何用户,您可以这样做
const users = await prisma.user.findMany({
where: {
name: {
startsWith: '\\_benny', // note that the `_` character is escaped, preceding `\` with `\` when included in a string
},
},
})
排序
使用orderBy 按特定字段或字段集对记录列表或嵌套记录列表进行排序。例如,以下查询返回按 role 和 name 排序的所有 User 记录,并且每个用户的帖子按 title 排序
const usersWithPosts = await prisma.user.findMany({
orderBy: [
{
role: 'desc',
},
{
name: 'desc',
},
],
include: {
posts: {
orderBy: {
title: 'desc',
},
select: {
title: true,
},
},
},
})
注意:您还可以对嵌套记录列表进行排序,以按 ID 检索单个记录。
按关系排序
您还可以按关系的属性进行排序。例如,以下查询按作者的电子邮件地址对所有帖子进行排序
const posts = await prisma.post.findMany({
orderBy: {
author: {
email: 'asc',
},
},
})
按关系聚合值排序
在 2.19.0 及更高版本中,您可以按相关记录的数量进行排序。
例如,以下查询按相关帖子的数量对用户进行排序
const getActiveUsers = await prisma.user.findMany({
take: 10,
orderBy: {
posts: {
_count: 'desc',
},
},
})
注意:目前无法返回关系的数量。
按相关性排序(PostgreSQL 和 MySQL)
在 3.5.0+(适用于 PostgreSQL)和 3.8.0+(适用于 MySQL)中,您可以使用 _relevance 关键字按查询的相关性对记录进行排序。这使用全文搜索功能中的相关性排名函数。
此功能在PostgreSQL 文档和MySQL 文档中进一步解释。
对于 PostgreSQL,您需要使用 fullTextSearchPostgres 预览功能启用按相关性排序
generator client {
provider = "prisma-client"
output = "./generated"
previewFeatures = ["fullTextSearchPostgres"]
}
按相关性排序可以单独使用,也可以与 search 过滤器一起使用:_relevance 用于排序列表,而 search 过滤未排序列表。
例如,以下查询使用 _relevance 在 bio 字段中按术语 developer 过滤,然后按相关性降序对结果进行排序
const getUsersByRelevance = await prisma.user.findMany({
take: 10,
orderBy: {
_relevance: {
fields: ['bio'],
search: 'developer',
sort: 'desc',
},
},
})
在 Prisma ORM 5.16.0 之前,启用 fullTextSearch 预览功能会将 <Model>OrderByWithRelationInput TypeScript 类型重命名为 <Model>OrderByWithRelationAndSearchRelevanceInput。如果您正在使用预览功能,则需要更新您的类型导入。
将空记录排在最前或最后
您可以对结果进行排序,使具有 null 字段的记录显示在最前面或最后面。
如果 name 是可选字段,那么以下使用 last 的查询将按 name 对用户进行排序,并将 null 记录放在末尾
const users = await prisma.user.findMany({
orderBy: {
updatedAt: { sort: 'asc', nulls: 'last' },
},
})
如果您希望 null 值的记录出现在返回数组的开头,请使用 first
const users = await prisma.user.findMany({
orderBy: {
updatedAt: { sort: 'asc', nulls: 'first' },
},
})
请注意,first 也是默认值,因此如果您省略 null 选项,null 值将首先出现在返回数组中。