mcpField
N
neon-postgres

neon-postgres

github.com/neondatabaseデータ・データベース107289.0k 回インストール1 日前に更新
リポジトリ

neon-postgres について

Neon経由でLakebase Postgresを扱う開発者向けのスキルです。データベースの設定、ブランチ、マイグレーション、診断に加え、Neon固有の性能分析と復旧手順を案内します。

主な機能

  1. 01プロジェクトと接続の設定案内
  2. 02ブランチとマイグレーションの手順
  3. 03読み取り専用のデータベース診断
  4. 04クエリとキャッシュの性能分析
  5. 05自動スケーリングと復旧の案内

活用シーン

  1. 01プール接続と直接接続の選択
  2. 02本番相当のブランチでマイグレーションを検証
  3. 03遅いクエリやデータベース容量の調査
  4. 04キャッシュ動作とスケールトゥゼロの検討

MCP 対応

Neon MCPサーバーとNeon CLIを使ったプロジェクト一覧、接続文字列の取得、ブランチ管理、データベース診断の方法を説明します。SQLプラン、低速クエリ一覧、読み取り専用SQLチェック用のMCPツールも扱います。

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/neondatabase/agent-skills --skill neon-postgres

インストール後、Claude Code で/neon-postgresを入力して読み込まれたか確認します。

同梱ファイル

SKILL.md と一緒にインストールされる参考資料やスクリプト。

references/
full-text-search.md
hybrid-search.md
lakebase-search-drizzle.md
vector-search.md

詳細

最初に:Neon の概要、Neon の利用開始方法、Neon 開発のベストプラクティスなどについては、親の neon スキルを使用してください。

neon スキルがインストールされていない場合は、https://neon.com/docs/ai/skills/neon/SKILL.md から取得するか、次のコマンドでインストールしてください。

neon skills -s neon -y

Lakebase Postgres

Lakebase Postgres は、Neon の中核となるデータベースです。lakebase アーキテクチャ(クラウドオブジェクトストレージ上に直接構築された OLTP)で動作し、ストレージとコンピューティングを分離することで、自動スケーリング、ブランチ作成、即時復元、スケール・トゥ・ゼロを実現します。Postgres と完全に互換性があり、Postgres をサポートするあらゆる言語、フレームワーク、ORM で使用できます。

Neon 経由でも Databricks 経由でも、使用するデータベースは同じです。このスキルでは Neon のアクセス経路について説明します。

ログイン、ユーザー、セッション、@neondatabase/auth については neon-auth を参照してください。

ライブクエリ、リアクティブ UI、リアルタイムデータについては neon-realtime を参照してください。

セットアップの流れ

1. 組織とプロジェクトを選択する

DATABASE_URL がすでに指定されている(プロンプト、環境、またはリポジトリ内)場合や、.neon ファイルがプロジェクトを参照している場合は、それを使用してください。スキーマ作業のために組織を一覧表示したり、別のプロジェクトを作成したりしないでください。

それ以外の場合は、CLI(既定)または MCP サーバーを使用して組織とプロジェクトを一覧表示します。既存のプロジェクトを選択するか、新しいプロジェクトを作成するかは、ユーザーに選んでもらってください。

2. 接続文字列を取得する

DATABASE_URL がすでに指定されている場合は、それを使用してください。CLI や MCP 経由で別の接続文字列を取得しないでください。

それ以外の場合は、CLI(既定)、neon env pull、または MCP サーバーを使用して接続文字列を取得します。.env に DATABASE_URL として保存してください。既存の値を上書きしないよう、変更前にファイルを読み込んでください。

プール接続と直接接続の使い分け
ユースケース接続タイプ
Web アプリケーション、サーバーレス関数プール(-pooler)
スキーマのマイグレーション直接
pg_dump / pg_restore直接
論理レプリケーション直接
一時テーブルを使用する長時間の分析直接
SET やセッション状態が必要な管理タスク直接
LISTEN / NOTIFY直接
3. 接続方法とドライバーを選択する

既存の ORM とドライバーを維持してください。既定の選択が決まっていない新規の TypeScript スキーマ作業では、Drizzle が候補になります:https://neon.com/docs/guides/drizzle.md。実行環境でのコードの扱われ方に基づいて適切なドライバーを選ぶには、接続方法のガイドを参照してください:https://neon.com/docs/connect/choose-connection.md。

ドライバーに関する注意事項:

  • Vercel では、Vercel Fluid compute と import { attachDatabasePool } from "@vercel/functions"; を使用して、node-postgres(npm install pg)を使ってください。
  • Cloudflare では、Cloudflare Hyperdrive と node-postgres を使用してください。
  • Neon Functions では、関数が長時間実行され、リクエスト間でプールを再利用するため、node-postgres を使用してください。
  • サーバーレス環境やエッジ環境(Netlify の使用時など)では、@neondatabase/serverless ドライバーを使用してください。1 回限りのクエリには HTTP トランスポートを、トランザクションをサポートする場合は WebSocket を使用します。リンク:https://neon.com/docs/serverless/serverless-driver.md
4. スキーマをセットアップする

スキーマとマイグレーションはコードとして管理してください。データベースに対して場当たり的にスキーマをマイグレーションするのは、管理が難しくなるため避けてください。

ORM を使用する場合は、スキーマとマイグレーションを管理するための ORM のベストプラクティスに従ってください。たとえば Drizzle を使用する場合は、別途指示がない限り、スキーマとマイグレーションの管理には Drizzle だけを使用してください。

ブランチ

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

主なポイント:

  • ブランチは瞬時に作成される、コピーオンライト方式のクローンです(データ全体はコピーされません)。
  • 各ブランチには独自のコンピュートエンドポイントがあります。
  • neon CLI または MCP サーバーを使用して、ブランチを作成、確認、比較できます。

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

詳細なブランチ作成ワークフロー(通常のブランチとスキーマのみのブランチ、親ブランチからのリセット、CLI と MCP の選択)については、neon-postgres-branches スキルを使用してください。インストールされていない場合は、https://neon.com/docs/ai/skills/neon-postgres-branches/SKILL.md から取得するか、次のコマンドでインストールしてください。

neon skills -s neon-postgres-branches -y

移行

本番環境に適用する前に、本番環境のブランチで本番環境に近いデータを使って移行をテストしてください。

移行を実行する際は、プールされた接続文字列ではなく、**直接接続の(非プール)**接続文字列を使用してください。neon connection-string はデフォルトで直接接続文字列を返します。ホスト名に -pooler というサフィックスが含まれていないことを確認してください。

トラブルシューティングと Neon 固有のパフォーマンス

カタログクエリを手動で作成する前に、Neon が事前定義している読み取り専用の診断機能を使用してください。Neon CLI の neon inspect db サブコマンドと Neon MCP サーバーの inspect_database ツールは、同じチェックを実行します。

このセクションでは、Neon 固有の診断ツール、コンピュートのキャッシュ動作、プラットフォームのシグナルについて説明します。クエリの書き換え、インデックスの選択、スキーマの変更、プランノードの解釈など、一般的な Postgres の作業が必要と判断した場合は、postgres-best-practices スキルを読み込み、診断で得られた根拠をそのワークフローに引き継いでください。

ドキュメント:

CLI と MCP の選択

ターミナルにアクセスでき、認証も利用可能な場合は、Neon CLI を優先してください。

neon inspect db <check>

CLI は現在の Neon コンテキストからプロジェクトとブランチを解決します。上書きするには、--project-id、--branch、--database-name を使用してください。ブランチ上のすべてのデータベースを確認するには、--database-name を省略します。Neon API を介して解決するのではなく、Postgres データベースを直接確認する場合に限り、--db-url を使用してください。

Neon MCP を使用する場合は、projectId と 1 つの check を指定して inspect_database を呼び出してください。必要な場合に限り、branchId、databaseName、または computeId を渡します。ブランチ上のすべてのデータベースを確認するには、databaseName を省略します。結果に切り詰められたと表示された場合に限り、limit を増やしてください。

診断項目を選ぶ
症状または質問確認項目
ストレージを消費しているリレーションはどれですか?table-sizes、index-sizes
未使用のインデックスや、頻繁にスキャンされるテーブルはありますか?unused-indexes、seq-scans
5 分以上実行されているクエリや、ロックを保持しているクエリはありますか?long-running-queries、locks
合計時間を最も消費しているクエリはどれですか?outliers
最も頻繁に実行されるクエリはどれですか?calls
アクティブなデータはコンピュートキャッシュに収まりますか?lfc-hit-rate、working-set
autovacuum が遅れている、または領域が無駄になっていますか?vacuum-stats、bloat
論理レプリケーションは正常ですか?replication-slots、subscriptions

次の確認項目を混同しないでください。

  • long-running-queries は、現在 5 分を超えて実行されているステートメントを報告します。
  • outliers は、統計情報がリセットされてからの累積実行時間に基づいて、上位のクエリを順位付けします。平均レイテンシでは順位付けしません。
  • calls は、同じ統計履歴における実行回数に基づいて順位付けします。

outliers と calls には pg_stat_statements が必要です。lfc-hit-rate と working-set には neon 拡張機能が必要です。確認項目で拡張機能がないと報告された場合、提案された CREATE EXTENSION ステートメントの実行を依頼する前に確認してください。拡張機能のインストールはデータベースを変更するためです。

安全に結果を解釈する
  • unused-indexes は削除を許可するものではなく、候補の一覧として扱ってください。削除する前に、観測期間、制約、ワークロードを確認してください。
  • シーケンシャルスキャンは、小さなテーブルやテーブルの大部分を読み取るクエリでは適切な場合があります。インデックスを追加する前に、テーブルサイズ、選択性、クエリプランを確認してください。
  • bloat は統計的な推定値です。VACUUM FULL、REINDEX、または類似の対処を行う前に、影響を確認し、ロックやメンテナンスの計画を立ててください。
  • コンピュートの再起動時には、スケールゼロの一時停止を含め、キャッシュと Postgres の統計情報がリセットされます。新しい lfc-hit-rate、working-set、vacuum-stats、または pg_stat_statements の結果を解釈する前に、代表的なワークロードを実行してください。
  • コンピュート全体を対象とする確認項目(lfc-hit-rate、working-set、replication-slots)は、すべてのデータベースを調べる場合でも 1 回だけ実行されます。
  • 1 つのデータベースで失敗すると、全データベースの検査全体が失敗することがあります。その場合は、明示的な databaseName を指定して該当する確認項目を再試行し、問題を切り分けてください。
クエリごとの Neon キャッシュ動作を調べる

標準の EXPLAIN (ANALYZE, BUFFERS) は Postgres の共有バッファーの動作を報告しますが、Neon の Local File Cache(LFC)やページのプリフェッチは表示しません。安全な読み取り専用クエリでは、Neon の FILECACHE および PREFETCH オプションを追加してください。

EXPLAIN (ANALYZE, BUFFERS, PREFETCH, FILECACHE)
SELECT ...;
  • File cache: hits は、コンピュートの LFC で見つかったページ数を示します。
  • File cache: misses は、LFC で見つからず、データベースストレージから取得されたページ数を示します。
  • Prefetch: hits、misses、expired、duplicates は、エグゼキューターが要求する前に Neon がページをどれだけ効果的に取得したかを示します。

FILECACHE と PREFETCH はこのクエリのメトリクスを提供し、neon 拡張機能は不要です。一方、neon inspect db lfc-hit-rate と working-set はコンピュート全体の統計情報を提供し、拡張機能が必要です。

MCP の explain_sql_statement ツールは標準プランを生成できますが、FILECACHE や PREFETCH のオプションは公開しません。MCP 経由でこれらの Neon 固有のメトリクスを収集するには、上記の明示的な読み取り専用 EXPLAIN ステートメントを使って run_sql を実行してください。

ANALYZE はステートメントを実行するため、実行が安全な場合にのみ使用してください。変更を伴う SQL に対して、自律的に実行しないでください。初回実行でキャッシュが読み込まれ、その後の結果が大きく変わることがあるため、コールドキャッシュとウォームキャッシュの実行を慎重に比較してください。

パフォーマンスのワークフロー
  1. 症状を再現し、発生した時間帯を記録します。
  2. 上記の表から、関連する最小限の inspect チェックを実行します。
  3. スキーマやコンピュートを変更する前に、具体的なクエリを特定します。標準的なプランには MCP の explain_sql_statement を、LFC またはプリフェッチの動作が関係する場合は、上記の Neon 固有の EXPLAIN を使用します。
  4. ボトルネックがクエリの形状、インデックス、スキーマ、ロック、またはバキュームの動作にある場合は、postgres-best-practices を読み込み、検査結果とクエリプランを引き継ぎます。Neon のコンピュート、キャッシュ、接続、プラットフォームに関する判断は、このスキルの範囲に留めます。
  5. 同じチェックとワークロードを再実行し、変更を検証します。

ユーザーがカスタムのしきい値と上限を指定して平均実行時間順にクエリを並べる必要がある場合は、inspect_database ではなく MCP の list_slow_queries を使用します。上記の明示的な EXPLAIN のケースを除き、定義済みのチェックで質問に答えられない場合に限り、読み取り専用の診断 SQL に run_sql を使用します。

自動スケーリング

ワークロードに応じてコンピュートを自動的にスケーリングしたい場合や、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

Lakebase Search

意味検索、全文検索、ハイブリッド検索には Lakebase Search を使用します。

  • Neon AI Gateway を使った埋め込みの生成を含む意味検索については、ベクトル検索をお読みください。
  • BM25 ランキングを使った全文検索については、全文検索をお読みください。
  • 融合や再ランキングによって意味検索と語彙検索の結果を組み合わせる方法については、ハイブリッド検索をお読みください。
  • 上記のいずれかを Drizzle ORM で管理する方法については、Drizzle で Lakebase Search を管理するをお読みください。

リンク:

注意点

プール接続と直接接続:マイグレーション、ダンプ、レプリケーションには直接接続の URL を使用する

Neon では、同じデータベースに対して 2 つの接続文字列が提供されます。1 つはプール接続(ホスト名に -pooler サフィックスが付くもの)、もう 1 つは直接接続/非プール接続(-pooler サフィックスが付かないもの)です。neon env pull はこれらを DATABASE_URL と DATABASE_URL_UNPOOLED として書き込みます。プール接続はトランザクションモードの PgBouncer 経由で接続するため、セッションレベルの操作はサポートされません。用途に合った方を選んでください。

  • プール接続(DATABASE_URL) — アプリケーションの通常のクエリトラフィック。特に、サーバーレスやリクエストごとに接続するワークロードに適しています。
  • 直接接続(DATABASE_URL_UNPOOLED) — スキーマのマイグレーション(Prisma Migrate、Drizzle Kit、Alembic など)、pg_dump/pg_restore、論理レプリケーション、LISTEN/NOTIFY、および SET やその他のセッション状態に依存する処理に適しています。

プール接続でマイグレーション、ダンプ、レプリケーションを実行すると失敗することがありますが、原因がプーリングだと示される形で失敗することはありません。たとえば、Prisma Migrate で prepared statement "s0" already exists が発生する、SET search_path が自身のトランザクション後に維持されず次のクエリで relation "mytable" does not exist が報告される、あるいはプールされたバックエンドが以前のクライアントから引き継いだ読み取り専用トランザクションによって、書き込みが断続的に失敗して SQLSTATE 25006 が返される、といったことがあります。通常、マイグレーションツールでは 2 つの接続文字列を同時に指定します。たとえば Prisma の directUrl と url のように指定し、DATABASE_URL を入れ替えてアプリケーションのプーリングを失わないよう、直接接続の URL を指定してください。https://neon.com/docs/connect/connection-pooling.md を参照してください。

コメント