neon-postgres

原文：🇺🇸 英文

已翻译

Neon Serverless Postgres 使用指南与最佳实践。内容涵盖入门操作、Neon 本地开发、连接方式选择、Neon 功能特性、身份验证（@neondatabase/auth）、PostgREST 风格的数据 API（@neondatabase/neon-js）、Neon CLI 以及 Neon 平台 API/SDK。适用于所有与 Neon 相关的问题。

228.0k次下载

来源neondatabase/agent-skills

添加于2026-02-04

NPX安装

npx skill4agent add neondatabase/agent-skills neon-postgres

SKILL.md 内容（中文）

查看翻译对照 →

Neon Serverless Postgres

Neon 是一款无服务器 Postgres 平台，它将计算与存储分离，提供自动扩缩容、分支、即时恢复和缩容至零的功能。它完全兼容 Postgres，可与任何支持 Postgres 的语言、框架或 ORM 配合使用。

Neon 文档

在发表任何与 Neon 相关的声明前，请务必参考 Neon 官方文档。官方文档是所有 Neon 相关信息的权威来源。

以下是按领域划分的资源列表，旨在帮助您找到合适的文档页面并提供额外的背景信息。

您可以使用

curl

命令获取文档页面的 markdown 格式内容：

文档获取方式：

bash

# 获取所有 Neon 文档列表
curl https://neon.com/llms.txt

# 获取指定文档页面的 markdown 格式内容
curl -H "Accept: text/markdown" https://neon.com/docs/<path>

请勿猜测文档页面路径。请使用

llms.txt

索引查找相关 URL，或点击下方资源中的链接。

资源概览

根据用户需求参考对应的资源文件：

核心指南

领域	资源文件	适用场景
什么是 Neon	`references/what-is-neon.md`	了解 Neon 概念、架构、核心资源
文档参考方法	`references/referencing-docs.md`	查阅官方文档、验证信息准确性
功能特性	`references/features.md`	分支、自动扩缩容、缩容至零、即时恢复等功能相关内容
入门指南	`references/getting-started.md`	项目搭建、连接字符串、依赖配置、数据库架构设置
连接方式选择	`references/connection-methods.md`	根据平台和运行时选择合适的驱动程序
开发者工具	`references/devtools.md`	VSCode 扩展、MCP 服务器、Neon CLI（ `neon init` 命令）

数据库驱动与 ORM

适用于无服务器/边缘函数的 HTTP/WebSocket 查询。

领域	资源文件	适用场景
无服务器驱动	`references/neon-serverless.md`	`@neondatabase/serverless` - HTTP/WebSocket 查询
Drizzle ORM	`references/neon-drizzle.md`	Drizzle ORM 与 Neon 的集成使用

身份验证与数据 API SDK

Neon 的身份验证与 PostgREST 风格的数据 API。

领域	资源文件	适用场景
Neon 身份验证	`references/neon-auth.md`	`@neondatabase/auth` - 仅用于身份验证功能
Neon JS SDK	`references/neon-js.md`	`@neondatabase/neon-js` - 身份验证 + PostgREST 风格查询的数据 API

Neon 平台 API 与 CLI

通过 REST API、SDK 或 CLI 以编程方式管理 Neon 资源。

领域	资源文件	适用场景
平台 API 概览	`references/neon-platform-api.md`	通过 REST API 管理 Neon 资源
Neon CLI	`references/neon-cli.md`	终端工作流、脚本编写、CI/CD 流水线集成
TypeScript SDK	`references/neon-typescript-sdk.md`	`@neondatabase/api-client` 相关使用
Python SDK	`references/neon-python-sdk.md`	`neon-api` 包的使用