prisma-postgres

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Prisma Postgres

Prisma Postgres

Guidance for creating, managing, and integrating Prisma Postgres across interactive and programmatic workflows.
本指南介绍如何在交互式与程序化工作流中创建、管理和集成Prisma Postgres。

When to Apply

适用场景

Reference this skill when:
  • Setting up Prisma Postgres from Prisma Console
  • Provisioning instant temporary databases with
    create-db
  • Managing Prisma Postgres resources via Management API
  • Using
    @prisma/management-api-sdk
    in TypeScript/JavaScript
  • Handling claim URLs, connection strings, regions, and auth flows
以下场景可参考本技能:
  • 从Prisma Console设置Prisma Postgres
  • 使用
    create-db
    配置即时临时数据库
  • 通过Management API管理Prisma Postgres资源
  • 在TypeScript/JavaScript中使用
    @prisma/management-api-sdk
  • 处理申领URL、连接字符串、区域及认证流程

Rule Categories by Priority

按优先级划分的规则类别

PriorityCategoryImpactPrefix
1CLI ProvisioningCRITICAL
create-db-cli
2Management APICRITICAL
management-api
3Management API SDKHIGH
management-api-sdk
4Console and ConnectionsHIGH
console-and-connections
优先级类别影响级别前缀
1CLI资源配置关键
create-db-cli
2Management API关键
management-api
3Management API SDK
management-api-sdk
4Console与连接
console-and-connections

Quick Reference

快速参考

  • create-db-cli
    - instant databases and CLI options
  • management-api
    - service token and OAuth API workflows
  • management-api-sdk
    - typed SDK usage with token storage
  • console-and-connections
    - Console operations and connection setup
  • create-db-cli
    - 即时数据库与CLI选项
  • management-api
    - 服务令牌与OAuth API工作流
  • management-api-sdk
    - 带令牌存储的类型化SDK使用方法
  • console-and-connections
    - Console操作与连接设置

Core Workflows

核心工作流

1. Console-first workflow

1. 以Console为主的工作流

Use Prisma Console for manual setup and operations:
  • Open
    https://console.prisma.io
  • Create/select workspace and project
  • Use Studio in the project sidebar to view/edit data
  • Retrieve direct connection details from the project UI
使用Prisma Console进行手动设置与操作:
  • 打开
    https://console.prisma.io
  • 创建/选择工作区与项目
  • 使用项目侧边栏的Studio查看/编辑数据
  • 从项目界面获取直接连接详情

2. Quick provisioning with create-db

2. 使用create-db快速配置

Use
create-db
when you need a database immediately:
bash
npx create-db@latest
Aliases:
bash
npx create-pg@latest
npx create-postgres@latest
For app integrations, you can also use the programmatic API (
create()
/
regions()
) from the
create-db
npm package.
Temporary databases auto-delete after ~24 hours unless claimed.
当您需要立即创建数据库时,使用
create-db
bash
npx create-db@latest
别名:
bash
npx create-pg@latest
npx create-postgres@latest
对于应用集成,您还可以使用
create-db
npm包中的程序化API(
create()
/
regions()
)。
临时数据库若未被申领,将在约24小时后自动删除。

3. Programmatic provisioning with Management API

3. 使用Management API进行程序化配置

Use API endpoints on:
text
https://api.prisma.io/v1
Explore the schema and endpoints using:
  • OpenAPI docs:
    https://api.prisma.io/v1/doc
  • Swagger Editor:
    https://api.prisma.io/v1/swagger-editor
Auth options:
  • Service token (workspace server-to-server)
  • OAuth 2.0 (act on behalf of users)
使用以下地址的API端点:
text
https://api.prisma.io/v1
可通过以下方式查看架构与端点:
  • OpenAPI文档:
    https://api.prisma.io/v1/doc
  • Swagger编辑器:
    https://api.prisma.io/v1/swagger-editor
认证选项:
  • 服务令牌(工作区服务器到服务器)
  • OAuth 2.0(代表用户操作)

4. Type-safe integration with Management API SDK

4. 使用Management API SDK实现类型安全集成

Install and use:
bash
npm install @prisma/management-api-sdk
Use
createManagementApiClient
for existing tokens, or
createManagementApiSdk
for OAuth + token refresh.
安装与使用:
bash
npm install @prisma/management-api-sdk
对于现有令牌,使用
createManagementApiClient
;若需OAuth+令牌刷新,使用
createManagementApiSdk

Rule Files

规则文件

Detailed guidance lives in:
references/console-and-connections.md
references/create-db-cli.md
references/management-api.md
references/management-api-sdk.md
详细指南位于:
references/console-and-connections.md
references/create-db-cli.md
references/management-api.md
references/management-api-sdk.md

How to Use

使用方法

Start with
references/create-db-cli.md
for fast setup, then switch to
references/management-api.md
or
references/management-api-sdk.md
when you need programmatic provisioning.
快速设置可从
references/create-db-cli.md
开始,当需要程序化配置时,再切换到
references/management-api.md
references/management-api-sdk.md