跳到主要内容

MongoDB

了解如何从零开始创建一个新的 Node.js 或 TypeScript 项目,方法是将 Prisma ORM 连接到您的 MongoDB 数据库并生成用于数据库访问的 Prisma Client。以下教程向您介绍 Prisma CLIPrisma Client

先决条件

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

  • Node.js 安装在您的机器上(请参阅 系统要求 以了解官方支持的版本)

  • 访问具有副本集部署的 MongoDB 4.2+ 服务器。我们建议使用 MongoDB Atlas

    警告

    MongoDB 数据库连接器使用事务来支持嵌套写入。事务需要副本集部署。部署副本集的最简单方法是使用 Atlas。入门是免费的。

确保您手头有数据库 连接 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 CLI 前面加上 npx 来调用它

npx prisma

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

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

此命令执行以下几项操作

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

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

.gitignore
generated/prisma/

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

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