Prisma Schema Language：定义数据的最佳方式

什么是 Prisma Schema Language (PSL)？

Prisma Schema Language (PSL) 是一种领域特定语言，专为定义数据库 schema 而设计。其语法简洁、可读，专注于建模数据库实体和关系。下面的代码片段展示了两个模型：User 和 Post。每个 User 可以拥有多个 Posts，每个 Post 都有一个作者。使用 Prisma ORM，您可以在代码中使用 user.posts 和 post.author 来引用这些关系。

什么是基于 TypeScript 的 schema 定义？

一些 ORM 允许您使用 TypeScript 定义 schema 并利用该语言的类型系统。虽然这种方法可以尽可能多地使用 TypeScript 编写应用程序，但它通常会导致定义更加冗长、样板代码更多，从而更难以维护、理解和协作。

与前一段描述的 Prisma schema 相比，在 TypeScript 中定义字段需要了解 varchar 和 serial 等低级构造。此外，关系不是双向定义的，所以在 Users 上没有迹象表明存在 Posts。

虽然基于 TypeScript 的 schema 灵活，但学习曲线陡峭，因为您必须学习许多不同的字段类型并查看多个表才能理解数据库结构。这可能会延缓新团队成员或非开发人员快速有效地工作。

Prisma Schema Language 与 TypeScript schema 如何比较？

简洁性和可访问性

PSL

Prisma Schema Language 的声明式语法专为数据库建模而设计。使用它，您可以清晰简洁地定义模型、约束和默认值。

在此模型中，我们可以看到 id 作为主键，以及 name、price 和 isAvailable。所有字段一目了然，无论是专家还是新手（甚至非技术人员）团队成员都能轻松理解。

基于 TypeScript 的 schema

相比之下，在 TypeScript 中定义相同的模型需要多次函数调用和更详细的配置，这增加了复杂性。

要点：PSL 提供了一种更清晰、更易于访问的方法，减少了对重复样板代码的需求。PSL 更适合技术水平混合的团队，包括技术成员和非技术成员。

轻松建模关系

PSL 的一个主要优势在于其定义模型间关系的直接方法。无论您定义的是一对多、一对一还是多对多关系，PSL 都提供了一种清晰直观的语法。

PSL 中的一对多关系

在 PSL 中，定义一对多关系就像在数组中列出相关模型一样简单。例如，一个 User 拥有多个 Posts

这里，关系很清楚：一个用户可以拥有多篇文章，每篇文章通过定义的关系指向其作者。

PSL 中的多对多关系

对于多对多关系，PSL 利用隐式连接表来保持简洁

在此示例中，PSL 自动处理多对多关系，无需额外的样板代码，使得定义复杂关联变得容易。

基于 TypeScript 的 schema 比较

虽然在基于 TypeScript 的 schema 中可以建模类似的关系，但这种方法通常涉及更冗长的配置和多次函数调用

此代码的输出等同于前两个 PSL 代码片段：用户和文章之间存在一对多关系（一个用户可以有多篇文章，但每篇文章只有一个用户），学生和课程之间存在多对多关系（每个学生可以有多个课程，反之亦然）。

然而，这些关系并非双向定义，并且多对多关系需要显式的连接表，这增加了 schema 的复杂性。

要点：PSL 专用于关系的语法简化了您的 schema，减少了样板代码，并使得模型之间的关联立即清晰明了。

团队成员之间的协作

PSL

Prisma Schema Language 简单易读的语法使得非技术利益相关者（如产品经理和数据分析师）能够轻松理解、审查 schema 并为其讨论做出贡献。这意味着更多团队成员在应用程序设计过程开始时就能达成共识。

基于 TypeScript 的 schema

基于 TypeScript 的定义天生与代码相关，对于没有开发背景的人来说可能会望而生畏。

要点：PSL 的可读性使其更适合需要技术和非技术成员共同输入的团队。

开发者体验和生产力

Prisma Client

与 Prisma CLI 的集成简化了许多开发任务。验证和格式化您的 schema，生成数据库迁移，甚至使用可视化工具管理您的数据！

另一个好处是自动创建 Prisma Client：一个完全类型安全的数据库 API。使用 Prisma Client，您的查询不仅清晰，还带有自动完成和编译时类型生成功能，提升了开发者的信心。

基于 TypeScript 的 schema

相比之下，许多基于 TypeScript 的 ORM 需要额外的配置。开发者通常需要手动编写迁移脚本，并且它们的查询 API 更为冗长。例如，一个类似的查询可能需要多次方法调用，不够直观

虽然功能上可行，但这缺乏生成的类型安全性，并且可能需要更多样板代码才能达到相同的结果。

要点：通过自动化客户端生成等任务，PSL 帮助开发者专注于构建功能，而不是管理配置开销——从而实现更高效、更不易出错的开发流程。

标准化和一致性

PSL

Prisma Schema Language 强制执行一致的数据库 schema 格式。这减少了团队成员之间的风格冲突，并使代码对您的工程团队中的任何人来说都更容易阅读、理解和维护。

基于 TypeScript 的 schema

另一方面，由于并非所有工程团队成员的技能水平都相同，TypeScript 定义可能导致团队中的实现不一致。

要点：PSL 的强制结构确保了整个项目 schema 设计的统一性和可维护性。

利用 AI 和 AI 增强型 IDE

随着 AI 驱动的开发工具兴起，了解您的 schema 与 LLM 和 AI 增强型 IDE 的配合程度非常重要。

PSL 与 AI 集成

PSL 清晰一致的语法与 LLM 配合良好，适用于调试或 schema 迁移等任务。其结构使得 LLM 易于理解 schema 并建议更改，例如更新关系或添加模型，而无需太多额外信息。

像 GitHub Copilot 这样的 AI 驱动的 IDE 扩展在使用 PSL 时可以提供更准确的自动完成和上下文感知建议，减少了修改的需求。因此，如果用户对 AI 平台生成的 schema 定义不完全满意，系统可以直接将基于 PSL 的 schema 呈现给用户进行手动编辑。这种方法允许用户进行精确修改，而无需依赖重复的提示来优化输出。通过直接访问结构化的 schema，AI 简化了工作流程，最大程度地减少了用户和代理之间不必要的提示，同时为用户提供了对其数据库设计的更大控制权。

基于 TypeScript 的 schema 与 AI 集成

相反，基于 TypeScript 的 schema 更为冗长，并且遵循不同的模式。这使得 LLM 更难理解 schema，导致建议的可靠性较低，需要更多解释。

如果由 LLM 生成基于 TypeScript 的 schema，工程师往往不容易理解，而 PSL 的设计目标是一目了然。

要点：PSL 的简洁性和清晰的结构使其成为与 LLM 和 AI 增强型 IDE 协同工作的理想选择，进一步提升了开发者的生产力。

总结

为什么选择 PSL？

• 简洁性和清晰度：PSL 的声明式语法最大程度地减少了样板代码，使得 schema 易于编写、阅读和维护。
• 轻松的关系建模：正如演示所示，PSL 擅长定义模型之间的关系——无论是一对多还是多对多——无需不必要的复杂性。
• 跨领域可访问性：其直观的格式使得技术和非技术利益相关者都能理解 schema 并为其做出贡献。
• 开发者生产力：与 Prisma 工具的无缝集成自动化了许多繁琐的任务，让开发者能够专注于产品开发。
• 一致的标准：统一的语言确保您的整个团队遵循相同清晰的约定。
• 增强的 AI 集成：PSL 的结构支持 LLM 和 AI 增强型 IDE，使得生成、修改和调试 schema 定义更加容易。

何时可能更倾向于使用基于 TypeScript 的 schema？

• 灵活性：对于需要动态、程序化调整 schema 的高度专业化场景，TypeScript 的灵活性可能更具优势。
• 统一的代码库：已经大量使用 TypeScript 的团队可能更倾向于将所有定义保留在一种语言中。

总的来说，Prisma Schema Language 是现代团队开发更好的选择。它提供了清晰易读的 schema、简单的关系建模和出色的开发者体验。

准备好简化您的数据库 schema 了吗？查阅我们的文档以开始使用。