【NextJS】PostgreSQL 遇上 Prisma ORM

NextJS 数据库 之 遇上Prisma ORM

  • 前言
  • 一、环境要求
  • 二、概念介绍
    • 1、Prisma Schema Language(PSL) 结构描述语言
      • 1.1 概念
      • 1.2 组成
        • 1.2.1 Data Source 数据源
        • 1.2.2 Generators 生成器
        • 1.2.3 Data Model Definition 数据模型定义
          • 字段(数据)类型和约束
          • 关系(Relations)
          • 枚举(Enum)
    • 2、Prisma Client 数据交互接口
      • 2.1 概念
      • 2.2 使用示例
    • 3、Prisma Migrate 迁移与种子
      • 3.1 概念
      • 3.2 迁移流程
      • 3.3 数据库迁移(Migrate)
      • 3.3 数据种子(Seeding)
    • 4、Prisma CLI 命令行工具
      • init
      • generate
  • 三、Next.js 中应用示例
    • 1、全新项目示例
      • 1.1 项目初始化
      • 1.2 初始化Prisma ORM
      • 1.3 数据迁移
      • 1.4 播种数据(可选)
      • 1.5 模拟业务

前言

Next.js 全栈开发的时候不免要用到数据库,采用原生数据库语法可能还需要顾虑很多方面的问题(语法安全、原生语法麻烦/繁琐/复杂、更换数据库时的语法兼容等等),为了解决这类问题诞生了ORM‌(Object-Relational Mapping)数据访问方式技术及周边工具;

这里介绍一个易用又强大的ORM‌框架/工具库:Prisma ORM

官网:https://www.prisma.io/
GitHub:https://github.com/prisma/prisma

内容包含以下两个部分:

  • 重点概念

    • Prisma Schema Language (PSL).:用来描述数据库架构的语言
  • 两个主要(常用)操作库

    • Prisma Client:为 Node.js 和 TypeScript 自动生成类型安全的查询生成器
      可用于任何Node.jsTypeScript 后端应用程序(包括无服务器应用程序和微服务)。
    • Prisma Migrate:声明式数据建模和迁移系统
      主要用于生产部署、数据迁移等应用场景
    • Prisma CLI:辅助快捷的操作命令工具

延展辅助(平台服务):

  • Prisma Postgres[链接]:托管的 PostgreSQL 数据库服务
  • Prisma Accelerate[链接]:针对现有数据库的完全托管的全局连接池和缓存层,可直接从 Prisma ORM 支持查询级缓存策略。
  • Prisma Optimize[链接]:针对数据操作,基于AI进行优化分析服务
  • Prisma Studio[链接]:用于查看和编辑等操作的数据库可视化GUI工具

一、环境要求

最新环境要求可前往官方文档:https://www.prisma.io/docs/orm/reference/system-requirements

软件:

工具最低要求版本
Node.js18.8 / 20.9 / 22.11
TypeScript (可选)5.1.X
Yarn (可选)1.19.2(当使用Yarn 1时)

操作系统:

Linux:

  • OpenSSL 1.0.x、1.1.x 或 3.x
  • zlib(libz.so.1)
  • libgcc( libgcc_s.so.1)
  • C 标准库(大多数 Linux 发行版上的 glibc 或 Alpine Linux 上的 musl libc)

Windows:

  • Microsoft Visual C++ 可再发行组件 2015或必须安装更新版本

macOS:

  • macOS 10.15 或更新版本

二、概念介绍

1、Prisma Schema Language(PSL) 结构描述语言

1.1 概念

Prisma Schema Language(简称:PSL) - Prisma ORM 的核心部分
用于定义数据库模型关系、以及生成 Prisma Client 的配置文件

  • 【Prisma Schema 参数文档】:https://www.prisma.io/docs/orm/reference/prisma-schema-reference

想要将架构拆分为多个文件? Prisma ORM 5.15.0 及更高版本中的 prismaSchemaFolder 预览功能 支持多文件 Prisma Schema 。

它是一个声明式语言,通过定义 .prisma 文件来描述数据库结构关系
Prisma Client将基于(PSL)生成数据库交互代码。

1.2 组成

  • Data Source:数据库源(例如:PostgreSQL or MongoDB…)
  • Generators:数据模型生成器(例如:Prisma Client)
  • Data model definition:数据模型定义(例如,user数据表有哪些字段、分别什么数据类型等)
1.2.1 Data Source 数据源

定义数据库的连接信息,通常包括数据库的类型(例如PostgreSQL、MySQL、SQLite等)、连接URL、以及数据库的其他配置。

示例:

datasource db {provider = "postgresql" // 指定 PostgreSQL 作为数据库url      = env("DATABASE_URL") // 从环境变量 DATABASE_URL 获取连接字符串
}
1.2.2 Generators 生成器

定义生成器的配置,Prisma默认使用生成Prisma Client。
通常会在此配置生成的Prisma Client存放的位置,以及语言(TypeScript/JavaScript)。

示例:

generator client {provider = "prisma-client-js"output   = "./generated/client"
}
1.2.3 Data Model Definition 数据模型定义

定义数据库中的实体(表)。每个model对应数据库中的一个表,表的字段对应model中的属性
可以定义字段的类型默认值约束(如@id@unique等)以及关系(如@relation)。

model User {id    Int    @id @default(autoincrement())email String @uniquename  Stringposts Post[]
}model Post {id      Int    @id @default(autoincrement())title   Stringcontent String?author  User   @relation(fields: [authorId], references: [id])authorId Int
}
字段(数据)类型和约束

每个字段可以指定数据类型,支持多种类型,如IntStringBooleanDateTimeFloatDecimal等。
可以通过@default()设置默认值,@unique设置唯一约束,@id定义主键等。

  • 更多内置约束:https://www.prisma.io/docs/orm/reference/prisma-schema-reference#attributes
model Post {id        Int      @id @default(autoincrement())title     Stringpublished Boolean  @default(false)createdAt DateTime @default(now())
}
关系(Relations)

PSL支持定义实体之间的关系。常见的关系包括一对一(1:1)一对多(1:N)多对多(M:N)。通过@relation定义。

  • 更多关系说明:https://www.prisma.io/docs/orm/prisma-schema/data-model/relations
// 示例:一对多关系model User {id    Int    @id @default(autoincrement())posts Post[]
}model Post {id      Int    @id @default(autoincrement())userId  Intauthor  User   @relation(fields: [userId], references: [id])
}
枚举(Enum)

PSL还支持枚举类型,用于表示有多个固定选项的字段。

// 示例enum Role {USERADMINMODERATOR
}model User {id    Int    @id @default(autoincrement())name  Stringrole  Role
}

更多数据模型内容可以前往官方文档探索:https://www.prisma.io/docs/orm/prisma-schema/data-model

2、Prisma Client 数据交互接口

2.1 概念

Prisma ClientPrisma ORM 的主要组成部分,它是一个自动生成的数据库查询客户端,用于与数据库进行交互。
提供一种类型安全的方式来执行数据库操作,简化与数据库的连接和操作。

  • 【Prisma Client API文档】:https://www.prisma.io/docs/orm/reference/prisma-client-reference

关键特点:

  • 自动生成:根据数据库模式(schema.prisma 文件)自动生成一个类型安全的客户端库(代码)
  • 类型安全:使用 TypeScript 来生成类型定义,这意味着在开发过程中,可以获得类型推导和自动补全,数据操作无需手动编写原始SQL语法交由Prisma Client 提供的 API 使用 JavaScript/TypeScript 中的类型安全语法
  • 完善接口(API):包含CRUD、关联、分页和排序、事务操作等
  • 数据库支持PostgreSQLMySQLMariaDBSQL ServerSQLiteCockroachDBMongoDB 各类主流数据库

2.2 使用示例

  1. 定义数据库模型(schema.prisma
datasource db {provider = "postgresql"url      = env("DATABASE_URL")
}generator client {provider = "prisma-client-js"
}model User {id    Int    @id @default(autoincrement())name  Stringemail String @unique
}
  1. 模型构建
pnpx prisma generate
  1. 在代码中使用
import { PrismaClient } from '@prisma/client';const prisma = new PrismaClient();async function main() {const users = await prisma.user.findMany();console.log(users);
}main().catch(e => {throw e
}).finally(async () => {await prisma.$disconnect()
});

3、Prisma Migrate 迁移与种子

3.1 概念

Prisma MigratePrisma ORM 中用于数据库迁移的工具。
通过自动生成和执行 SQL 迁移脚本来管理数据库结构变化,同时确保数据库结构与 Prisma Schema 文件(schema.prisma)保持一致。

3.2 迁移流程

Prisma ORM 的集成数据库迁移工具-工作流程
通常的工作流程包括以下几个步骤:

  • 修改 Prisma 模式:你在 schema.prisma 文件中修改数据库模型。
  • 创建迁移文件:运行 prisma migrate devprisma migrate create 命令,自动生成迁移文件。
  • 应用迁移:通过 prisma migrate deployprisma migrate dev 将迁移应用到数据库。
  • 查看迁移历史:Prisma 会在数据库中跟踪迁移历史,确保每次迁移都按顺序应用。

3.3 数据库迁移(Migrate)

3.3 数据种子(Seeding)

4、Prisma CLI 命令行工具

  • 文档[英]
  • 支持指令[英]

init

参数默认描述
--datasource-providerpostgresql指定块provider中字段的值datasource。选项包括sqlite、postgresql、mysql、和。sqlservermongodbcockroachdb
--url定义自定义数据源 URL
--with-model在初始 Prisma 模式中添加一个简单的用户模型。自 5.14.0 版起可用
--outputnode_modules/.prisma/client指定生成的客户端的输出位置
--generator-providerprisma-client-js定义要使用的生成器提供程序
--preview-feature定义要使用的预览功能

示例:

pnpx prisma init --datasource-provider PostgreSQL

generate

参数默认描述
--no-engine生成不带附带引擎的 Prisma Client 以与Prisma Accelerate–data-proxy一起使用。与和互斥–accelerate。在 Prisma ORM 5.2.0 及更高版本中可用。
--no-hints生成 Prisma Client,但不会在终端上打印使用提示。在 Prisma ORM 5.16.0 及更高版本中可用。
--allow-no-models将生成 Prisma Client,但不生成任何模型
--watch监视schema.prisma文件并在文件更改时重新生成 Prisma Client

示例:

prisma generate

其他的后续再整理补充…

三、Next.js 中应用示例

Next.js + PostgreSQL 组合为例!

node环境:

  • node:v20.17.0
  • pnpm:9.15.3

1、全新项目示例

1.1 项目初始化

  • react:^19.0.0
  • next:15.1.4
  • pg:^8.13.1
  • @prisma/client:^6.2.1
pnpx create-next-app@latest// 安装时,将看到以下提示:
✔ What is your project named? … .
✔ Would you like to use TypeScript? … Yes
✔ Would you like to use ESLint? … Yes
✔ Would you like to use Tailwind CSS? … Yes
✔ Would you like your code inside a `src/` directory? … No
✔ Would you like to use App Router? (recommended) … Yes
✔ Would you like to use Turbopack for `next dev`? … No
✔ Would you like to customize the import alias (`@/*` by default)? … No

增加依赖包:pg@prisma/client

pnpm add pg @prisma/client

1.2 初始化Prisma ORM

// 初始化兼容PostgreSQL驱动数据库
pnpx prisma init --datasource-provider PostgreSQL// 将看到以下提示:
✔ Your Prisma schema was created at prisma/schema.prismaYou can now open it in your favorite editor.warn You already have a .gitignore file. Don't forget to add `.env` in it to not commit any private information.Next steps:
1. Set the DATABASE_URL in the .env file to point to your existing database. If your database has no tables yet, read https://pris.ly/d/getting-started
2. Run prisma db pull to turn your database schema into a Prisma schema.
3. Run prisma generate to generate the Prisma Client. You can then start querying your database.
4. Tip: Explore how you can extend the ORM with scalable connection pooling, global caching, and real-time database events. Read: https://pris.ly/cli/beyond-ormMore information in our documentation:
https://pris.ly/d/getting-started

至此,基础环境搞定,接下来重点查看编辑两个文件:.envprisma/schema.prisma
在这里插入图片描述
.env文件中,重点设置DATABASE_URL的值,用于建立数据库连接的配置

DATABASE_URL="postgresql://[username]:[password]@[ip|domain]:[port|5432]/[database][?param1=value1&param2=value2&...]"

prisma/schema.prisma文件中,对生成器、数据模型进行配置

generator client {provider = "prisma-client-js"output   = "./client"   // 配置生成器的代码生成位置(相对schema.prisma文件所在目录)
}datasource db {provider = "postgresql"url      = env("DATABASE_URL")
}// 以下部分均为数据模型构建配置
model User {id    Int    @id @default(autoincrement())email String @uniquename  Stringposts Post[]
}model Post {id        Int     @id @default(autoincrement())title     Stringcontent   Stringpublished Booleanuser      User    @relation(fields: [userId], references: [id])userId    Int
}

完成以上配置后,开始生成Prisma客户端代码:

// 生成Prisma客户端
pnpx prisma generate// 将看到以下提示:
Environment variables loaded from .env
Prisma schema loaded from prisma/schema.prisma✔ Generated Prisma Client (v6.2.1) to ./prisma/client in 24msStart by importing your Prisma Client (See: https://pris.ly/d/importing-client)Tip: Need your database queries to be 1000x faster? Accelerate offers you that and more: https://pris.ly/tip-2-accelerate

在这里插入图片描述

1.3 数据迁移

将数据模型推送到数据库中

// 模型推送
pnpx prisma db push// 将看到以下提示:
Environment variables loaded from .env
Prisma schema loaded from prisma/schema.prisma
Datasource "db": PostgreSQL database "xxxx", schema "public" at "xxxx:5432"🚀  Your database is now in sync with your Prisma schema. Done in 6.22s✔ Generated Prisma Client (v6.2.1) to ./prisma/client in 28ms

1.4 播种数据(可选)

添加ts-node@types/node到开发依赖项

pnpm add -D ts-node @types/node

Ps:非TypeScript项目需要增加typescript依赖包

prisma目录下创建一个seed.ts文件,写入播种数据

// 导入 PrismaClient(注:pnpx prisma generate生成的代码)
import { PrismaClient } from './client'// 创建 PrismaClient 实例
const prisma = new PrismaClient()// 定义 main 函数
async function main() {// 使用 upsert 方法创建或更新用户const alice = await prisma.user.upsert({where: { email: 'alice@prisma.io' },update: {},create: {email: 'alice@prisma.io',name: 'Alice',posts: {create: {title: 'Check out Prisma with Next.js',content: 'https://www.prisma.io/nextjs',published: true,},},},})// 创建另一个用户const bob = await prisma.user.upsert({where: { email: 'bob@prisma.io' },update: {},create: {email: 'bob@prisma.io',name: 'Bob',posts: {create: [{title: 'Follow Prisma on Twitter',content: 'https://twitter.com/prisma',published: true,},{title: 'Follow Nexus on Twitter',content: 'https://twitter.com/nexusgql',published: true,},],},},})console.log({ alice, bob })
}// 执行 main 函数并处理错误
main().then(async () => {await prisma.$disconnect()}).catch(async (e) => {console.error(e)await prisma.$disconnect()process.exit(1)})

package.json文件中新增以下配置,告诉prisma播种文件所在位置及其他配置信息

{// ....."prisma": {"seed": "ts-node --compiler-options {\"module\":\"CommonJS\"} prisma/seed.ts"},// .....
}

将种子数据推送上数据库里

// 种子推送
pnpx prisma db seed// 将看到以下提示:
Environment variables loaded from .env
Running seed command `ts-node --compiler-options {"module":"CommonJS"} prisma/seed.ts` ...
{alice: { id: 1, email: 'alice@prisma.io', name: 'Alice' },bob: { id: 2, email: 'bob@prisma.io', name: 'Bob' }
}🌱  The seed command has been executed.

在这里插入图片描述

1.5 模拟业务

创建一个api接口GET /api/users 用于获取用户表所有数据

1、实例化 Prisma 客户端

prisma目录创建一个db.ts文件,用于实例化
在这里插入图片描述

// file:/prisma/db.tsimport {PrismaClient} from './client'const globalForPrisma = globalThis as unknown as { prisma: PrismaClient }export const prisma = globalForPrisma.prisma || new PrismaClient()if (process.env.NODE_ENV !== 'production') globalForPrisma.prisma = prismaexport default prisma

2、创建数据API接口
在这里插入图片描述

"use server";import {NextResponse} from 'next/server'
// 导入客户端实例
import prisma from "@/prisma/db"export async function GET() {// 使用findMany方法获取user表相关数据const allUsers = await prisma.user.findMany();return NextResponse.json({message: 'Hello World',data: allUsers}, {status: 200});
}

3、测试获取是否正常
在这里插入图片描述


有何不足之处欢迎评论区或者私信我

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/diannao/67454.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

左神算法基础提升--3

文章目录 Manacher 算法经典算法Manacher算法原理 单调栈或单调队列 Manacher 算法 经典算法 在每学习Manacher算法之前我们可能会使用一种比较经典暴力的算法:遍历str字符串,将字符串中的每个字符作为对称点,向两边扩散找到回文字段&#x…

浅谈操作系统与初识Linux

一、Linux操作系统的出现 1.1操作系统的出现以及相关的四个要素 1.2最早出现的操作系统及其创始人 起初,IBM为了让计算机可以以更低技术成本进行使用,以此来售卖计算机; 为计算机搭载上了Unix操作系统,Unix由肯汤普森用汇编语…

ElasticSearch下

DSL查询 叶子查询:在特定字段里查询特定值,属于简单查询,很少单独使用复合查询:以逻辑方式组合多个叶子查询或更改叶子查询的行为方式 在查询后还可以对查询结果做处理: 排序:按照1个或多个字段做排序分页…

java根据模板导出word,并在word中插入echarts相关统计图片以及表格

引入依赖创建word模板创建ftl模板文件保存的ftl可能会出现占位符分割的问题,需要处理将ftl文件中的图片的Base64删除,并使用占位符代替插入表格,并指定表格的位置在图片下方 Echarts转图片根据模板生成word文档DocUtil导出word文档 生成的wor…

链式前向星的写法

【图论02】动画说图的三种保存方式 降低理解门槛 邻接表 链式前向星 邻接矩阵_哔哩哔哩_bilibili 杭电ACM刘老师-算法入门培训-第12讲-拓扑排序及链式前向星_哔哩哔哩_bilibili 图论003链式前向星_哔哩哔哩_bilibili(链式前向星的遍历) head数组的下标…

想品客老师的第一天:值类型使用

前面两章的摘要 ECMAscript(也就是ES)是JavaScript的一个标准,就像c的c11和c99一样,几把的一年出一套标准 freeze()是一个对象方法,表示锁定、固定一个对象不可改变(因为const对于标量不可变,…

贪心算法(题1)区间选点

输出 2 #include <iostream> #include<algorithm>using namespace std;const int N 100010 ;int n; struct Range {int l,r;bool operator <(const Range &W)const{return r<W.r;} }range[N];int main() {scanf("%d",&n);for(int i0;i&l…

解决本地运行MR程序访问权限问题

文章目录 1. 提出问题2. 解决问题2.1 临时解决方案2.2 永久解决方案 3. 小结 1. 提出问题 运行DeduplicateIPsDriver类&#xff0c;抛出如下异常&#xff1a; 该错误信息表明在尝试运行 DeduplicateIPsDriver 类时&#xff0c;遇到了 HDFS&#xff08;Hadoop 分布式文件系统&a…

html全局遮罩,通过websocket来实现实时发布公告

1.index.html代码示例 <div id"websocket" style"display:none;position: absolute;color:red;background-color: black;width: 100%;height: 100%;z-index: 100; opacity: 0.9; padding-top: 30%;padding-left: 30%; padding-border:1px; "onclick&q…

高通8255 Android STR 启动失败要因分析调查

目录 背景&#xff1a; 调查过程&#xff1a; 步骤1&#xff1a; slog2info | grep vmm_service 步骤2&#xff1a; slog2info | grep qvm 总结&#xff1a; 解决方案 背景&#xff1a; 调试高通8255 STR的STR过程中发现Android和QNX进入STR状态后&#xff0c;脱出STR时…

Linux UDP 编程详解

一、引言 在网络编程领域&#xff0c;UDP&#xff08;User Datagram Protocol&#xff0c;用户数据报协议&#xff09;作为一种轻量级的传输层协议&#xff0c;具有独特的优势和适用场景。与 TCP&#xff08;Transmission Control Protocol&#xff0c;传输控制协议&#xff0…

可解释性机器学习

一、引言 随着机器学习&#xff08;ML&#xff09;在各个领域的广泛应用&#xff0c;模型的复杂度不断增加&#xff0c;如深度神经网络等黑盒模型逐渐成为主流。这些模型虽然具有很高的预测性能&#xff0c;但其内部的决策机制往往难以理解&#xff0c;导致模型的透明度和可解释…

PyTorch使用教程(8)-一文了解torchvision

一、什么是torchvision torchvision提供了丰富的功能&#xff0c;主要包括数据集、模型、转换工具和实用方法四大模块。数据集模块内置了多种广泛使用的图像和视频数据集&#xff0c;如ImageNet、CIFAR-10、MNIST等&#xff0c;方便开发者进行训练和评估。模型模块封装了大量经…

网络安全防护指南:筑牢网络安全防线(510)

一、网络安全的基本概念 &#xff08;一&#xff09;网络的定义 网络是指由计算机或者其他信息终端及相关设备组成的按照一定的规则和程序对信息收集、存储、传输、交换、处理的系统。在当今数字化时代&#xff0c;网络已经成为人们生活和工作中不可或缺的一部分。它连接了世…

关于vite+vue3+ts项目中env.d.ts 文件详解

env.d.ts 文件是 Vite 项目中用于定义全局类型声明的 TypeScript 文件。它帮助开发者向 TypeScript提供全局的类型提示&#xff0c;特别是在使用一些特定于 Vite 的功能时&#xff08;如 import.meta.env&#xff09;。以下是详细讲解及代码示例 文章目录 **1. env.d.ts 文件的…

1.17学习

crypto nssctf-[SWPUCTF 2021 新生赛]crypto8 不太认识这是什么编码&#xff0c;搜索一下发现是一个UUENCODE编码&#xff0c;用在线工具UUENCODE解码计算器—LZL在线工具解码就好 misc buuctf-文件中的秘密 下载附件打开后发现是一个图片&#xff0c;应该是一个图片隐写&…

Python爬虫学习前传 —— Python从安装到学会一站式服务

早上好啊&#xff0c;大佬们。我们的python基础内容的这一篇终于写好了&#xff0c;啪唧啪唧啪唧…… 说实话&#xff0c;这一篇确实写了很久&#xff0c;一方面是在忙其他几个专栏的内容&#xff0c;再加上生活学业上的事儿&#xff0c;确实精力有限&#xff0c;另一方面&…

LabVIEW时域近场天线测试

随着通信技术的飞速发展&#xff0c;特别是在5G及未来通信技术中&#xff0c;天线性能的测试需求日益增加。对于短脉冲天线和宽带天线的时域特性测试&#xff0c;传统的频域测试方法已无法满足其需求。时域测试方法在这些应用中具有明显优势&#xff0c;可以提供更快速和精准的…

LabVIEW 程序中的 R6025 错误

R6025错误 通常是 运行时库 错误&#xff0c;特别是与 C 运行时库 相关。这种错误通常会在程序运行时出现&#xff0c;尤其是在使用 C 编译的程序或依赖 C 运行时库的程序时。 ​ 可能的原因&#xff1a; 内存访问冲突&#xff1a; R6025 错误通常是由于程序在运行时访问无效内…

【漏洞预警】FortiOS 和 FortiProxy 身份认证绕过漏洞(CVE-2024-55591)

文章目录 一、产品简介二、漏洞描述三、影响版本四、漏洞检测方法五、解决方案 一、产品简介 FortiOS是Fortinet公司核心的网络安全操作系统&#xff0c;广泛应用于FortiGate下一代防火墙&#xff0c;为用户提供防火墙、VPN、入侵防御、应用控制等多种安全功能。 FortiProxy则…