跳到主要内容

关系型数据库

TypeScript
MySQL

了解如何将 Prisma ORM 添加到现有的 Node.js 或 TypeScript 项目中，通过连接到数据库并生成用于数据库访问的 Prisma Client。以下教程将介绍 Prisma CLI、Prisma Client 和 Prisma 内省。

提示

如果您正从其他 ORM 迁移到 Prisma ORM，请参阅我们的 从 TypeORM 迁移 或 从 Sequelize 迁移 指南。

先决条件​

为了成功完成本指南，您需要

  • 一个包含 package.json 的现有 Node.js 项目
  • 您的机器上已安装 Node.js (有关官方支持的版本，请参阅系统要求)
  • 一个正在运行的 MySQL 数据库服务器以及一个至少包含一个表的数据库

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

确保您已备好您的数据库连接 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 的文件，该文件包含带有您的数据库连接变量和 schema 模型的 Prisma Schema。
  • 将 datasource 设置为MySQL并将输出分别设置为自定义位置。
  • 在项目的根目录中创建 .env 文件，用于定义环境变量（例如您的数据库连接）
正在使用版本控制吗？

如果您正在使用版本控制，例如 git，我们建议您在 .gitignore 中添加一行以从您的应用程序中排除生成的 client。在此示例中，我们要排除 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")
}