using-neon

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Neon Serverless Postgres

Neon Serverless Postgres

Neon is a serverless Postgres platform that separates compute and storage to offer autoscaling, branching, instant restore, and scale-to-zero. It's fully compatible with Postgres and works with any language, framework, or ORM that supports Postgres.
Neon是一款无服务器Postgres平台,它将计算与存储分离,提供自动扩缩容、分支、即时恢复和缩容至零的功能。它完全兼容Postgres,可与任何支持Postgres的语言、框架或ORM配合使用。

Neon Documentation

Neon文档

Always reference the Neon documentation before making Neon-related claims. The documentation is the source of truth for all Neon-related information.
Below you'll find a list of resources organized by area of concern. This is meant to support you find the right documentation pages to fetch and add a bit of additonal context.
You can use the
curl
commands to fetch the documentation page as markdown:
Documentation:
bash
undefined
在发表任何与Neon相关的声明之前,请务必参考Neon官方文档。文档是所有Neon相关信息的权威来源。
以下是按关注领域整理的资源列表,旨在帮助您找到合适的文档页面,并提供一些额外的上下文信息。
您可以使用
curl
命令以markdown格式获取文档页面:
文档获取方式:
bash
undefined

Get list of all Neon docs

Get list of all Neon docs

Fetch any doc page as markdown

Fetch any doc page as markdown

curl -H "Accept: text/markdown" https://neon.tech/docs/<path>

Don't guess docs pages. Use the `llms.txt` index to find the relevant URL or follow the links in the resources below.
curl -H "Accept: text/markdown" https://neon.tech/docs/<path>

不要猜测文档页面的路径。请使用`llms.txt`索引找到相关URL,或点击下方资源中的链接。

Overview of Resources

资源概览

Reference the appropriate resource file based on the user's needs:
根据用户需求参考相应的资源文件:

Core Guides

核心指南

AreaResourceWhen to Use
What is Neon
references/what-is-neon.md
Understanding Neon concepts, architecture, core resources
Referencing Docs
references/referencing-docs.md
Looking up official documentation, verifying information
Features
references/features.md
Branching, autoscaling, scale-to-zero, instant restore
Getting Started
references/getting-started.md
Setting up a project, connection strings, dependencies, schema
Connection Methods
references/connection-methods.md
Choosing drivers based on platform and runtime
Developer Tools
references/devtools.md
VSCode extension, MCP server, Neon CLI (
neon init
)
领域资源文件使用场景
什么是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
命令)

Database Drivers & ORMs

数据库驱动与ORM

HTTP/WebSocket queries for serverless/edge functions.
AreaResourceWhen to Use
Serverless Driver
references/neon-serverless.md
@neondatabase/serverless
- HTTP/WebSocket queries
Drizzle ORM
references/neon-drizzle.md
Drizzle ORM integration with Neon
适用于无服务器/边缘函数的HTTP/WebSocket查询。
领域资源文件使用场景
无服务器驱动
references/neon-serverless.md
@neondatabase/serverless
- HTTP/WebSocket查询
Drizzle ORM
references/neon-drizzle.md
Drizzle ORM与Neon的集成使用

Auth & Data API SDKs

身份验证与数据API SDK

Authentication and PostgREST-style data API for Neon.
AreaResourceWhen to Use
Neon Auth
references/neon-auth.md
@neondatabase/auth
- Authentication only
Neon JS SDK
references/neon-js.md
@neondatabase/neon-js
- Auth + Data API (PostgREST-style queries)
Neon的身份验证和PostgREST风格的数据API。
领域资源文件使用场景
Neon身份验证
references/neon-auth.md
@neondatabase/auth
- 仅用于身份验证功能
Neon JS SDK
references/neon-js.md
@neondatabase/neon-js
- 身份验证 + 数据API(PostgREST风格查询)

Neon Platform API & CLI

Neon平台API与CLI

Managing Neon resources programmatically via REST API, SDKs, or CLI.
AreaResourceWhen to Use
Platform API Overview
references/neon-platform-api.md
Managing Neon resources via REST API
Neon CLI
references/neon-cli.md
Terminal workflows, scripts, CI/CD pipelines
TypeScript SDK
references/neon-typescript-sdk.md
@neondatabase/api-client
Python SDK
references/neon-python-sdk.md
neon-api
package
通过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
包的使用