跳到主要内容

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

JavaScript
CockroachDB

了解如何将 Prisma ORM 添加到现有的 Node.js 或 TypeScript 项目中，方法是将其连接到您的数据库并生成 Prisma Client 以进行数据库访问。本教程将向您介绍 Prisma CLI、Prisma Client 和 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 选项指定提供者，则需要编辑 datasource 块以改用 cockroachdb 提供者

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