neon-drizzle

Creates a fully functional Drizzle ORM setup with a provisioned Neon database. Installs dependencies, provisions database credentials, configures connections,…

npx skills add https://github.com/neondatabase/ai-rules --skill neon-drizzle

Neon Drizzle Integration

Comprehensive Drizzle ORM setup for Neon databases with guided workflows.

When to Use This Skill

  • Setting up Drizzle in a new project (Next.js, Vite, Express, etc.)
  • Integrating Drizzle into an existing application
  • Creating or modifying database schemas
  • Troubleshooting migration issues

Code Generation Rules

When generating TypeScript/JavaScript code:

  • BEFORE generating import statements, check tsconfig.json for path aliases (compilerOptions.paths)
  • If path aliases exist (e.g., "@/": ["./src/"]), use them (e.g., import { x } from '@/lib/utils')
  • If NO path aliases exist or unsure, ALWAYS use relative imports (e.g., import { x } from '../../../lib/utils')
  • Verify imports match the project's configuration
  • Default to relative imports - they always work regardless of configuration

Available Guides

Each guide is a complete, self-contained walkthrough with numbered phases:

  • guides/new-project.md - Full setup from scratch (see: Table of Contents)
  • guides/existing-project.md - Add Drizzle to running apps (see: Table of Contents)
  • guides/schema-only.md - Schema creation and modification (see: Table of Contents)
  • guides/troubleshooting.md - Debug common issues (organized by error type)

I'll automatically detect your context (package manager, framework, deployment target) and select the appropriate guide based on your request.

Quick Examples

Tell me what you're building - I'll handle the rest:

  • "Setup Drizzle for my Next.js blog on Vercel" → Auto-detects Vercel + Next.js → HTTP adapter
  • "Add Drizzle to my Express API" → Auto-detects Node.js server → WebSocket adapter
  • "Create a users table with auth fields" → Loads schema guide → Generates schema

Reference Documentation

For deeper technical details (loaded on-demand):

  • references/adapters.md - HTTP vs WebSocket decision guide
  • references/migrations.md - Migration patterns and troubleshooting
  • references/query-patterns.md - Example queries and best practices

Templates & Scripts

  • templates/schema-example.ts - Multi-table schema with relations
  • templates/drizzle-config.ts - Configuration examples
  • scripts/generate-schema.ts - Automated migration generation
  • scripts/run-migration.ts - Programmatic migration runner

Related Skills

  • neon-auth - Add authentication
  • neon-js - Full SDK with auth + PostgREST-style data API
  • neon-serverless - Connection setup without ORM
  • neon-toolkit - Ephemeral databases for testing
  • add-neon-docs - Add Neon best practices to your project (run after setup)

Workflow

I will:

  1. Detect your project context automatically
  2. Select and load the appropriate guide
  3. Follow the guide's phases sequentially
  4. Track progress using the guide's workflow checklist
  5. Load reference files only when needed
  6. Offer to add Neon best practices to your project docs

Ready to get started? Just describe what you're building!

More skills from neondatabase

claimable-postgres
neondatabase
Instant Postgres databases for local development, demos, prototyping, and test environments. No account required. Databases expire after 72 hours unless claimed to a Neon account.
neon
neondatabase
Overview of the Neon platform for apps and agents, spanning Postgres, Auth, Data API, and the new services: Object Storage, Compute Functions, and AI Gateway. Use whenever "Neon" is mentioned for an overview of how to work with Neon and how to get started. Otherwise, the individual capabilities are the triggers: "object storage" or "S3-compatible storage", "serverless functions", "background jobs", or "run code near my database", "AI gateway", "LLM proxy", "model routing", or "call an LLM" →...
apidatabasedevelopment
plugin-manager
neondatabase
Manage plugin structure and configuration for this repository across both Cursor and Claude Code. Use when creating, updating, or reviewing plugin folders…
skill-creator
neondatabase
Guide for creating effective skills. This skill should be used when users want to create a new skill (or update an existing skill) that extends Claude's…
using-neon
neondatabase
Guides and best practices for working with Neon Serverless Postgres. Covers getting started, local development with Neon, choosing a connection method, Neon…
neon-js-react
neondatabase
Sets up the full Neon SDK with authentication AND database queries in React apps (Vite, CRA). Creates typed client, generates database types, and configures…
postgres-best-practices
neondatabase
Best practices and guidelines for working with Postgres. Covers schema design, indexing strategies, query optimization, migrations, and common pitfalls. Use…
neon-postgres-egress-optimizer
neondatabase
Guide the user through diagnosing and fixing application-side query patterns that cause excessive data transfer (egress) from their Postgres database. Most high egress bills come from the application fetching more data than it uses.