跳到主要内容

关系型数据库

TypeScript
CockroachDB

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

提示

如果您正在从另一个 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 文件，用于定义环境变量（例如您的数据库连接）
使用版本控制？

如果您正在使用版本控制，例如 git，我们建议您在 .gitignore 中添加一行以将生成的客户端排除在您的应用程序之外。在此示例中，我们想排除 generated/prisma 目录。

.gitignore
generated/prisma/

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

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