neon-postgres

Neon Serverless Postgres

Neon は、コンピュートとストレージを分離するサーバーレス Postgres プラットフォームです。オートスケーリング、ブランチ作成、即時復元、スケール・トゥ・ゼロを提供します。Postgres と完全な互換性があり、Postgres をサポートするあらゆる言語、フレームワーク、ORM で利用できます。

Neon のドキュメント

Neon に関するあらゆる情報の一次情報源は、Neon のドキュメントです。回答する前に、必ず公式ドキュメントで内容を確認してください。Neon の機能や API は進化するため、学習データに頼るのではなく、最新のドキュメントを取得してください。

ドキュメントを Markdown として取得する

Neon のドキュメントページは、次の 2 つの方法で Markdown として取得できます。

1. URL に .md を追加する（最も簡単）：https://neon.com/docs/introduction/branching.md
2. 標準 URL で text/markdown をリクエストする：curl -H "Accept: text/markdown" https://neon.com/docs/introduction/branching

どちらも同じ Markdown コンテンツを返します。お使いのツールで対応している方法を利用してください。

適切なページを見つける

ドキュメントのインデックスには、利用可能なすべてのページと、その URL および簡単な説明が記載されています。

https://neon.com/docs/llms.txt

よく使われるドキュメントの URL は、以下のトピック別リンクにまとめられています。ここに記載されていないページが必要な場合は、URL を推測せず、ドキュメントのインデックスを検索してください。

Neon とは

実装方法を説明する前に、アーキテクチャと用語（組織、プロジェクト、ブランチ、エンドポイント）を確認する際に利用してください。

リンク：references/what-is-neon.md

はじめに

初回セットアップ（組織／プロジェクトの選択、接続文字列、ドライバーのインストール、任意の認証、初期スキーマの設定）に利用してください。

リンク：references/getting-started.md

接続方法とドライバー

ランタイムの制約（TCP、HTTP、WebSocket、エッジ、サーバーレス、長時間実行）に応じて適切なトランスポートとドライバーを選ぶ際に利用してください。

リンク：references/connection-methods.md

Serverless Driver

HTTP クエリ、WebSocket トランザクション、ランタイム固有の最適化など、@neondatabase/serverless の利用パターンを確認する際に利用してください。

リンク：references/neon-serverless.md

Neon JS SDK

PostgREST スタイルのクエリと型付きクライアントのセットアップを用いた、Neon Auth と Data API を組み合わせたワークフローに利用してください。

リンク：references/neon-js.md

開発者ツール

npx neonctl@latest init によるローカル開発環境の有効化、VSCode 拡張機能のセットアップ、Neon MCP サーバーの設定に利用してください。

リンク：references/devtools.md

Neon CLI

neonctl を使った、ターミナル中心のワークフロー、スクリプト、CI/CD の自動化に利用してください。

リンク：references/neon-cli.md

Neon Admin API

Neon Admin API を使うと、Neon のリソースをプログラムから管理できます。Neon CLI と MCP サーバーの内部でも使用されていますが、より複雑な自動化ワークフローや、Neon を他のアプリケーションに組み込む場合に直接利用することもできます。

Neon REST API

直接 HTTP で自動化する場合、エンドポイントレベルの制御、API キー認証、レート制限への対応、操作のポーリングに利用してください。

リンク：references/neon-rest-api.md

Neon TypeScript SDK

@neondatabase/api-client を使用して、TypeScript から Neon のリソースを型付きでプログラム制御する実装に利用してください。

リンク：references/neon-typescript-sdk.md

Neon Python SDK

neon-api パッケージを使用して、Python から Neon をプログラムで管理する実装に利用してください。

リンク：references/neon-python-sdk.md

Neon Auth

マネージドユーザー認証のセットアップ、UI コンポーネント、認証方法、Next.js および React アプリにおける Neon Auth の統合時の注意点に利用してください。

Neon Auth は Neon JS SDK にも組み込まれています。そのため、用途によっては Neon Auth ではなく Neon JS SDK を使用するとよい場合があります。詳しくは references/connection-methods.md を参照してください。

ブランチ

ユーザーが分離された環境、スキーマ移行のテスト、プレビュー環境へのデプロイ、またはブランチのライフサイクル自動化を計画している場合に使用します。

主なポイント：

• ブランチは即座に作成される、コピーオンライト方式のクローンです（データ全体をコピーする必要はありません）。
• 各ブランチには独自のコンピュートエンドポイントがあります。
• neonctl CLI または MCP サーバーを使用して、ブランチの作成、確認、比較を行います。

リンク：references/branching.md

オートスケーリング

ユーザーがワークロードに応じたコンピュートの自動スケーリングを必要とし、CU のサイズ設定や実行時の動作についてガイダンスを求めている場合に使用します。

リンク：https://neon.com/docs/introduction/autoscaling.md

ゼロへのスケーリング

アイドル時のコストを最適化し、コールドスタートのトレードオフを含めた一時停止／再開の動作について話し合う場合に使用します。

主なポイント：

• アイドル状態のコンピュートは自動的に一時停止します（デフォルトは 5 分で、変更可能です）（無効にしていない場合。launch & scale プランのみ）。
• 一時停止後の最初のクエリでは、通常、コールドスタートの遅延が発生します（数百ミリ秒程度）。
• コンピュートが一時停止している間も、ストレージはアクティブな状態を保ちます。

リンク：https://neon.com/docs/introduction/scale-to-zero.md

即時復元

ユーザーが特定時点への復旧を必要としている場合、または従来のバックアップ復元ワークフローを使わずにデータの状態を復元したい場合に使用します。

主なポイント：

• 復元可能な期間はプランの制限によって異なります。
• ユーザーは過去の特定時点からブランチを作成できます。
• Time Travel クエリを、過去の状態を調査するワークフローに利用できます。

リンク：https://neon.com/docs/introduction/branch-restore.md

読み取りレプリカ

ストレージを複製せずに専用の読み取り専用コンピュートを必要とする、読み取り中心のワークロードで使用します。

主なポイント：

• レプリカは、同じストレージを共有する読み取り専用のコンピュートエンドポイントです。
• 作成は迅速で、スケーリングはプライマリコンピュートから独立しています。
• 一般的な用途：分析、レポート、読み取り中心の API。

リンク：https://neon.com/docs/introduction/read-replicas.md

コネクションプーリング

ユーザーがサーバーレスまたは高並行性の環境で、安全かつスケーラブルな Postgres 接続管理を必要としている場合に使用します。

主なポイント：

• Neon のプーリングには PgBouncer が使用されています。
• プールされた接続を使用するには、エンドポイントのホスト名に -pooler を追加します。
• プーリングは、同時実行数が急増するサーバーレスランタイムで特に重要です。

リンク：https://neon.com/docs/connect/connection-pooling.md

IP 許可リスト

信頼できるネットワーク、IP、または CIDR 範囲にデータベースへのアクセスを制限する必要がある場合に使用します。

リンク：https://neon.com/docs/introduction/ip-allow.md

論理レプリケーション

CDC パイプライン、外部 Postgres との同期、またはレプリケーションによるデータ移動を統合する場合に使用します。

主なポイント：

• Neon はネイティブの論理レプリケーションワークフローをサポートしています。
• 外部 Postgres システムとの間でレプリケーションを行う際に役立ちます。

リンク：https://neon.com/docs/guides/logical-replication-guide.md