跳至主要内容

使用 Nuxt Prisma 模块

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

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

此模块提供了一些功能，可以简化在 Nuxt 应用程序中设置和使用 Prisma ORM 的过程，使其更轻松地与您的数据库进行交互。

功能​

  • 项目初始化：自动在您的 Nuxt 项目中设置 Prisma ORM 项目，其中包含一个 SQLite 数据库。
  • 可组合：提供一个自动导入的 usePrismaClient() 可组合函数，供您在 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 依赖项。请按照此处的步骤获取详细说明。

  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. 在 .env 文件中使用您的 PostgreSQL 数据库 URL 更新 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 数据库文件和迁移文件夹 
    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. 在 .env 文件中使用您的 PostgreSQL 数据库 URL 更新 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 和迁移文件夹，您必须内省数据库。完成内省指南中的**步骤 1** 到**步骤 4**，然后继续。
  5. 启动开发服务器将跳过将模式更改迁移到数据库的提示，因为迁移文件夹已经存在。同意从 Nuxt Devtools 安装和访问 Prisma Studio 的提示。
  6. @prisma/nuxt 模块已准备好与您的 PostgreSQL 数据库一起使用。请参阅使用部分，了解如何在应用程序中使用 Prisma Client。

使用​

选项 A：usePrismaClient 可组合函数​

在您的 Nuxt 服务器组件中使用可组合函数​

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

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

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

在您的 API 路由中使用自动导入的 Prisma Client 实例​

您可以在 Nuxt API 路由中使用自动导入的 Prisma Client 实例 prisma，如下所示

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

选项 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 模式 文件。
installStudiobooleantrue是否在 Nuxt Devtools 中安装并启动 Prisma Studio。
autoSetupPrismabooleanfalse是否跳过设置过程中的所有提示。此选项适用于在脚本或 CI/CD 管道中自动执行 Prisma 设置。

限制​

PrismaClient 构造函数选项在 usePrismaClient 组合式中不可配置​

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

usePrismaClient 组合式在边缘运行时中不受支持​

usePrismaClient 组合式目前依赖于一个在边缘运行时中无法工作的 PrismaClient 实例。如果你需要组合式在边缘运行时中支持，请在 Discord 或 GitHub 上告知我们。

故障排除​

使用 pnpm 时 Prisma Studio 无法打开​

如果你在使用 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*

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

解决 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',
      },
    },
  },
})

此配置确保模块说明符正确映射到相应文件。