跳到主要内容

关系型数据库

TypeScript
PlanetScale

了解如何通过连接到你的数据库并生成 Prisma Client 进行数据库访问，从而将 Prisma ORM 添加到现有的 Node.js 或 TypeScript 项目。以下教程将向你介绍 Prisma CLI、Prisma Client 和 Prisma Introspection。

提示

如果你正在从另一个 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 的文件，该文件包含带有你的数据库连接变量和 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")
}