跳到主要内容

编写自己的 SQL

虽然 Prisma Client API 旨在让您的所有数据库查询直观、类型安全且便捷,但在某些情况下,原始 SQL 仍然是完成工作的最佳工具。

这可能由于多种原因发生,例如需要优化特定查询的性能,或者因为您的数据需求无法通过 Prisma Client 的查询 API 完全表达。

在大多数情况下,TypedSQL 允许您用 SQL 表达查询,同时仍能受益于 Prisma Client 卓越的用户体验。然而,由于 TypedSQL 是静态类型的,它可能无法处理某些场景,例如动态生成的 WHERE 子句。在这种情况下,您需要使用 $queryRaw$executeRaw,或其不安全的对应方法。

使用 Prisma Client 和 TypedSQL 编写类型安全的查询

信息

TypedSQL 在 Prisma ORM 5.19.0 及更高版本中可用。对于早期版本中的原始数据库访问,请参阅我们的原始查询文档

什么是 TypedSQL?

TypedSQL 是 Prisma ORM 的一项新功能,它允许您在 .sql 文件中编写查询,同时仍能享受 Prisma Client 卓越的开发者体验。您可以编写您熟悉的代码,并受益于完全类型的输入和输出。

通过 TypedSQL,您可以

  1. 使用熟悉的语法编写复杂的 SQL 查询
  2. 受益于对 SQL 的完整 IDE 支持和语法高亮
  3. 将您的 SQL 查询作为完全类型的函数导入到您的 TypeScript 代码中
  4. 在保持原始 SQL 灵活性的同时,享有 Prisma 类型系统的安全性

TypedSQL 对于以下情况特别有用

  • 难以使用 Prisma 查询 API 表达的复杂报告查询
  • 需要精细调整 SQL 的性能关键操作
  • 利用 Prisma API 尚未支持的数据库特定功能

通过使用 TypedSQL,您可以编写高效、类型安全的数据库查询,而无需牺牲原始 SQL 的强大功能和灵活性。此功能允许您将自定义 SQL 查询无缝集成到您的由 Prisma 驱动的应用程序中,从而确保类型安全并提高开发者生产力。

有关如何开始使用 TypedSQL 的详细指南,包括安装说明和使用示例,请参阅我们的 TypedSQL 文档

原始查询

在 5.19.0 版本之前,Prisma Client 只支持非类型安全的原始 SQL 查询,并且需要手动将查询结果映射到所需类型。

虽然不如 TypedSQL 人性化,但这些查询仍然受到支持,并且在 TypedSQL 尚未支持某些功能或查询是动态生成的情况下非常有用。

关系数据库中原始 SQL 查询的替代方法

Prisma ORM 支持四种在关系数据库中执行原始 SQL 查询的方法

这些命令与使用 TypedSQL 类似,但它们不是类型安全的,并且是作为字符串写入您的代码中,而不是在专门的 .sql 文件中。

文档数据库中原始查询的替代方法

对于 MongoDB,Prisma ORM 支持三种执行原始查询的方法

这些方法允许您执行原始 MongoDB 命令和查询,在需要使用 MongoDB 特有功能或优化时提供了灵活性。

$runCommandRaw 用于执行数据库命令,<model>.findRaw 用于查找匹配过滤条件的文档,<model>.aggregateRaw 用于聚合操作。这三种方法都从 Prisma 3.9.0 版本及更高版本开始提供。

与关系数据库中的原始查询类似,这些方法不是类型安全的,并且需要手动处理查询结果。