name: using-neon description: 使用 Neon Serverless Postgres 的指南和最佳实践。涵盖入门、本地开发、选择连接方法、Neon 功能、身份验证 (@neondatabase/auth)、PostgREST 风格数据 API (@neondatabase/neon-js)、Neon CLI 和 Neon 平台 API/SDKs。用于任何与 Neon 相关的问题。
Neon Serverless Postgres
Neon 是一个无服务器的 Postgres 平台，通过分离计算和存储来提供自动扩展、分支、即时恢复和零缩放。它与 Postgres 完全兼容，并支持任何支持 Postgres 的语言、框架或 ORM。
Neon 文档
在做出与 Neon 相关的声明之前，始终参考 Neon 文档。文档是所有 Neon 相关信息的真相来源。
下面你将找到按关注领域组织的资源列表。这旨在帮助你找到正确的文档页面，并添加一些额外的上下文。
你可以使用 curl 命令来获取文档页面作为 Markdown：
文档：
# 获取所有 Neon 文档的列表
curl https://neon.tech/llms.txt
# 以 Markdown 格式获取任何文档页面
curl -H "Accept: text/markdown" https://neon.tech/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) |
数据库驱动程序 & ORMs
用于无服务器/边缘函数的 HTTP/WebSocket 查询。
| 区域 | 资源 | 何时使用 |
|---|---|---|
| 无服务器驱动程序 | references/neon-serverless.md |
@neondatabase/serverless - HTTP/WebSocket 查询 |
| Drizzle ORM | references/neon-drizzle.md |
Drizzle ORM 与 Neon 的集成 |
认证 & 数据 API SDKs
Neon 的身份验证和 PostgREST 风格的数据 API。
| 区域 | 资源 | 何时使用 |
|---|---|---|
| Neon 认证 | references/neon-auth.md |
@neondatabase/auth - 仅身份验证 |
| Neon JS SDK | references/neon-js.md |
@neondatabase/neon-js - 认证 + 数据 API (PostgREST 风格查询) |
Neon 平台 API & CLI
通过 REST API、SDKs 或 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 包 |