Codex 插件【Neon Postgres】：管理 Neon Postgres 数据库

Neon Postgres 插件就像一个面向 Serverless Postgres 的数据库管理助手，适合在 Codex 中创建、连接、查询、迁移和管理 Neon 数据库。它可以帮助开发者把数据库操作放进日常开发流程中，更方便地处理项目数据库、测试分支、SQL 查询、连接配置和上线前验证。

一、Neon Postgres 能做什么

图 1：Neon Postgres 管理数据库的基本流程

1、创建和管理项目

Neon 以 project 为核心组织数据库资源。一个项目可以包含数据库、分支、角色、连接信息和计算端点。

Neon Postgres 插件可以帮助用户创建项目、查看项目配置、检查连接状态，并整理项目与应用之间的关系。

2、管理数据库和表结构

Postgres 数据库通常包含表、字段、索引、约束、视图、函数和权限。插件可以辅助查看 schema，运行 SQL 查询，检查表结构，并为应用开发生成数据库操作建议。

这适合在开发阶段快速确认数据模型是否合理。

3、使用数据库分支

Neon 的重要特性之一是数据库分支。分支可以理解为数据库的隔离副本，适合用于开发、测试、预览环境和迁移验证。

例如每个 Pull Request 可以对应一个独立数据库分支，避免多人共用测试库造成数据互相影响。

4、配置连接方式

应用连接数据库时，需要选择合适的连接方式，例如普通连接、连接池、ORM、服务端函数、边缘运行时或 Serverless 环境连接。

Neon Postgres 插件可以帮助根据框架和运行环境选择连接方式，并提醒连接字符串、环境变量和安全配置。

5、辅助迁移与上线验证

数据库变更风险较高。插件可以帮助设计迁移步骤、在分支中测试 schema 修改、运行验证 SQL，并在上线前检查是否存在破坏性变更。

二、怎样把任务说清楚

使用 Neon Postgres 时，不要只说“帮我弄数据库”。更好的做法是说明项目类型、数据库任务、运行环境、连接方式和安全要求。

至少应说清楚以下几类信息：

1、项目类型：Web 应用、SaaS 后台、AI 应用、数据分析、API 服务、内部工具或多租户系统。

2、数据库任务：创建项目、创建数据库、查看表结构、运行 SQL、创建分支、迁移 schema、配置连接或排查问题。

3、技术栈：Next.js、Node.js、Python、Django、FastAPI、Drizzle、Prisma、SQLAlchemy、Vercel、Cloudflare Workers 等。

4、数据对象：用户、订单、客户、消息、任务、日志、文件、会话、支付记录或业务表。

5、边界要求：不暴露连接字符串、不删除生产数据、不修改生产库、保留迁移记录、先在分支中验证。

可以使用下面的模板：

请使用 Neon Postgres 插件处理这个数据库任务。

项目类型：[Web 应用 / API / SaaS / AI 应用 / 内部工具]

技术栈：[Next.js / Node.js / Python / Drizzle / Prisma / 其他]

数据库任务：[创建项目 / 查询数据 / 创建分支 / 迁移 / 配置连接]

数据对象：[用户、订单、任务、客户、日志等]

运行环境：[本地 / 预览环境 / 生产环境 / Serverless / Edge]

安全要求：[不暴露密钥 / 不修改生产库 / 先创建分支验证]

输出形式：[SQL / 连接配置 / 迁移步骤 / 排查建议 / 测试清单]

完成后请说明：数据库结构、连接方式、执行步骤、风险点和验证方法。

三、场景示例

示例 1：创建应用数据库

请使用 Neon Postgres 插件为一个任务管理应用创建数据库。

要求包含用户表、项目表、任务表和评论表，并说明表之间的关系、主键、外键和常用索引。

示例 2：为 Pull Request 创建数据库分支

请使用 Neon Postgres 插件为当前 Pull Request 创建一个数据库分支。

要求从主分支复制结构和必要数据，用于测试 schema 迁移和预览部署。测试完成后说明如何清理该分支。

示例 3：配置 Next.js 连接 Neon

请使用 Neon Postgres 插件为 Next.js 项目配置数据库连接。

要求说明环境变量、连接池、ORM 选择、开发环境和生产环境差异，并提醒不要把连接字符串提交到仓库。

示例 4：运行迁移前检查

请使用 Neon Postgres 插件检查一组数据库迁移。

要求先在测试分支中执行，确认是否会删除字段、破坏索引、影响现有查询或造成数据不兼容。

示例 5：排查数据库连接失败

请使用 Neon Postgres 插件排查应用连接 Neon 失败的问题。

要求检查连接字符串、数据库角色、网络访问、SSL 配置、环境变量、连接池和框架配置，并按优先级给出修复步骤。

四、使用时要注意

1、生产数据库要谨慎操作

删除表、修改字段、清空数据、重建索引等操作可能影响真实业务。重要操作应先在分支中验证。

2、连接字符串不能泄露

数据库连接字符串通常包含用户名、密码、主机和数据库名，应放在安全环境变量中，不能写入代码、日志或公开文档。

3、分支不是永久垃圾箱

数据库分支适合测试和预览，但不再使用的分支应及时清理，避免资源混乱和成本增加。

4、迁移要可回滚

数据库迁移应保留版本记录，重要变更应设计回滚方案，避免上线后难以恢复。

5、连接方式要适配运行环境

传统服务器、Serverless 函数、边缘运行时和长连接服务对数据库连接的要求不同。应根据部署环境选择合适连接方式。

小结

Neon Postgres 插件适合管理 Neon Serverless Postgres 数据库，涵盖项目创建、数据库分支、SQL 查询、连接配置、迁移验证和问题排查。使用时要明确项目类型、技术栈、数据库任务、安全边界和验证方式，让数据库开发更安全、更可控。

“点赞有美意，赞赏是鼓励”