关系型数据库
学习如何从零开始创建一个新的 Node.js 或 TypeScript 项目,方法是将 Prisma ORM 连接到你的数据库并生成一个 Prisma Client 用于数据库访问。以下教程将向你介绍 Prisma CLI、Prisma Client 和 Prisma Migrate。
先决条件
为了成功完成本指南,你需要
- 在你的机器上安装 Node.js(参见 系统要求 了解官方支持的版本)
- 一个正在运行的 PlanetScale 数据库服务器
警告
本教程假设你可以推送到数据库的 main
分支。如果你的 main
分支已提升为生产环境,请不要这样做。
接下来,初始化一个 Node.js 项目并将 Prisma CLI 添加为开发依赖
npm init -y
npm install prisma --save-dev
这将创建一个包含 Node.js 应用初始设置的 package.json
文件。
信息
请参阅安装说明,了解如何使用不同的包管理器安装 Prisma。
你现在可以通过在其前加上 npx
来调用 Prisma CLI
npx prisma
接下来,使用以下命令创建 Prisma Schema 文件,设置你的 Prisma ORM 项目
npx prisma init --datasource-provider mysql --output ../generated/prisma
此命令执行以下几项操作
- 创建一个名为
prisma
的新目录,其中包含一个名为schema.prisma
的文件,该文件包含带有你的数据库连接变量和 Schema 模型的 Prisma Schema。 - 将
datasource
设置为MySQL并将输出分别设置为自定义位置。 - 在项目的根目录中创建
.env
文件,该文件用于定义环境变量(例如你的数据库连接)
使用版本控制?
如果你使用版本控制,例如 git,我们建议你在 .gitignore
中添加一行以排除应用程序中生成的客户端。在此示例中,我们要排除 generated/prisma
目录。
.gitignore
generated/prisma/
请注意,由 prisma init
创建的默认 schema 使用 PostgreSQL 作为 provider
。如果你没有使用 datasource-provider
选项指定 provider,则需要编辑 datasource
块以改用 mysql
provider
prisma/schema.prisma
datasource db {
provider = "mysql"
url = env("DATABASE_URL")
}