跳到主要内容

关系型数据库

学习如何从头创建一个新的 Node.js 或 TypeScript 项目,将 Prisma ORM 连接到你的数据库并生成 Prisma Client 以进行数据库访问。以下教程将向你介绍 Prisma CLIPrisma ClientPrisma Migrate

先决条件

为了成功完成本指南,你需要:

  • 在你的机器上安装 Node.js(参阅系统要求了解官方支持的版本)
  • 正在运行的 MySQL 数据库服务器

有关确切的版本要求,请参阅系统要求

请确保你手边有数据库的连接 URL。如果你没有运行中的数据库服务器,只是想探索 Prisma ORM,请查看快速入门

创建项目设置

第一步,创建一个项目目录并进入该目录

mkdir hello-prisma
cd hello-prisma

接下来,初始化一个 TypeScript 项目并将 Prisma CLI 作为开发依赖项添加到其中

npm init -y
npm install prisma typescript tsx @types/node --save-dev

这会创建一个 package.json 文件,其中包含 TypeScript 应用的初始设置。

接下来,初始化 TypeScript

npx tsc --init
信息

参阅安装说明,了解如何使用不同的包管理器安装 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")
}