跳到主内容

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

TypeScript
CockroachDB

了解如何将 Prisma ORM 添加到现有 Node.js 或 TypeScript 项目中，方法是将其连接到数据库并为数据库访问生成 Prisma 客户端。以下教程将向你介绍 Prisma CLI、Prisma 客户端 和 Prisma 内省。

提示

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

先决条件​

要成功完成本指南，你需要

  • 一个带有 package.json 的现有 Node.js 项目
  • Node.js 已安装在你的机器上（请参阅系统要求以了解官方支持的版本）
  • 一个正在运行的 CockroachDB 数据库服务器和一个至少包含一个表的数据库

请参阅系统要求以了解确切的版本要求。

确保你手头有数据库连接 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 cockroachdb --output ../generated/prisma

此命令执行以下几项操作

  • 创建一个名为 prisma 的新目录，其中包含一个名为 schema.prisma 的文件，该文件包含带有你的数据库连接变量和 schema 模型的 Prisma Schema。
  • 将 datasource 设置为CockroachDB并分别将输出设置为自定义位置。
  • 在项目根目录中创建.env 文件，用于定义环境变量（如数据库连接）

请注意，prisma init 创建的默认 schema 使用 PostgreSQL 作为 provider。如果你没有通过 datasource-provider 选项指定 provider，你需要编辑 datasource 块以改用 cockroachdb provider

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