neon
Assists with building applications using Neon serverless PostgreSQL. Use when setting up serverless databases, creating branches for development workflows, integrating with edge runtimes, or configuring Prisma/Drizzle with Neon. Trigger words: neon, serverless postgres, database branching, neon serverless driver, pgvector, neon database.
Usage
Getting Started
- Install the skill using the command above
- Open your AI coding agent (Claude Code, Codex, Gemini CLI, or Cursor)
- Reference the skill in your prompt
- The AI will use the skill's capabilities automatically
Example Prompts
- "Analyze the sales data in revenue.csv and identify trends"
- "Create a visualization comparing Q1 vs Q2 performance metrics"
Documentation
Overview
Neon provides serverless PostgreSQL with scale-to-zero compute, database branching, and an HTTP-based driver for edge runtimes. It offers full PostgreSQL compatibility including extensions like pgvector, with features like copy-on-write branching for development workflows and automatic preview deployment databases.
Instructions
- When setting up connections, use the pooled connection string (
-poolersuffix) for serverless functions and the direct connection string for long-running Node.js servers. - When creating development workflows, use database branching (
neon branches create) to give each feature or PR its own isolated database that inherits schema from the parent branch. - When deploying to edge runtimes (Cloudflare Workers, Vercel Edge), use
@neondatabase/serverlesswhich communicates over HTTP instead of TCP sockets. - When integrating with ORMs, use
@prisma/adapter-neonfor Prisma ordrizzle-orm/neon-serverlessfor Drizzle, and reserve raw SQL for complex queries and migrations. - When enabling AI features, install the
pgvectorextension at project creation for vector embeddings and ANN search. - When configuring scaling, set
autosuspend_delayto 300s for development and 0 (never suspend) for production, and configure compute autoscaling between 0.25 and 8 CU. - When running migrations, apply them on the main branch so feature branches inherit schema changes automatically.
Examples
Example 1: Set up Neon with Drizzle ORM for a Next.js app
User request: "Connect my Next.js project to Neon using Drizzle ORM"
Actions:
- Create a Neon project and obtain the pooled connection string
- Install
@neondatabase/serverlessanddrizzle-orm - Configure Drizzle with the Neon serverless adapter
- Define schema and run initial migration on the main branch
Output: A type-safe database layer using Drizzle with Neon that works in both server components and edge functions.
Example 2: Set up branch-per-PR workflow
User request: "Automatically create a database branch for each pull request"
Actions:
- Configure Neon-Vercel integration for automatic branch creation
- Set up CI script using
neonctl branches create --name pr-$PR_NUMBER - Pass branch connection string as environment variable to preview deployment
- Add cleanup step to delete branch when PR is closed
Output: An isolated database branch for each PR with automatic lifecycle management.
Guidelines
- Always use the pooled connection string (
-poolersuffix) for serverless functions to avoid exhausting connection limits. - Use
@neondatabase/serverlessfor edge runtimes; use standardpgfor long-running Node.js servers. - Create database branches for each feature or PR; never develop against the main branch.
- Enable
pgvectorextension at project creation if vector search will be needed. - Set
autosuspend_delayto 300s for dev and 0 for production. - Use Drizzle or Prisma with the Neon adapter; use raw SQL only for complex queries and migrations.
- Run migrations on the main branch; feature branches inherit schema automatically.
Information
- Version
- 1.0.0
- Author
- terminal-skills
- Category
- Data & AI
- License
- Apache-2.0