SuperAPI AI 工具集

prisma-postgres

部署与运维

查看项目

更新于 10-16 05:26

技能介绍

Prisma Postgres 是一个面向创建、管理和集成 Prisma Postgres 的指导技能,覆盖交互式与编程式两类工作流。

适用场景

以下情况可参考该技能:

  • 从 Prisma Console 设置 Prisma Postgres
  • 使用 create-db 预置即时的临时数据库
  • 用 prisma postgres link 关联已有的本地项目
  • 通过 Management API 管理 Prisma Postgres 资源
  • 在 TypeScript/JavaScript 中使用 @prisma/management-api-sdk
  • 处理 claim URL、连接字符串、区域和认证流程

规则按优先级分为四类:

  1. CLI Provisioning(CRITICAL,前缀 create-db-cli)
  2. Management API(CRITICAL,前缀 management-api)
  3. Management API SDK(HIGH,前缀 management-api-sdk)
  4. Console and Connections(HIGH,前缀 console-and-connections)

快速参考

  • create-db-cli:即时数据库与当前 CLI 标志(--ttl、--copy、--quiet、--open)
  • management-api:服务令牌与 OAuth API 工作流
  • management-api-sdk:带令牌存储的类型化 SDK 用法
  • console-and-connections:Console 操作、prisma postgres link、直连 TCP 连接与 serverless-driver 选择

核心工作流

  1. Console 优先工作流 使用 Prisma Console 进行手动设置与操作:
  • 打开 https://console.prisma.io
  • 创建/选择工作区和项目
  • 使用项目侧边栏中的 Studio 查看/编辑数据
  • 从项目 UI 获取直连连接信息
  1. 用 create-db 快速预置 需要立刻获得数据库时使用 create-db:

npx create-db@latest

别名:

npx create-pg@latest npx create-postgres@latest

用于应用集成时,也可以使用 create-db npm 包中的编程式 API(create() / regions())。 临时数据库若未被 claim,约 24 小时后自动删除。

2b. 使用 Platform CLI 创建持久数据库 对于属于某个 Project 的数据库(而非一次性的 create-db 数据库),使用 @prisma/cli:

npx -y @prisma/cli@latest database create --help npx -y @prisma/cli@latest database list --json npx -y @prisma/cli@latest database connection create db_123 npx -y @prisma/cli@latest database usage db_123 npx -y @prisma/cli@latest database backup list db_123

database create 和 database connection create 会打印一次性连接 URL,需立即保存。破坏性命令(remove、restore)需要精确的 --confirm <id>。 用于自动化时,建议使用 --json --no-interactive,在变更前先解析 id,并核对该 CLI 已安装命令的帮助信息,因为该 CLI 处于 beta 阶段。

  1. 关联已有本地项目 当数据库已存在、希望把本地项目接入它时,使用 prisma postgres link:

prisma postgres link

用于 CI 或其他非交互式环境:

prisma postgres link --api-key "<your-api-key>" --database "db_..."

该流程会用 DATABASE_URL 更新本地 .env,随后可运行 prisma generate 和 prisma migrate dev。

  1. 用 Management API 进行编程式预置 使用以下地址的 API 端点:

https://api.prisma.io/v1

探索 schema 与端点:

  • OpenAPI 文档:https://api.prisma.io/v1/doc
  • Swagger Editor:https://api.prisma.io/v1/swagger-editor

认证方式:

  • 服务令牌(工作区 server-to-server)
  • OAuth 2.0(代表用户操作)
  1. 用 Management API SDK 进行类型安全集成 安装并使用:

npm install @prisma/management-api-sdk

使用 createManagementApiClient 处理已有令牌,或使用 createManagementApiSdk 处理 OAuth + 令牌刷新。 该 SDK 暴露类型化的工作区服务令牌 list、create 和 revoke 路由。新建令牌的值只返回一次。确切的 beta 端点形态以已安装的 SDK 类型或 OpenAPI 文档为准。

规则文件 详细指导位于:

  • references/console-and-connections.md
  • references/create-db-cli.md
  • references/management-api.md
  • references/management-api-sdk.md

如何使用 先阅读 references/create-db-cli.md 进行快速设置,当需要编程式预置时,再切换到 references/management-api.md 或 references/management-api-sdk.md。

限制说明 资料未提供该技能的具体收费、价格、支持平台与性能效果等信息。