using-neon

Neon Serverless Postgres Usage Guide

Skills Overview

using-neon provides a complete usage guide for Neon Serverless Postgres, helping developers master connection methods for serverless databases, core features, and best practices.

When to Use

Serverless and Edge Function Applications

Use the @neondatabase/serverless driver to connect to Neon via HTTP/WebSocket. It’s ideal for applications deployed on serverless platforms such as Vercel and Cloudflare Workers, especially when you need low-latency database access from edge locations.

Development Workflows That Require Database Branching

Leverage Neon’s branching feature to create instantaneous database replicas, supporting parallel development, environment isolation for testing, and CI/CD pipeline integration. Each branch can be operated independently without impacting production data.

Projects Requiring Authentication and Data API

Use @neondatabase/auth to implement secure database authentication, or use @neondatabase/neon-js to access a PostgREST-style Data API—allowing database operations without writing SQL.

Core Features

Intelligent Connection Method Selection

Provides guidance on choosing the appropriate connection method based on the runtime platform (Node.js, browser, edge functions) and application scenarios: serverless driver, standard pg driver, Drizzle ORM integration, or using the Neon JS SDK’s Data API.

Full Coverage of Neon Platform Capabilities

Covers Neon’s core features, including autoscaling, branching, instant restore, scale-to-zero, and resource management via the CLI or the Platform API.

Authentication and API Integration

Includes documentation for using the @neondatabase/auth authentication library, as well as indexes to documentation for the Neon Platform API and the TypeScript/Python SDKs, supporting automated management of Neon projects and database resources.

Common Questions

How is Neon Serverless Postgres different from traditional Postgres?

Neon is a fully Postgres-compatible serverless platform. The main difference is the architecture: Neon separates compute from storage, enabling cloud-native capabilities such as autoscaling, scale-to-zero, and database branching. You can use SQL, pg drivers, and any ORM just like with regular Postgres, while additionally gaining the elasticity of a cloud service.

How do I choose a Neon connection method?

It depends on your runtime environment: Node.js backend applications can use the standard pg driver; serverless/edge functions should use the @neondatabase/serverless driver; if you want to avoid writing SQL, you can use the Data API from @neondatabase/neon-js; and if you use Drizzle ORM, there are dedicated integration guides.

What scenarios are Neon branching features best for?

Database branching is ideal for development and testing, staging environments, and CI/CD pipelines. You can create in just a few seconds a database replica containing complete data for parallel development, testing new features, or safely running schema changes. After the branch is finished, you can delete it or merge it into production.