跳到主要内容

将 Prisma ORM 添加到现有项目（TypeScript 和 PostgreSQL）

TypeScript
PostgreSQL

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

提示

如果你正在从其他 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。

现在你可以使用 npx 前缀调用 Prisma CLI

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

prisma/schema.prisma
datasource db {
  provider = "postgresql"
  url      = env("DATABASE_URL")
}
© . All rights reserved.