跳到主要内容

使用 Nuxt Prisma 模块

Nuxt Prisma 模块简化了将 Prisma ORM 集成到您的 Nuxt 应用程序中的过程。

Prisma ORM 是一个数据库库，允许您对数据库模式进行建模，提供自动生成的迁移，并让您以直观且类型安全的方式查询数据库。

此模块提供了多项功能，以简化在 Nuxt 应用程序中设置和使用 Prisma ORM 的过程，从而更容易与您的数据库进行交互。

功能​

  • 项目初始化：在您的 Nuxt 项目中自动设置带有 SQLite 数据库的 Prisma ORM 项目。
  • Composable（可组合）：提供自动导入的 usePrismaClient() composable，可在您的 Vue 文件中使用。
  • API 路由集成：自动导入 PrismaClient 实例，用于 API 路由中以查询您的数据库。
  • Prisma Studio 访问：通过 Nuxt Devtools 启用对 Prisma Studio 的访问，以查看和手动编辑数据。

开始使用​

  1. 创建一个新的 Nuxt 项目

    npx nuxi@latest init test-nuxt-app

  2. 导航到项目目录并使用 Nuxt CLI 安装 @prisma/nuxt

    cd test-nuxt-app
    npx nuxi@latest module add @prisma/nuxt

    警告

    如果您正在使用 pnpm，请确保提升 Prisma 依赖项。请按照 Prisma Studio 步骤 获取详细说明。

  3. 启动开发服务器

    npm run dev

    启动开发服务器将会

    1. 自动安装 Prisma CLI
    2. 使用 SQLite 初始化 Prisma 项目
    3. 在 Prisma Schema 文件中创建 User 和 Post 示例模型
      prisma/schema.prisma
       // This is your Prisma schema file,
       // learn more about it in the docs: https://pris.ly/d/prisma-schema

       generator client {
         provider = "prisma-client-js"
       }

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

       model User {
         id    Int     @id @default(autoincrement())
         email String  @unique
         name  String?
         posts Post[]
       }

       model Post {
         id        Int     @id @default(autoincrement())
         title     String
         content   String?
         published Boolean @default(false)
         author    User    @relation(fields: [authorId], references: [id])
         authorId  Int
       }
    4. 提示您运行迁移以使用 Prisma Migrate 创建数据库表
      注意

      如果不存在 migrations 文件夹，则模块会在您首次启动时自动迁移数据库。之后，您需要在 CLI 中手动运行 npx prisma migrate dev 以应用任何模式更改。手动运行 npx prisma migrate dev 命令可以更轻松、更安全地管理迁移，并且还可以排除任何与迁移相关的错误。

    5. 安装并生成 Prisma Client，使您能够查询您的数据库
    6. 自动启动 Prisma Studio

  4. 您现在可以在您的项目中使用 Prisma ORM 了。如果您接受了添加 Prisma Studio 的提示，您可以通过 Nuxt Devtools 访问 Prisma Studio。请参阅使用部分，了解如何在您的应用中使用 Prisma Client。

使用不同的数据库提供商​

@prisma/nuxt 模块适用于任何 Prisma ORM 支持的数据库提供商。您可以配置开始使用示例以使用您选择的数据库。对于没有现有数据的数据库和具有预先存在的数据的数据库，步骤会有所不同。

使用没有现有数据的数据库​

要配置 开始使用示例 以使用没有现有数据的 PostgreSQL 数据库

  1. 停止 Nuxt 开发服务器和 Prisma Studio（如果它们仍在运行） 
    npx kill-port 3000  # Stops Nuxt dev server (default port)
    npx kill-port 5555  # Stops Prisma Studio (default port)
  2. 导航到 schema.prisma 文件并更新 datasource 块以指定 postgresql 提供商
    prisma/schema.prisma
    // This is your Prisma schema file,
    // learn more about it in the docs: https://pris.ly/d/prisma-schema

    generator client {
      provider = "prisma-client-js"
    }

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

    model User {
      id    Int     @id @default(autoincrement())
      email String  @unique
      name  String?
      posts Post[]
    }

    model Post {
      id        Int     @id @default(autoincrement())
      title     String
      content   String?
      published Boolean @default(false)
      author    User    @relation(fields: [authorId], references: [id])
      authorId  Int
    }
  3. 使用您的 PostgreSQL 数据库 URL 更新 .env 文件中的 DATABASE_URL 环境变量
    .env
    ## This is a sample database URL, please use a valid URL
    DATABASE_URL="postgresql://janedoe:mypassword@localhost:5432/mydb?schema=sample"
  4. 删除 SQLite 数据库文件和 migrations 文件夹 
    rm prisma/dev.db # Delete SQLite database file
    rm -r prisma/migrations # Delete the pre-existing migrations folder
  5. 运行开发服务器 
    npm run dev
    启动开发服务器将提示您将模式更改迁移到数据库，您应该同意。然后同意从 Nuxt Devtools 安装和访问 Prisma Studio 的提示。
  6. @prisma/nuxt 模块已准备好与您的 PostgreSQL 数据库一起使用。请参阅使用部分，了解如何在您的应用中使用 Prisma Client。

使用具有预先存在的数据的数据库​

要配置 开始使用示例 以使用已经有数据的 PostgreSQL 数据库

  1. 停止开发服务器和 Prisma Studio（如果它们仍在运行） 
    // stops Nuxt dev server from running incase it's still running
    npx kill-port 3000
    // stops Prisma Studio instance incase it's still running
    npx kill-port 5555
  2. 删除 Prisma 文件夹 
    rm -r prisma/
  3. 使用您的 PostgreSQL 数据库 URL 更新 .env 文件中的 DATABASE_URL 环境变量
    .env
    ## This is a sample database URL, please use a valid URL
    DATABASE_URL="postgresql://janedoe:mypassword@localhost:5432/mydb?schema=sample"
  4. 要从现有数据库生成 Prisma Schema 和 migrations 文件夹，您必须内省数据库。完成内省指南中的步骤 1 到步骤 4 并继续。
  5. 启动开发服务器将跳过提示您将模式更改迁移到数据库的步骤，因为 migrations 文件夹已存在。同意从 Nuxt Devtools 安装和访问 Prisma Studio 的提示。
  6. @prisma/nuxt 模块已准备好与您的 PostgreSQL 数据库一起使用。请参阅使用部分，了解如何在您的应用中使用 Prisma Client。

使用​

选项 A：usePrismaClient composable（可组合函数）​

在您的 Nuxt 服务器组件中使用 composable​

如果您正在使用 Nuxt 服务器组件，您可以在您的 .server.vue 文件中使用 Prisma Client 的全局实例

<script setup>
  const prisma = usePrismaClient()
  const user = await prisma.user.findFirst()
</script>

<template>
  <p>{{ user.name }}</p>
</template>

选项 B：lib/prisma.ts​

在完成初始设置提示后，此模块会创建 lib/prisma.ts 文件，其中包含 Prisma Client 的全局实例。

lib/prisma.ts
import { PrismaClient } from '@prisma/client'

const prismaClientSingleton = () => {
  return new PrismaClient()
}

declare const globalThis: {
  prismaGlobal: ReturnType<typeof prismaClientSingleton>;
} & typeof global;

const prisma = globalThis.prismaGlobal ?? prismaClientSingleton()

export default prisma

if (process.env.NODE_ENV !== 'production') globalThis.prismaGlobal = prisma

您可以通过在您的 lib/prisma.ts 文件中使用客户端扩展来定制 Prisma Client 的功能。这是一个使用 Pulse 客户端扩展 的示例

lib/prisma.ts
import { PrismaClient } from '@prisma/client'
import { withPulse } from '@prisma/extension-pulse'

const prismaClientSingleton = () => {
  return new PrismaClient().$extends(withPulse({
    apiKey: process.env.PULSE_API_KEY
  }))
}

declare const globalThis: {
  prismaGlobal: ReturnType<typeof prismaClientSingleton>;
} & typeof global;

const prisma = globalThis.prismaGlobal ?? prismaClientSingleton()

export default prisma

if (process.env.NODE_ENV !== 'production') globalThis.prismaGlobal = prisma

信息

如果您想利用使用 Prisma Client 扩展 的客户端，请使用来自 lib 文件夹的 prisma 实例。

在您的 API 路由中使用全局 Prisma Client 实例​

您可以按照以下方式在您的 Nuxt API 路由中使用 Prisma Client 的全局实例

import prisma from "~/lib/prisma";

export default defineEventHandler(async (event) => {
  return {
    user: await prisma.user.findFirst(),
  };
});

在您的 Nuxt 服务器组件中使用全局 Prisma Client 实例​

如果您正在使用 Nuxt 服务器组件，您可以在 .server.vue 文件中使用 Prisma Client 的全局实例

<script setup>
  import prisma from '~/lib/prisma';
  const user = await prisma.user.findFirst()
</script>

<template>
  <p>{{ user.name }}</p>
</template>

配置​

您可以使用 nuxt.config.ts 中的 prisma 键来配置 @prisma/nuxt 模块

nuxt.config.ts
export default defineNuxtConfig({
  // ...
  prisma: {
    // Options
  }
})

注意

在成功运行 npm run dev 设置模块后，prisma 键在 nuxt.config.ts 中可用

选项类型默认值描述
installCLIbooleantrue是否安装 Prisma CLI。
installClientbooleantrue是否在项目中安装 Prisma Client 库。
generateClientbooleantrue是否生成 PrismaClient 实例。每次运行时执行 npx prisma generate 以根据模式更改更新客户端。
formatSchemabooleantrue是否格式化 Prisma Schema 文件。
installStudiobooleantrue是否在 Nuxt Devtools 中安装并启动 Prisma Studio。
autoSetupPrismabooleanfalse是否跳过设置期间的所有提示。此选项对于在脚本或 CI/CD 管道中自动化 Prisma 设置非常有用。
skipPromptsfalsefalse跳过所有提示
prismaRootstringfalse当使用 Nuxt layers（Nuxt 层） 时是必需的。例如，如果您有一个名为 database 的 Nuxt 层，则 prismaRoot 在基本 nuxt 配置中将为 ./database。这指的是 Prisma 将被初始化或检查的文件夹。
prismaSchemaPathstringundefined当使用 Nuxt layers（Nuxt 层） 时是必需的。例如，如果您有一个名为 database 的 Nuxt 层，则 prismaSchemaPath 在基本 nuxt 配置中将为 ./database/prisma/schema.prisma。

局限性​

PrismaClient 构造函数选项在 usePrismaClient composable 中不可配置​

usePrismaClient 模块目前不允许配置 PrismaClient 构造函数选项。

usePrismaClient composable 在边缘运行时中不受支持​

usePrismaClient composable 当前依赖于在边缘运行时中不起作用的 PrismaClient 实例。如果您需要 composable 的边缘支持，请在 Discord 或 GitHub 上告知我们。

故障排除​

Prisma Studio 无法使用 pnpm 打开​

如果您在使用 pnpm 时遇到以下错误，并且 Prisma Studio 无法打开

Uncaught SyntaxError: The requested module '/_nuxt/node_modules/.pnpm/*@*/node_modules/@prisma/client/index-browser.js?v=' does not provide an export named 'PrismaClient' (at plugin.mjs?v=*)

要解决此问题，请在您的项目根目录中创建一个 .npmrc 文件，并添加以下配置以提升 Prisma 依赖项

.npmrc
hoist-pattern[]=*prisma*

这将确保 pnpm 正确解析 Prisma 依赖项。

解决 TypeError: Failed to resolve module specifier ".prisma/client/index-browser" 错误​

如果您在构建和预览应用程序后在浏览器控制台中遇到以下错误消息

TypeError: Failed to resolve module specifier ".prisma/client/index-browser"

要解决此问题，请将以下配置添加到您的 nuxt.config.ts 文件中

nuxt.config.ts
import { defineNuxtConfig } from 'nuxt'

export default defineNuxtConfig({
  modules: [
    '@prisma/nuxt',
  ],
  // additional config
  vite: {
    resolve: {
      alias: {
        '.prisma/client/index-browser': './node_modules/.prisma/client/index-browser.js',
      },
    },
  },
})

此配置确保模块标识符正确映射到适当的文件。

包管理器支持方面的限制​

该模块旨在与流行的包管理器（包括 npm、Yarn 和 pnpm）一起使用。但是，截至 v0.2 版本，由于导致无限安装循环的问题，它与 Bun 不完全兼容。

此外，此软件包尚未在 Deno 上进行测试，因此未获得正式支持。