关系型数据库

TypeScript

PostgreSQL

了解如何从头开始创建一个新的 Node.js 或 TypeScript 项目，通过将 Prisma ORM 连接到您的数据库并生成 Prisma Client 以进行数据库访问。本教程将向您介绍 Prisma CLI、Prisma Client 和 Prisma Migrate。

先决条件

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

• Node.js 安装在您的机器上（请参阅 系统要求 了解官方支持的版本）
• 一个 PostgreSQL 数据库服务器正在运行

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

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

创建项目设置

第一步，创建一个项目目录并进入该目录

mkdir hello-prisma
cd hello-prisma

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

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

这将创建一个 package.json 文件，其中包含您的 TypeScript 应用的初始设置。

接下来，初始化 TypeScript

npx tsc --init

提示

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

现在，您可以通过在命令前加上 npx 来调用 Prisma CLI

npx prisma

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

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

此命令会执行以下几项操作

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

使用版本控制吗？

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

.gitignore

generated/prisma/

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

prisma/schema.prisma

datasource db {
  provider = "postgresql"
  url      = env("DATABASE_URL")
}