SuperAPI AI 工具集

prisma-cli

编程与开发

查看项目

更新于 10-16 10:57

技能介绍

用途

本技能是 Prisma CLI 的完整参考,面向 Prisma ORM 7.x,提供命令用法、选项与最佳实践指引。当你需要运行 Prisma CLI 命令、搭建新项目、生成 Prisma Client、执行数据库迁移、管理数据库状态、使用本地开发数据库或调试 Prisma 问题时,可参考本技能。

适用时机

  • 搭建新的 Prisma 项目(prisma init)
  • 生成 Prisma Client(prisma generate)
  • 运行数据库迁移(prisma migrate)
  • 管理数据库状态(prisma db push/pull)
  • 使用本地开发数据库(prisma dev)
  • 调试 Prisma 问题(prisma debug)

规则分类与优先级

按优先级划分的规则类别:

优先级 类别 影响 前缀
1 Setup HIGH init
2 Generation HIGH generate
3 Development HIGH dev
4 Database HIGH db-
5 Migrations CRITICAL migrate-
6 Utility MEDIUM studio, validate, format, debug

命令类别

类别 命令 用途
Setup init 引导新 Prisma 项目
Generation generate 生成 Prisma Client
Validation validate, format Schema 校验与格式化
Development dev 用于开发的本地 Prisma Postgres
Database db pull, db push, db seed, db execute 直接数据库操作
Migrations migrate dev, migrate deploy, migrate reset, migrate status, migrate diff, migrate resolve Schema 迁移
Utility studio, version, debug 开发工具

快速参考

项目初始化

# 初始化新项目(创建 prisma/ 文件夹和 prisma.config.ts)
prisma init

# 使用指定数据库初始化
prisma init --datasource-provider postgresql
prisma init --datasource-provider mysql
prisma init --datasource-provider sqlite

# 使用 Prisma Postgres(云)初始化
prisma init --db

# 使用 AI 生成的 schema 初始化
prisma init --prompt "E-commerce app with users, products, orders"

客户端生成

# 生成 Prisma Client
prisma generate

# 开发用监听模式
prisma generate --watch

# 不生成引擎(用于 Accelerate/edge)
prisma generate --no-engine

# 仅生成指定 generator
prisma generate --generator client

Bun 运行时

使用 Bun 时始终添加 --bun 标志,以便 Prisma 使用 Bun 运行时(否则由于 CLI shebang,会回退到 Node.js):

bunx --bun prisma init
bunx --bun prisma generate

本地开发数据库

# 启动本地 Prisma Postgres
prisma dev

# 使用指定名称启动
prisma dev --name myproject

# 后台启动(分离模式)
prisma dev --detach

# 列出所有本地实例
prisma dev ls

# 停止实例
prisma dev stop myproject

# 移除实例数据
prisma dev rm myproject

数据库操作

# 从现有数据库拉取 schema
prisma db pull

# 推送 schema 到数据库(不生成迁移)
prisma db push

# 填充数据库
prisma db seed

# 执行原始 SQL
prisma db execute --file ./script.sql

迁移(开发)

# 创建并应用迁移
prisma migrate dev

# 创建带名称的迁移
prisma migrate dev --name add_users_table

# 仅创建迁移但不应用
prisma migrate dev --create-only

# 重置数据库并应用所有迁移
prisma migrate reset

迁移(生产)

# 应用待处理迁移(CI/CD)
prisma migrate deploy

# 检查迁移状态
prisma migrate status

# 比较 schema 并生成 diff
prisma migrate diff --from-config-datasource --to-schema schema.prisma --script

实用命令

# 打开 Prisma Studio(数据库 GUI)
prisma studio

# 显示版本信息
prisma version
prisma -v

# 调试信息
prisma debug

# 校验 schema
prisma validate

# 格式化 schema
prisma format

Prisma 7 变化

新配置文件

Prisma 7 使用 prisma.config.ts 作为 CLI 配置:

import 'dotenv/config'
import { defineConfig, env } from 'prisma/config'

export default defineConfig({
  schema: 'prisma/schema.prisma',
  migrations: {
    path: 'prisma/migrations',
    seed: 'tsx prisma/seed.ts',
  },
  datasource: {
    url: env('DATABASE_URL'),
  },
})

已移除的标志

  • --skip-generate 从 migrate dev 和 db push 中移除
  • --skip-seed 从 migrate dev 中移除
  • --schema 和 --url 从 db execute 中移除
  • 迁移后需显式运行 prisma generate

环境变量

环境变量不再自动加载,需使用 dotenv:

// prisma.config.ts
import 'dotenv/config'

规则文件

各命令的详细文档见以下单独规则文件:

  • references/init.md - 项目初始化
  • references/generate.md - 客户端生成
  • references/dev.md - 本地开发数据库
  • references/db-pull.md - 数据库内省
  • references/db-push.md - Schema 推送
  • references/db-seed.md - 数据库填充
  • references/db-execute.md - 原始 SQL 执行
  • references/migrate-dev.md - 开发迁移
  • references/migrate-deploy.md - 生产迁移
  • references/migrate-reset.md - 数据库重置
  • references/migrate-status.md - 迁移状态
  • references/migrate-resolve.md - 迁移解决
  • references/migrate-diff.md - Schema 差异比较
  • references/studio.md - 数据库 GUI
  • references/validate.md - Schema 校验
  • references/format.md - Schema 格式化
  • references/debug.md - 调试信息

如何使用

使用上述命令类别进行导航,然后打开你需要的具体命令参考文件。