跳至主要内容

Null 和 Undefined

警告

在 Prisma ORM 5.20.0 之前，undefined 被视为一个特殊值，不会包含在生成的查询中。这种行为可能导致意外结果和数据丢失。如果您使用的是旧版本的 Prisma ORM，我们强烈建议您更新到 5.20.0 或更高版本，以利用新的 strictUndefinedChecks 功能。

有关旧行为的文档，请参见 旧行为。

严格的 undefined 检查（预览功能）​

Prisma ORM 5.20.0 引入了一种名为 strictUndefinedChecks 的新预览功能。此功能改变了 Prisma Client 处理 undefined 值的方式，提供了更好的保护，防止意外数据丢失或意外查询行为。

启用严格的 undefined 检查​

要启用此功能，请在您的 Prisma 模式中添加以下内容

generator client {
  provider        = "prisma-client-js"
  previewFeatures = ["strictUndefinedChecks"]
}

使用严格的 undefined 检查​

启用此功能后

  1. 在查询中将字段显式设置为 undefined 将导致运行时错误。
  2. 要在查询中跳过字段，请使用新的 Prisma.skip 符号，而不是 undefined。

使用示例

// This will throw an error
prisma.user.create({
  data: {
    name: 'Alice',
    email: undefined // Error: Cannot explicitly use undefined here
  }
})

// Use `Prisma.skip` (a symbol provided by Prisma) to omit a field
prisma.user.create({
  data: {
    name: 'Alice',
    email: Prisma.skip // This field will be omitted from the query
  }
})

此更改有助于防止意外删除或更新，例如

// Before: This would delete all users
prisma.user.deleteMany({
  where: {
    id: undefined
  }
})

// After: This will throw an error
Invalid \`prisma.user.deleteMany()\` invocation in
/client/tests/functional/strictUndefinedChecks/test.ts:0:0
  XX })
  XX 
  XX test('throws on undefined input field', async () => {
→ XX   const result = prisma.user.deleteMany({
         where: {
           id: undefined
               ~~~~~~~~~
         }
       })
Invalid value for argument \`where\`: explicitly \`undefined\` values are not allowed."

迁移路径​

要迁移现有代码

// Before
let optionalEmail: string | undefined

prisma.user.create({
  data: {
    name: 'Alice',
    email: optionalEmail
  }
})

// After
prisma.user.create({
  data: {
    name: 'Alice',
    email: optionalEmail ?? Prisma.skip
  }
})

这种新行为旨在成为 Prisma ORM 6 中的默认行为。

exactOptionalPropertyTypes​

除了 strictUndefinedChecks 之外，我们还建议您启用 TypeScript 编译器选项 exactOptionalPropertyTypes。此选项强制执行可选属性必须完全匹配，这有助于在您的代码中发现与 undefined 值相关的潜在问题。虽然 strictUndefinedChecks 会在运行时针对无效的 undefined 使用引发错误，但 exactOptionalPropertyTypes 会在构建过程中捕获这些问题。

在 TypeScript 文档 中了解有关 exactOptionalPropertyTypes 的更多信息。

反馈​

与往常一样，我们欢迎您对此功能的反馈。请在 此预览功能的 GitHub 讨论 中分享您的想法和建议。

旧行为​

警告

如果您使用的是 Prisma ORM 5.19.1 或更早版本，此部分与您相关。

Prisma Client 区分 null 和 undefined

  • null 是一个值
  • undefined 表示不执行任何操作
信息

在 带 GraphQL 上下文的 Prisma ORM 中，null 和 undefined 可以互换，这一点尤其重要。

以下数据表示一个 User 表。此数据集将在以下所有示例中使用

idnameemail
1Nikolas[email protected]
2Martin[email protected]
3empty[email protected]
4Tyler[email protected]

null 和 undefined 在影响多个记录的查询中​

本节将介绍 undefined 和 null 值如何影响与数据库中多个记录交互或创建多个记录的查询的行为。

Null​

考虑以下 Prisma Client 查询，该查询搜索所有 name 值与提供的 null 值匹配的用户

const users = await prisma.user.findMany({
  where: {
    name: null,
  },
})
显示查询结果
[
  {
    "id": 3,
    "name": null,
    "email": "[email protected]"
  }
]

由于 null 被用作 name 列的过滤器，Prisma Client 将生成一个查询，该查询搜索 User 表中 name 列为空的所有记录。

Undefined​

现在考虑一下您使用 undefined 作为 name 列上的过滤器值的相同查询的情况

const users = await prisma.user.findMany({
  where: {
    name: undefined,
  },
})
显示查询结果
[
  {
    "id": 1,
    "name": "Nikolas",
    "email": "[email protected]"
  },
  {
    "id": 2,
    "name": "Martin",
    "email": "[email protected]"
  },
  {
    "id": 3,
    "name": null,
    "email": "[email protected]"
  },
  {
    "id": 4,
    "name": "Tyler",
    "email": "[email protected]"
  }
]

在过滤器中使用 undefined 作为值实际上告诉 Prisma Client 您已决定不为该列定义过滤器。

编写上述查询的另一种等效方法是

const users = await prisma.user.findMany()

此查询将从 User 表中选择每一行。

信息

注意：在 Prisma Client 查询的参数对象中，将任何键的值设置为 undefined 将导致 Prisma ORM 就像该键根本未提供一样。

虽然本节的示例侧重于 findMany 函数，但相同的概念适用于任何可能影响多个记录的函数，例如 updateMany 和 deleteMany。

null 和 undefined 在影响一个记录的查询中​

本节将介绍 undefined 和 null 值如何影响与数据库中单个记录交互或创建单个记录的查询的行为。

警告

注意：null 不是 findUnique() 查询中的有效过滤器值。

在影响单个记录的查询的过滤器条件中使用 null 和 undefined 时，查询行为与上一节中描述的行为非常相似。

Null​

考虑以下查询，其中 null 用于过滤 name 列

const user = await prisma.user.findFirst({
  where: {
    name: null,
  },
})
显示查询结果
[
  {
    "id": 3,
    "name": null,
    "email": "[email protected]"
  }
]

由于 null 被用作 name 列上的过滤器，Prisma Client 将生成一个查询，该查询搜索 User 表中 name 值为空的第一条记录。

Undefined​

如果使用 undefined 作为 name 列上的过滤器值，则查询的行为就像没有向该列传递任何过滤器条件一样。

考虑以下查询

const user = await prisma.user.findFirst({
  where: {
    name: undefined,
  },
})
显示查询结果
[
  {
    "id": 1,
    "name": "Nikolas",
    "email": "[email protected]"
  }
]

在这种情况下，查询将返回数据库中的第一条记录。

表示上述查询的另一种方法是

const user = await prisma.user.findFirst()

虽然本节的示例侧重于 findFirst 函数，但相同的概念适用于任何影响单个记录的函数。

null 和 undefined 在 GraphQL 解析器中​

对于此示例，请考虑以下 Prisma 模式为基础的数据库

model User {
  id    Int     @id @default(autoincrement())
  email String  @unique
  name  String?
}

在以下更新用户的 GraphQL 变异中，authorEmail 和 name 都接受 null。从 GraphQL 的角度来看，这意味着字段是可选的

type Mutation {
  // Update author's email or name, or both - or neither!
  updateUser(id: Int!, authorEmail: String, authorName: String): User!
}

但是，如果您将 authorEmail 或 authorName 的 null 值传递给 Prisma Client，则将发生以下情况

  • 如果 args.authorEmail 为 null，则查询将失败。email 不接受 null。
  • 如果 args.authorName 为 null，Prisma Client 会将 name 的值更改为 null。这可能不是你希望的更新方式。
updateUser: (parent, args, ctx: Context) => {
  return ctx.prisma.user.update({
    where: { id: Number(args.id) },
    data: {
      email: args.authorEmail, // email cannot be null
      name: args.authorName // name set to null - potentially unwanted behavior
    },
  })
},

相反，如果输入值为 null，请将 email 和 name 的值设置为 undefined。这样做等同于完全不更新该字段。

updateUser: (parent, args, ctx: Context) => {
  return ctx.prisma.user.update({
    where: { id: Number(args.id) },
    data: {
      email: args.authorEmail != null ? args.authorEmail : undefined, // If null, do nothing
      name: args.authorName != null ? args.authorName : undefined // If null, do nothing
    },
  })
},

null 和 undefined 对条件语句的影响​

使用条件语句进行过滤有一些注意事项，可能会产生意想不到的结果。使用条件语句进行过滤时，你可能期望得到一个结果，但由于 Prisma Client 对可空值的处理方式，你可能会收到另一个结果。

下表提供了不同运算符如何处理 0、1 和 n 过滤器的高级概述。

运算符0 过滤器1 过滤器n 过滤器
OR返回空列表验证单个过滤器验证所有过滤器
AND返回所有项目验证单个过滤器验证所有过滤器
NOT返回所有项目验证单个过滤器验证所有过滤器

此示例展示了 undefined 参数如何影响使用 OR 运算符的查询返回的结果。

interface FormData {
  name: string
  email?: string
}

const formData: FormData = {
  name: 'Emelie',
}

const users = await prisma.user.findMany({
  where: {
    OR: [
      {
        email: {
          contains: formData.email,
        },
      },
    ],
  },
})

// returns: []

查询从 formData 对象接收过滤器，该对象包含一个可选的 email 属性。在本例中，email 属性的值为 undefined。运行此查询时，不会返回任何数据。

这与 AND 和 NOT 运算符形成对比，这两个运算符都会在传入 undefined 值时返回所有用户。

这是因为将 undefined 值传递给 AND 或 NOT 运算符等同于完全不传递任何值，这意味着示例中的 findMany 查询将毫无过滤地运行，并返回所有用户。

interface FormData {
  name: string
  email?: string
}

const formData: FormData = {
  name: 'Emelie',
}

const users = await prisma.user.findMany({
  where: {
    AND: [
      {
        email: {
          contains: formData.email,
        },
      },
    ],
  },
})

// returns: { id: 1, email: '[email protected]', name: 'Emelie' }

const users = await prisma.user.findMany({
  where: {
    NOT: [
      {
        email: {
          contains: formData.email,
        },
      },
    ],
  },
})

// returns: { id: 1, email: '[email protected]', name: 'Emelie' }