跳到主内容

关系型数据库

TypeScript
CockroachDB

学习如何从头创建一个新的 Node.js 或 TypeScript 项目，通过将 Prisma ORM 连接到你的数据库并生成用于数据库访问的 Prisma Client。本教程将向你介绍 Prisma CLI、Prisma Client 和 Prisma Migrate。

前置条件​

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

有关确切的版本要求，请参阅系统要求。

确保你手头有数据库连接 URL。如果你没有正在运行的数据库服务器，只想探索 Prisma ORM，请查看快速入门。

创建项目设置​

第一步是创建一个项目目录并导航到其中

mkdir hello-prisma
cd hello-prisma

接下来，初始化一个 TypeScript 项目并向其中添加 Prisma CLI 作为开发依赖

npm init -y
npm install prisma typescript tsx @types/node --save-dev

这会创建一个包含 TypeScript 应用初始设置的 package.json 文件。

接下来，初始化 TypeScript

npx tsc --init
信息

有关如何使用不同包管理器安装 Prisma 的说明，请参阅安装说明。

现在可以通过在其前面加上 npx 来调用 Prisma CLI

npx prisma

接下来，使用以下命令创建你的Prisma Schema文件来设置你的 Prisma ORM 项目

npx prisma init --datasource-provider cockroachdb --output ../generated/prisma

此命令会执行一些操作

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

如果你正在使用版本控制（例如 git），建议你在 .gitignore 文件中添加一行，以排除应用程序中生成的客户端。在本例中，我们要排除 generated/prisma 目录。

.gitignore
generated/prisma/

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

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