简介
Prisma 是一款强大的数据库 ORM 工具,它的核心特点是类型安全和标准化数据模型定义。Prisma 通过处理代理(例如连接、认证和跟踪更改等)以及自动生成安全 SQL 来访问你的数据库。我们这篇文章主要介绍 Prisma 的一个相关 npm 包——prisma-yml。
prisma-yml 是针对 Prisma 的一种协作形式,通过将 Prisma 架构作为 YML 文件定义,使得架构定义能够在组织中广泛共享和协作。该包支持将 YML 定义转换为 Prisma 数据库架构,并支持在将 Prisma 数据库架构转换为 YML 定义时指定版本信息。在文章中,我们主要介绍该 npm 包的使用详解。
安装
在你的项目中通过 npm 安装 prisma-yml。
npm install prisma-yml --save-dev
转换 Prisma 存储库并生成 YML
假设你对称数据的 my-awesome-database
储存库,通过 prisma-yml
npm 包可以将其映射并转换为 YML。运行以下命令:
npx prisma-yml init my-awesome-database
此命令在内部使用本地安装的 Prisma CLI 代理。
该命令在当前目录下创建了一个 my-awesome-database.yml
文件,其中包含了完整的储存库定义。
-- -------------------- ---- ------- -------- --- ---------- - ---------- -- - -------- - ------- --- - ------------------- - --------- ------ - -------- - ------------------ - ----- ---- - -- --- --- ------------------------- ---- ------ -展开代码
转换 YML 并创建 Prisma 模型
例如,将 my-awesome-database.yml
转换回 Prisma 模型:
npx prisma-yml compile my-awesome-database.yml
此命令输出转换后的 Prisma 模型。可以通过命令行或程序化方式(例如,在 Skaffold 构建或 CI/CD 流水线中)使用该项目。
import { PrismaClient } from '@prisma/client'; const db = new PrismaClient();
结论
在本文中,我们详细介绍了 npm 包 prisma-yml 的使用方法,并展示了将 Prisma 存储库转换为 YML,然后将 YML 转换为 Prisma 模型的步骤。通过这些步骤,你可以完全掌握 prisma-yml 的使用方法,为组织中广泛共享和协作的架构定义作出贡献,有效提升协作效率。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/59157