编写您自己的 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,您可以
- 使用熟悉的语法编写复杂的 SQL 查询
- 受益于对 SQL 的完整 IDE 支持和语法高亮
- 将您的 SQL 查询作为完全类型化的函数导入到 TypeScript 代码中
- 在保持原始 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 及更高版本中可用。
与关系数据库中的原始查询类似,这些方法不是类型安全的,并且需要手动处理查询结果。