关系型数据库
学习如何通过连接到数据库并生成 Prisma Client 以进行数据库访问的方式,将 Prisma ORM 添加到现有 Node.js 或 TypeScript 项目。以下教程将介绍 Prisma CLI、Prisma Client 和 Prisma 内省。
如果您正在从其他 ORM 迁移到 Prisma ORM,请参阅我们的从 TypeORM 迁移或从 Sequelize 迁移指南。
先决条件
为了成功完成本指南,您需要
- 一个包含
package.json
的现有 Node.js 项目 - 您的机器上安装了Node.js(请参阅系统要求以了解官方支持的版本)
- 一个正在运行的 PlanetScale 数据库服务器,以及一个至少包含一个表的数据库
请参阅系统要求以了解确切的版本要求。
请务必准备好您的数据库连接 URL(包括您的身份验证凭据)!如果您没有正在运行的数据库服务器,只想探索 Prisma ORM,请查看快速入门。
设置 Prisma ORM
第一步,导航到包含 package.json
文件的项目目录中。
接下来,将 Prisma CLI 添加为项目的开发依赖项
npm install prisma --save-dev
如果您的项目包含多个包含 package.json
文件的目录(例如 frontend
、backend
等),请注意 Prisma ORM 专门设计用于 API/后端层。要设置 Prisma,请导航到包含相关 package.json
文件的适当后端目录并在那里配置 Prisma。
您现在可以使用 npx
前缀调用 Prisma CLI
npx prisma
请参阅安装说明以了解如何使用不同的包管理器安装 Prisma ORM。
接下来,使用以下命令创建 Prisma Schema 文件,以设置您的 Prisma ORM 项目
npx prisma init --datasource-provider mysql --output ../generated/prisma
此命令执行以下操作:
- 创建一个名为
prisma
的新目录,其中包含一个名为schema.prisma
的文件,该文件包含带有数据库连接变量和模式模型的 Prisma Schema。 - 将
datasource
设置为MySQL并将输出分别设置到自定义位置。 - 在项目的根目录中创建
.env
文件,用于定义环境变量(例如您的数据库连接)
如果您使用版本控制(如 git),我们建议您在 .gitignore
中添加一行,以排除生成客户端文件。在本例中,我们要排除 generated/prisma
目录。
generated/prisma/
请注意,prisma init
创建的默认模式使用 PostgreSQL 作为 provider
。如果您未使用 datasource-provider
选项指定提供者,则需要编辑 datasource
块以使用 mysql
提供者代替
datasource db {
provider = "mysql"
url = env("DATABASE_URL")
}