prisma-postgres
Prisma Postgres 在 Console、create-db CLI、Management API 及 Management API SDK 中的设置
技能说明
Prisma Postgres 在 Console、create-db CLI、Management API 及 Management API SDK 中的设置与操作指南。适用于创建 Prisma Postgres 数据库、在 Prisma Console 中操作、使用 create-db/create-pg/create-postgres 进行配置,或通过服务令牌或 OAuth 集成编程式配置。
技能简介
prisma-postgres 是面向 Prisma Postgres 数据库的配置与操作指南,涵盖 Prisma Console、create-db CLI、Management API 以及 Management API SDK。它可以帮助你快速创建数据库、管理 Prisma Postgres 资源,并将程序化配置集成到应用开发流程中。
使用场景
- 在 Prisma Console 中手动创建和管理 Prisma Postgres 数据库
- 使用
create-db快速申请临时或短期数据库实例 - 通过 Management API 完成服务端到服务端的资源管理
- 在 TypeScript/JavaScript 项目中使用
@prisma/management-api-sdk - 处理 claim URL、连接字符串、区域选择及认证流程(OAuth/Service Token)
使用方法
1. Console 优先流程
打开 https://console.prisma.io,创建或选择 workspace 和 project,通过项目侧边栏的 Studio 查看或编辑数据,并从项目 UI 获取直接连接信息。
2. 使用 create-db 快速配置
需要立即使用数据库时,运行:
npx create-db@latest
也可使用别名:
npx create-pg@latest
npx create-postgres@latest
如需应用集成,可调用 create-db npm 包中的程序化 API(create() / regions())。临时数据库约 24 小时后自动删除,除非手动 claim。
3. 使用 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
认证方式:
- Service Token(workspace 服务端到服务端认证)
- OAuth 2.0(代表用户进行操作)
4. 使用 Management API SDK 进行类型安全集成
安装:
npm install @prisma/management-api-sdk
已有 token 时使用 createManagementApiClient;需要 OAuth 和 token 刷新时使用 createManagementApiSdk。
注意事项
- 建议先阅读
references/create-db-cli.md快速完成配置,再根据需求参考references/management-api.md或references/management-api-sdk.md。 - 临时数据库会自动删除,请注意时效并及时 claim。
- 详细规则文件位于
references/目录,按优先级分为 CLI Provisioning、Management API、Management API SDK、Console and Connections 四类。