排除字段

默认情况下，Prisma Client 从模型返回所有字段。您可以使用 select 来缩小结果集，但是如果您的模型很大并且您只想排除少量字段，则可能显得笨拙。

信息

从 Prisma ORM 6.2.0 开始，通过您可以传递给 Prisma Client 的 omit 选项支持排除字段。从 5.16.0 到 6.1.0 版本，您必须使用 omitApi 预览功能来访问此选项。

使用 omit 全局排除字段

以下是以类型安全的方式全局排除字段的方法（即针对给定模型的所有查询）

代码

const prisma = new PrismaClient({
  omit: {
    user: {
      password: true
    }
  }
})

// The password field is excluded in all queries, including this one
const user = await prisma.user.findUnique({ where: { id: 1 } })

Schema

model User {
  id        Int      @id @default(autoincrement())
  createdAt DateTime @default(now())
  updatedAt DateTime @updatedAt
  firstName String
  lastName  String
  email     String   @unique
  password  String
}

使用 omit 本地排除字段

以下是以类型安全的方式本地排除字段的方法（即针对单个查询）

代码

const prisma = new PrismaClient()

// The password field is excluded only in this query
const user = await prisma.user.findUnique({
  omit: {
    password: true
  },
  where: { 
    id: 1 
  } 
})

Schema

model User {
  id        Int      @id @default(autoincrement())
  createdAt DateTime @default(now())
  updatedAt DateTime @updatedAt
  firstName String
  lastName  String
  email     String   @unique
  password  String
}

如何省略多个字段

省略多个字段的工作方式与选择多个字段相同：将多个键值对添加到 omit 选项。使用与之前相同的 schema，您可以使用以下方法省略 password 和 email

const prisma = new PrismaClient()

// password and email are excluded
const user = await prisma.user.findUnique({
  omit: {
    email: true,
    password: true,
  },
  where: {
    id: 1,
  },
})

多个字段可以在本地和全局省略。

如何选择先前省略的字段

如果您全局省略字段，您可以通过专门选择该字段或在查询中将 omit 设置为 false 来“覆盖”。

显式选择

const user = await prisma.user.findUnique({
  select: {
    firstName: true,
    lastName: true,
    password: true // The password field is now selected.
  },
  where: {
    id: 1
  }
})

省略 False

const user = await prisma.user.findUnique({
  omit: {
    password: false // The password field is now selected.
  },
  where: {
    id: 1
  }
})

何时全局或本地使用 omit

重要的是要了解何时全局或本地省略字段

• 如果您省略字段是为了防止它意外地包含在查询中，则最好全局省略它。例如：全局省略 User 模型中的 password 字段，以防止敏感信息意外泄露。
• 如果您省略字段是因为查询中不需要它，则最好本地省略它。

本地 omit（当在查询中提供 omit 选项时）仅适用于定义它的查询，而全局 omit 适用于使用同一 Prisma Client 实例发出的每个查询，除非使用了特定的 select 或 omit 被覆盖。