关系型数据库

TypeScript

PlanetScale

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

先决条件

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

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

警告

本教程假设您可以推送到数据库的 main 分支。如果您的 main 分支已被提升到生产环境，请不要这样做。

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

确保您准备好数据库 连接 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 mysql --output ../generated/prisma

此命令执行以下几项操作

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

使用版本控制？

如果您正在使用版本控制（例如 git），我们建议您向 .gitignore 文件添加一行，以将生成的客户端从您的应用中排除。在此示例中，我们希望排除 generated/prisma 目录。

.gitignore

generated/prisma/

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

prisma/schema.prisma

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