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 設定 Prisma Postgres
- 使用
create-db佈建即時臨時資料庫 - 使用
prisma postgres link連結現有本地專案 - 透過 Management API 管理 Prisma Postgres 資源
- 在 TypeScript/JavaScript 中使用
@prisma/management-api-sdk - 處理領取網址、連線字串、區域及驗證流程
規則類別(依優先順序)
| 優先順序 | 類別 | 影響 | 前綴 |
|---|---|---|---|
| 1 | CLI 佈建 | 關鍵 | create-db-cli |
| 2 | Management API | 關鍵 | management-api |
| 3 | Management API SDK | 高 | management-api-sdk |
| 4 | Console 與連線 | 高 | 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 取得直接連線詳細資訊
2. 使用 create-db 快速佈建
當您需要立即取得資料庫時,請使用 create-db:
npx create-db@latest
別名:
npx create-pg@latest
npx create-postgres@latest
對於應用程式整合,您也可以使用 create-db npm 套件中的程式化 API(create() / regions())。
臨時資料庫約在 24 小時後自動刪除,除非已領取。
3. 連結現有本地專案
當資料庫已存在且您想將本地專案與其連結時,請使用 prisma postgres link:
prisma postgres link
對於 CI 或其他非互動式環境:
prisma postgres link --api-key "<your-api-key>" --database "db_..."
此流程會更新您本地的 .env 檔案中的 DATABASE_URL,接著您可以執行 prisma generate 和 prisma migrate dev。
4. 使用 Management API 進行程式化佈建
使用以下 API 端點:
https://api.prisma.io/v1
透過以下方式探索架構與端點:
- OpenAPI 文件:
https://api.prisma.io/v1/doc - Swagger Editor:
https://api.prisma.io/v1/swagger-editor
驗證選項:
- 服務令牌(工作區伺服器對伺服器)
- OAuth 2.0(代表使用者操作)
5. 使用 Management API SDK 進行型別安全整合
安裝並使用:
npm install @prisma/management-api-sdk
使用 createManagementApiClient 處理現有令牌,或使用 createManagementApiSdk 處理 OAuth 與令牌重新整理。
規則檔案
詳細指南位於:
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。






