Neon Postgres

Neon is the backend for apps and agents. Neon Postgres, Neon Auth, and Data API are available today, with Storage, Compute, and AI Gateway coming soon. Every service is agent-ready: instant, branchable, and serverless. Neon Postgres includes autoscaling, instant restore, and scale-to-zero, and is fully compatible with any language, framework, or ORM that supports Postgres.

Neon docs are available as markdown. Append .md to any doc URL or set Accept: text/markdown. This is the primary index. Sections with many pages show key pages and link to full sub-indexes.

Common Queries

Introduction

Architecture, features, autoscaling, branching concepts, billing, and plans.

All 35 Introduction pages — key pages below
Autoscaling: An introduction to Neon's autoscaling
Branching: Branch your data the same way you branch your code
Neon Read Replicas: Scale your app, run ad-hoc queries, and provide read-only access without duplicating data
Neon's lakebase architecture: Inside Neon Postgres: decoupled compute and durable storage
Plans and billing: Learn about Neon's pricing plans and how to manage billing
Scale to Zero: Minimize costs by automatically scaling inactive databases to zero

Get Started

First-time setup: org/project creation, connection strings, driver installation, optional auth, and initial schema setup.

Build a full backend with Next.js and Neon: Connect Postgres with Drizzle, add managed authentication, and ship a typed server-side backend
Built to scale: Neon supports you from prototype to scale-up
Built to scale: Neon supports you from prototype to scale-up
Connecting Neon to your stack: Learn how to integrate Neon into your application
Database branching workflow primer: An introduction to integrating Postgres branching into your development workflow
Get started with your AI agent: Connect your AI coding assistant to Neon
Getting ready for production: Guidelines to optimize price, performance, and reliability
Neon framework guides: Find detailed instructions for connecting to Neon from various frameworks
Neon language guides: Find detailed instructions for connecting to Neon from various languages
Neon ORM guides: Find detailed instructions for connecting to Neon from various ORMs
Our DX Principles: Neon adapts to your workflow, not the other way around.
Query with Neon's SQL Editor: Query your database from the Neon Console using the Neon SQL Editor
Tour the Neon Console: Sign up and explore Neon's core features — the SQL Editor, branching, the Tables view, and Neon Auth
Why Neon?: The backend for apps and agents, by Databricks

Connect

Drivers, connection strings, pooling, local dev tooling, and troubleshooting.

Choosing your connection method: Find the right driver and connection type for your deployment platform
Connect a GUI application: Learn how to connect a GUI application to Neon
Connect from any application: Learn how to connect to Neon from any application
Connect Looker Studio to Neon: Learn how to connect your Neon Postgres database to Looker Studio
Connect to Neon: Everything you need to know about connecting to Neon
Connect to Neon securely: Learn how to connect to Neon securely when using a connection string
Connect with pgcli: Learn how to connect to Neon using the interactive pgcli client
Connect with psql: Learn how to connect to Neon using psql
Connection errors: Learn how to resolve connection errors
Connection latency and timeouts: Learn about strategies to manage connection latencies and timeouts
Connection pooling: Learn how connection pooling works in Neon
Neon serverless driver: Connect to Neon from serverless environments over HTTP or WebSockets
Passwordless auth: Learn how to connect to Neon without a password

Local Development

Neon Local: Use Docker environments to connect to Neon and manage branches automatically
Neon VS Code Extension: Connect to Neon and manage your database directly in VS Code, Cursor, and other editors

Neon CLI

Install: npm i -g neonctl. Use this for terminal-first workflows, scripts, and CI/CD automation with neonctl.

Neon CLI command: auth: Authenticate to Neon via browser or API key and manage credentials
Neon CLI command: branches: List, create, rename, and delete branches; set default; run schema diff
Neon CLI command: checkout: Pin a branch in your local .neon context file
Neon CLI command: completion: Generate shell completion scripts for neonctl commands and options
Neon CLI command: connection-string: Get Postgres connection strings for branches and databases
Neon CLI command: data-api: Provision and manage the Neon Data API from the CLI
Neon CLI command: databases: List, create, and delete databases in a Neon project
Neon CLI command: init: Initialize an app project with Neon, including auth, MCP server, extensions, and agent skills
Neon CLI command: ip-allow: Manage the IP allowlist: list, add, remove, and reset allowed IPs
Neon CLI command: link: Link a directory to a Neon project and write a .neon context file
Neon CLI command: me: View current user info, login details, and project limits
Neon CLI command: operations: List and manage long-running operations for a Neon project
Neon CLI command: orgs: List and manage Neon organizations
Neon CLI command: projects: List, create, update, delete, and get Neon projects
Neon CLI command: psql: Connect to a Neon database via psql
Neon CLI command: roles: List, create, and delete database roles in a Neon project
Neon CLI command: set-context: Set default project context for CLI sessions to avoid repeating project ID
Neon CLI command: vpc: Manage Private Networking VPC endpoints and project-level restrictions
Neon CLI overview: Overview of the Neon CLI: installation, commands, and options
Neon CLI quickstart: Get set up with the Neon CLI in just a few steps
Neon CLI: Install and connect: Install the Neon CLI and connect with web auth or API key

AI

Agent Skills, MCP integrations, vector search, and tools for building AI-powered applications with Neon.

Agent Skills: Teach your AI coding assistant how to work with Neon
AI Concepts: Learn how embeddings are used to build AI applications
AI Starter Kit: Resources for building AI applications with Neon Postgres
AI tools for Agents: AI-powered tools for development and database management
Azure Data Studio Notebooks: Use Azure Data Studio Notebooks with Neon for vector similarity search
Claude Code plugin for Neon
Codex plugin for Neon
Connect MCP clients to Neon: Learn how to connect MCP clients such as Cursor, Claude Code, VS Code, ChatGPT, and other tools to your Neon Postgres database.
Cursor plugin for Neon
Database versioning with snapshots: How AI agents and codegen platforms implement database version control using snapshots and preview branches
Google Colab: Use Google Colab with Neon for vector similarity search
Inngest: Quickly build AI RAG and Agentic workflows that scale with Inngest and Neon
LangChain: Build AI applications faster with LangChain and Postgres
LlamaIndex: Build AI applications faster with LlamaIndex and Postgres
Neon agents for GitHub Copilot: Custom agents for safe database migrations and query optimization in VS Code
Neon MCP Server overview: Learn about managing your Neon projects using natural language with Neon MCP Server
Optimize pgvector search: Fine-tune parameters for efficient and accurate similarity searches in Postgres
Scale your AI application with Neon: Scale your AI application with Neon's Autoscaling and Read Replica features
Semantic Kernel: Quickly build AI RAG and Agentic workflows with Semantic Kernel and Neon

Auth

Managed authentication built on Better Auth that branches with your database.

Auth production checklist: Required configuration before launching with Neon Auth
Auth troubleshooting: Common issues when implementing Neon Auth and how to fix them
Authentication flow: Understanding the complete sign-in and sign-up process
Branching authentication: How authentication works with Neon database branches
Neon Auth: Managed authentication that branches with your database
Neon Auth roadmap: What's supported today and what's coming next

Quick Start

Use Neon Auth with Next.js (API methods): Build your own auth UI using SDK methods
Use Neon Auth with React (API methods): Build your own auth UI
Use Neon Auth with TanStack Router: Set up authentication using pre-built UI components

Reference

Next.js Server SDK Reference: Server-side authentication API for Next.js with Neon Auth
UI Components Reference: Quick reference for Neon Auth UI components

Guides

Admin: Manage users, roles, bans, sessions, and impersonation
Configure trusted domains: Add your application domains to enable secure authentication redirects
Customize emails: Custom branding, content, and delivery for Neon Auth emails
Email OTP: Sign in and verify email addresses with one-time passwords
Email verification: Verify user email addresses during sign-up or account creation
JWT: Authenticate using JSON Web Tokens (JWT) for external services
Magic Link: Passwordless sign-in via email magic links
Manage Neon Auth via the API: Enable, configure, and disable Neon Auth using the Neon API
Open API: Interactive API documentation and client generation
Organization: Manage multi-tenant organizations, members, and invitations
Password reset: Allow users to reset forgotten passwords
Phone Number: Sign in existing users with phone OTP codes delivered via your SMS provider
Plugins: Supported Better Auth plugins in Neon Auth
Set up OAuth: Add Google, GitHub, or Vercel sign-in to your application
User management: Update profiles, change passwords, and manage account settings
Webhooks: Handle authentication events with custom server logic

Migrate

Migrate from Supabase to Neon: Switch from Supabase Auth and Database to Neon in a few steps
Migrate to Neon Auth with Better Auth: Update from the legacy Stack Auth-based implementation

Data API

PostgREST-style REST interface for your Neon database.

Access control & security: Understand how the Data API authenticates requests and enforces database permissions.
Custom authentication providers: Configure custom authentication providers with the Data API
Data API Advisors: Identify security and performance issues in your API-exposed database
Data API troubleshooting: Common issues and solutions when using the Neon Data API
Generate TypeScript types from your database schema: Automatically generate TypeScript types from your database schema for type-safe Data API interactions.
Getting started with Neon Data API: Learn how to enable and use the Neon Data API
Manage Data API: Configure schemas, manage authentication providers, and control API access.
Neon Data API: A fully managed REST interface for your Neon database
Neon Data API tutorial: Explore our demo note-taking app to learn about Data API queries with RLS
SQL to PostgREST Converter: Convert SQL queries to PostgREST API calls with real-time preview

Branching

Instant copy-on-write database environments for dev, CI, previews, and recovery.

Blog posts, docs, guides, and more: A collection of tools and resources to implement branching workflows, snapshot-based promotion, automation via APIs, and integrations with GitHub, Vercel, and agents
Branching with the Neon API: Learn how to create and delete branches with the Neon API
Branching with the Neon CLI: Learn how to create and delete branches with the Neon CLI
Build versioning / checkpoints for your agent: Learn how to use branching in your agents or platforms. Manage databases per user or app and build versioning with snapshots that keep code and database state in sync
Create one branch per PR and per developer: Build branching workflows for development: create one branch per developer, shared dev branches, or per-PR databases for safe, isolated, production-like testing
Create one branch per preview and per test run: Build branching workflows for CI and previews: spin up isolated branches per preview or test run, automate cleanup, and avoid shared test databases
Manage production and staging as branches: Learn how to manage production and staging with database branching. Treat the production branch as the source, derive staging from it, and anonymize data for PII-safe workflows
Promote from dev to prod without conflict: Build a snapshot-based promotion workflow for Postgres: replace production with a known-good dev version using database branches, snapshots, and instant restores
The building blocks: Learn how Neon projects, branches, and hierarchies work: fast copy-on-write branching, isolated compute per branch, and instant restore with snapshots
Use branches to restore instantly: Learn how to use branching for recovery: use database branches to go back in time, recover lost data, debug migrations, and audit historical states safely
Use database branches as environments: Rethink the database developer experience: database branching replaces instance copying with fast, isolated environments built on copy-on-write storage

Manage

Projects, branches, computes, roles, databases, and organization settings.

All 29 Manage pages — key pages below
Backups: An overview of backup strategies for Neon Postgres
Manage branches
Manage computes
Manage projects: Learn how to manage Neon projects from the Neon Console or the Neon API.
Organizations: Manage your projects and collaborate with team members

Guides

Step-by-step integration guides for frameworks, ORMs, auth providers, and deployment platforms.

All 169 Guides pages — key pages below
Connect a Next.js application to Neon: Set up a Neon project in seconds and connect from a Next.js application
Connect from Drizzle to Neon: Learn how to connect to Neon from Drizzle
Connect from Prisma to Neon: Learn how to connect to Neon from Prisma
Integrating Neon with Vercel: Choose the right connection path in seconds
Integrating with Neon: Choose the right integration path for your platform or application
Neon integration guides: Find detailed instructions for integration across various platforms and services.
Row-Level Security with Neon: How Neon features use Postgres Row-Level Security

Import

Migration guides by source, size, and downtime tolerance. Covers pg_dump, pgcopydb, logical replication, and provider-specific guides.

All 24 Import pages — key pages below
Import Data Assistant: Import a database under 10 GB to Neon using our automated import tool
Import data from CSV
Migrate data from Postgres with pg_dump and pg_restore
Migrate from Supabase to Neon Postgres: Learn how to migrate your database from Supabase to Neon Postgres using pg_dump and pg_restore
Neon data migration guides: Learn how to migrate data to Neon Postgres from different database providers and sources
Postgres sample data: Import sample data for learning, testing, and exploring Neon

Workflows

Automate branching, data anonymization, and database provisioning in CI/CD pipelines and GitHub Actions.

Automate branching with GitHub Actions: Create and delete branches with GitHub Actions
Claimable database integration guide: Manage Neon projects for users with the project database claim API
Data anonymization: Mask sensitive data in development branches using PostgreSQL Anonymizer
Data anonymization API reference: API endpoints for managing anonymized branches and masking rules
Data anonymization with GitHub Actions: Automate anonymized branch creation in your CI/CD pipeline

Reference

API reference, SDKs, Terraform provider, Postgres compatibility, and platform-level tooling.

Claimable Postgres by Neon: Launch an instant Neon Postgres database with zero configuration
Manage Neon with Terraform: Use Terraform to provision and manage your Neon projects, branches, endpoints, roles, databases, and other resources as code.
Metrics and logs reference: Complete reference for all metrics and log fields exported by Neon
Neon API
Neon API TypeScript SDK: Programmatically manage Neon projects, branches, databases, and other platform resources
Neon RSS feeds: Stay updated with the latest news from Neon
Neon SDKs
Neon TypeScript SDK: Reference documentation for authentication and Data API database queries
Postgres compatibility: Learn about Neon as a managed Postgres service
Python SDK (Neon API): Programmatically manage Neon projects, branches, databases, and other platform resources
The @neondatabase/toolkit: A terse client for AI agents that can spin up Postgres in seconds and run SQL queries
Neon API OpenAPI Spec: Machine-readable OpenAPI 3.0 specification for the Neon API

PostgreSQL

Postgres functions, data types, query optimization, indexing strategies, version upgrades, and general Postgres usage with Neon.

All 66 PostgreSQL pages — key pages below
Optimize Postgres query performance: Learn about strategies for optimizing Postgres query performance
Postgres indexes: Optimize query performance with indexes in Postgres
Postgres query reference: Find examples of commonly-used Postgres queries for basic to advanced operations

Security

Compliance certifications, acceptable use policies, HIPAA, and security reporting.

Acceptable Use Policy
AI use in Neon: How Neon integrates AI into its platform
Compliance
HIPAA Compliance
Security overview
Security reporting

Extensions

Postgres extensions supported by Neon, with install and usage instructions.

All 44 Extensions pages — key pages below
Postgres extensions
The pg_stat_statements extension: Track planning and execution statistics for all SQL statements
The pgcrypto extension: Secure your data with cryptographic functions in Postgres
The pgvector extension: Enable Postgres as a vector store with the pgvector extension

Community

Contributor guides, component architecture, and documentation standards.

All 9 Community pages — key pages below
Docs contribution guide: Learn how to contribute to the Neon documentation
Getting Neon docs as Markdown: How to get our documentation as plain Markdown for LLMs, tools, and scripts

Postgres

Neon Postgres: The serverless database in the Neon backend

Additional Resources

Changelog: Latest updates and releases
PostgreSQL Tutorial: Comprehensive PostgreSQL tutorial and reference
Community Guides: Step-by-step tutorials for frameworks and tools
FAQs: Frequently asked questions about Neon
Glossary