website

Prisma Docs

所属分类:开发者在线工具箱

Prisma 官方文档:TypeScript 数据层、PostgreSQL 接入与部署指南

Prisma 官方文档介绍一套以 TypeScript 为核心的开发与部署流程:先在本机用 ORM、Composer 和本地数据库搭建应用,再通过一条命令部署到 Prisma 平台。文档默认展示 Prisma ORM 8 的内容,Prisma ORM 7 的文档保留在 /orm/v7 路径下。

Prisma 官方文档:用 TypeScript 搭建数据应用,接入 PostgreSQL 并部署

发布于 2026年10月18日更新于 2026年10月29日

首页的两条路线

首页“Get started with Prisma”分为 Build 与 Deploy 两栏。Build 栏列出三项:Local development 可以在本机用 Bun 运行整个应用,并连接本地 Postgres 和本地存储,无需云端凭据;Composer用于声明服务及其依赖的数据库、任务、存储桶和密钥;ORM 则用类型安全的方式建模和查询数据。Deploy 栏列出 Compute、Storage、Postgres 和 Deploy 四项,分别对应托管服务、S3 兼容对象存储、托管 PostgreSQL,以及从终端、控制台或代码仓库推送部署,每个分支都有独立环境。

Prisma 文档首页“Get started with Prisma”,分为 Build 与 Deploy 两栏,列出本地开发、Composer、ORM、计算、存储和 Postgres 等入口

左侧目录的分组

文档目录分为 Start、Build、Deploy、Manage 和 Reference 五组。Manage 下有 Console、Studio 与 Query Insights,Reference 下有 Guides、CLI、REST API、AI 和 Accelerate。

为已有 PostgreSQL 数据库接入 ORM

“Add Prisma ORM to an existing PostgreSQL project”页面按编号列出步骤。第一步在项目根目录运行 bunx prisma@latest orm init --yes --target postgres --authoring psl --write-env,命令会安装 ORM 包,并生成示例契约文件 src/prisma/contract.prisma、查询入口 src/prisma/db.ts 和 .env 文件。第二步在 .env 中填写 DATABASE_URL,指向用于开发的数据库副本。

Prisma 快速入门页面,标题为“Add Prisma ORM and PostgreSQL to an existing app”,右侧目录列出七个步骤,并提示 Prisma ORM 8 为候选版本

截图中的页面标题为“Add Prisma ORM and PostgreSQL to an existing app”,并称 Prisma ORM 8 为候选版本;截至 2026 年 10 月,该主题页面的标题为“Add Prisma ORM to an existing PostgreSQL project”,Prisma ORM 8 已正式发布。

从已有表生成契约

第四步使用 bunx prisma contract infer --output ./src/prisma/contract.prisma 读取数据库中的表,并生成描述这些表的契约文件。页面示例显示,主键、唯一约束、列默认值、外键及删除规则、检查约束、索引和行级安全策略都会被写入契约。页面还提醒,可以重命名模型,但要保留 @@map 行,使模型仍然对应原来的表名。

文档的其他入口

每个文档页都可以在地址后加上 .md 获取 Markdown 版本,站点同时提供 llms.txt 索引,页面说明该索引面向 AI 代理优化。页面顶部还有 Ask AI 问答入口和站内搜索框。