关系型数据库

TypeScript

SQL Server

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

提示

如果您正从其他 ORM 迁移到 Prisma ORM，请参阅我们的从 TypeORM 迁移或从 Sequelize 迁移指南。

先决条件

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

• 您的机器上安装有Node.js（请参阅系统要求以获取官方支持的版本）
• 一个Microsoft SQL Server 数据库
  • 适用于 Docker 的 Linux 版 Microsoft SQL Server
  • Windows 版 Microsoft SQL Server（本地）

请参阅系统要求以获取确切的版本要求。

确保您手头有数据库连接 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 sqlserver --output ../generated/prisma

此命令会执行以下操作：

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

使用版本控制？

如果您使用版本控制（例如 git），我们建议您向 .gitignore 添加一行，以将生成的 client 从您的应用程序中排除。在此示例中，我们要排除 generated/prisma 目录。

.gitignore

generated/prisma/

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

prisma/schema.prisma

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