将 Prisma ORM 添加到现有 JavaScript 项目 (PostgreSQL)
了解如何将 Prisma ORM 添加到现有的 Node.js 或 TypeScript 项目,通过连接到您的数据库并生成 Prisma Client 以进行数据库访问。本教程将向您介绍Prisma CLI、Prisma Client 和Prisma 内省。
如果您要从其他 ORM 迁移到 Prisma ORM,请参阅我们的从 TypeORM 迁移或从 Sequelize 迁移指南。
先决条件
为了成功完成本指南,您需要
- 一个包含
package.json
文件的现有 Node.js 项目 - Node.js已安装在您的机器上(请参阅系统要求以了解官方支持的版本)
- 一个正在运行的 PostgreSQL 数据库服务器,以及一个至少包含一张表的数据库
有关确切版本要求,请参阅系统要求。
确保您手头有数据库连接 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。
您现在可以通过在 Prisma CLI 前添加 npx
来调用它
npx prisma
请参阅安装说明,了解如何使用不同的包管理器安装 Prisma ORM。
接下来,使用以下命令创建您的Prisma Schema 文件来设置您的 Prisma ORM 项目
npx prisma init --datasource-provider postgresql --output ../generated/prisma
此命令执行以下操作
- 创建一个名为
prisma
的新目录,其中包含一个名为schema.prisma
的文件,该文件包含带有数据库连接变量和 Schema 模型的 Prisma Schema。 - 将
datasource
设置为PostgreSQL并分别将输出设置为自定义位置。 - 在项目的根目录中创建
.env
文件,该文件用于定义环境变量(例如您的数据库连接)
请注意,prisma init
创建的默认 Schema 使用 PostgreSQL 作为 provider
。如果您没有通过 datasource-provider
选项指定 provider,则需要编辑 datasource
块以使用 postgresql
provider。
datasource db {
provider = "postgresql"
url = env("DATABASE_URL")
}