What problem does it solve?
Neon-specific setup and decision-making can be confusing because you must choose the right connection method, driver, auth flow, and tooling for your runtime while avoiding invalid assumptions. This guide resolves that by consolidating practical patterns for using Neon Serverless Postgres, including auth and the data API, with links back to the source of truth.
Core Features & Use Cases
- Connection method guidance: choose between TCP pooling, HTTP, or WebSocket based on runtime constraints and transaction needs (e.g., Cloudflare Workers vs Vercel vs traditional servers).
- Auth and session management: set up Neon Auth using the correct packages and required environment variables for server and client usage.
- Data access via SDKs and REST patterns: perform PostgREST-style queries with @neondatabase/neon-js, integrate Drizzle ORM, and manage projects/branches/endpoints via REST/SDK/CLI.
- Developer workflow tools: use neon init, the VSCode extension, and the Neon MCP server to streamline local development and AI-assisted SQL/admin workflows.
- Operational knowledge: understand Neon platform concepts (branching, autoscaling, scale-to-zero, replicas) and common constraints/rate limits for the Platform API.
Quick Start
Ask an AI to recommend the correct Neon connection approach for your deployment (for example: Cloudflare Workers) and to generate a minimal setup plan using the appropriate Neon driver and SDK based on whether you need SQL transactions.