跳到主要内容

关系型数据库

JavaScript
MySQL

了解如何通过连接到您的数据库并生成用于数据库访问的 Prisma Client，将 Prisma ORM 添加到现有的 Node.js 或 TypeScript 项目。本教程将向您介绍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 的文件，该文件包含带有数据库连接变量和模式模型的 Prisma Schema。
  • 将 datasource 设置为MySQL并分别将输出设置为自定义位置。
  • 在项目的根目录中创建 .env 文件，用于定义环境变量（例如您的数据库连接）
使用版本控制？

如果您使用版本控制，例如 git，我们建议您在 .gitignore 文件中添加一行以从应用程序中排除生成的客户端。在此示例中，我们要排除 generated/prisma 目录。

.gitignore
generated/prisma/

请注意，由 prisma init 创建的默认模式使用 PostgreSQL 作为 provider。如果您没有使用 datasource-provider 选项指定 provider，则需要编辑 datasource 块以改用 mysql provider

prisma/schema.prisma
datasource db {
  provider = "mysql"
  url      = env("DATABASE_URL")
}