跳至主要内容

使用 Nuxt Prisma 模块

Nuxt Prisma 模块简化了 Prisma ORM 在 Nuxt 应用程序中的集成。

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

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

警告

@prisma/nuxt 模块目前不支持 Prisma ORM 7 或使用自定义 generator client { output = ... }。对于 Prisma 7 项目，请改为遵循一般 Nuxt 指南。

功能​

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

入门​

  1. 创建 一个新 Nuxt 项目

    npm create nuxt 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"
         output   = "./generated"
       }

       datasource db {
         provider = "sqlite"
       }

       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"
      output   = "./generated"
    }

    datasource db {
      provider = "postgresql"
    }

    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 数据库文件和迁移文件夹 
    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 和迁移文件夹，您必须内省数据库。完成内省指南中的步骤 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>

选项 B：lib/prisma.ts​

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

lib/prisma.ts
import { PrismaClient } from '../prisma/generated/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 的功能。这是一个使用 Accelerate 客户端扩展的示例

lib/prisma.ts
import { PrismaClient } from '../prisma/generated/client'
import { withAccelerate } from '@prisma/extension-accelerate'

const prismaClientSingleton = () => {
  return new PrismaClient().$extends(withAccelerate())
}

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 层时必需。例如，如果您有一个名为 database 的 Nuxt 层，则 prismaRoot 在基本 nuxt 配置中将是 ./database。这指的是将初始化或检查 Prisma 的文件夹。
prismaSchemaPathstring未定义在使用 Nuxt 层时必需。例如，如果您有一个名为 database 的 Nuxt 层，则 prismaSchemaPath 在基本 nuxt 配置中将是 ./database/prisma/schema.prisma。
runMigrationbooleantrue是否自动运行 Prisma 迁移。如果您使用的是 MongoDB 或 PlanetScale，请使用 npx prisma db push 命令。这些数据库不支持迁移，因此此命令将确保您的模式得到适当更新。

限制​

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

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*

这将确保 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 测试，因此未正式支持。

解决 Error: @prisma/client did not initialize yet. Please run "prisma generate" and try to import it again.​

即使您已生成客户端，如果您遇到以下消息

Error: @prisma/client did not initialize yet. Please run "prisma generate" and try to import it again.

请尝试删除 schema.prisma 中的 output = ../generated/prisma，例如

prisma/schema.prisma
generator client {
  provider = "prisma-client"
  output   = "./generated"
}

当您为 Prisma Client 指定自定义输出目录时，这意味着生成的客户端代码将不会位于默认的 node_modules/@prisma/client 目录中。相反，它将生成在您的项目根目录下的 generated/prisma/ 中。但是，Nuxt 中的 @prisma/nuxt 模块期望在默认的 @prisma/client 位置找到 PrismaClient。


与 Prisma 保持联系

通过以下方式与我们保持联系，继续你的 Prisma 之旅： 我们的活跃社区。保持信息灵通，参与其中，并与其他开发人员协作。

我们真诚地感谢你的参与，并期待你成为我们社区的一部分！

打开方式
复制为 Markdown
在 Claude 中打开
在 ChatGPT 中打开
在 T3.chat 中打开
在 GitHub 中编辑
© . This site is unofficial and not affiliated with Prisma Data, Inc.