ASD

Neon Postgres

Guías y buenas prácticas para trabajar con Lakebase Postgres, la base de datos detrás de Neon: setup, drivers, pooling, branching, migraciones, autoscaling, scale-to-zero y más.

Oficial
Estrellas
82

en todo el repo

Actividad
78

0–100, la ruta de este skill

Actualizado
hace 6 días

último commit aquí

Commits
19

últimos 90 días

Contexto
2.3k tok

164 tok en reposo

Paquete
1 archivo

9 KB

Instalar

Funciona con cualquier agente que lea SKILL.md

npx -y skills add neondatabase/agent-skills --skill neon-postgres --agent claude-code

Se instala solo en este repositorio.

Qué hace

  • Guía la conexión y configuración de Lakebase Postgres (Neon): selección de organización/proyecto, obtención del connection string y elección entre conexión pooled o directa
  • Recomienda ORM y drivers según el runtime (Drizzle, node-postgres, @neondatabase/serverless)
  • Explica branching, autoscaling, scale-to-zero, instant restore, read replicas, connection pooling, IP allow lists y logical replication
  • Advierte sobre errores típicos al usar la conexión pooled para migraciones, dumps o replicación en vez de la directa

Úsalo cuando

  • El usuario pregunta cómo configurar o conectarse a un proyecto Neon
  • Se necesita elegir entre connection string pooled y directa para migraciones, pg_dump o replicación lógica
  • Se discuten branching, autoscaling, scale-to-zero, instant restore, read replicas, connection pooling o IP allow lists
  • Se integra un ORM o driver (Drizzle, node-postgres, @neondatabase/serverless) con Neon

No lo uses cuando

    Qué lo activa

    Di cualquiera de estas frases y el agente debería cargar este skill.

    • ¿Cómo conecto mi app a Neon con DATABASE_URL?
    • Necesito hacer una migración de esquema en mi base Neon, ¿qué connection string uso?
    • Explícame cómo funciona el scale-to-zero en Neon
    • ¿Cómo creo una branch de mi base de datos para probar una migración?

    SKILL.md

    En inglés

    FIRST: Use the parent neon skill for a Neon overview, getting started with Neon, Neon development best practices, and more.

    If the neon skill is not installed, fetch it from https://neon.com/docs/ai/skills/neon/SKILL.md or install it with:

    npx skills add neondatabase/agent-skills --skill neon
    

    Lakebase Postgres

    Lakebase Postgres is the database at the core of Neon. It runs on the lakebase architecture — OLTP built directly on cloud object storage — which decouples storage from compute to offer autoscaling, branching, instant restore, and scale-to-zero. It's fully compatible with Postgres and works with any language, framework, or ORM that supports Postgres.

    It is the same database whether you reach it through Neon or through Databricks; this skill covers the Neon access path.

    Setup Flow

    1. Select the organization and project

    Use the CLI (default) or MCP server to list organizations and projects. Let the user select an existing project or create a new one. Check the .neon file for an existing linked project or branch.

    2. Get the connection string

    Use the CLI (default), neon env pull, or the MCP server to get the connection string. Store it in .env as DATABASE_URL. Read the file first before modifying it, to avoid overwriting existing values.

    When to use pooled vs direct connections

    Use case Connection type
    Web applications, serverless functions Pooled (-pooler)
    Schema migrations Direct
    pg_dump / pg_restore Direct
    Logical replication Direct
    Long-running analytics with temp tables Direct
    Admin tasks needing SET or session state Direct
    LISTEN / NOTIFY Direct

    3. Pick the connection method and driver

    Always pair Neon with an ORM such as Drizzle for easy schema management and migrations. Refer to the connection methods guide to pick the correct driver based on how the runtime treats your code: https://neon.com/docs/connect/choose-connection.md.

    Recommendations:

    • Drizzle as ORM (see https://neon.com/docs/guides/drizzle.md)
    • On Vercel, use node-postgres (npm install pg) with Vercel Fluid compute and import { attachDatabasePool } from "@vercel/functions";
    • On Cloudflare, use node-postgres with Cloudflare Hyperdrive
    • On Neon Functions, use node-postgres, as the functions are long-running and reuse the pool across requests.
    • Use the @neondatabase/serverless driver for serverless and edge environments (for example, when using Netlify) — HTTP transport for one-shot queries, WebSocket for transaction support. Link: https://neon.com/docs/serverless/serverless-driver.md

    4. Set up the schema

    Manage schemas and migrations as code. Avoid running ad hoc schema migrations against your database, since they're hard to manage.

    If you're using an ORM, follow your ORM's best practices to manage schemas and migrations. For example, if using Drizzle, only use Drizzle for schema and migration management unless instructed otherwise.

    Branching

    Use this when the user is planning isolated environments, schema migration testing, preview deployments, or branch lifecycle automation.

    Key points:

    • Branches are instant, copy-on-write clones (no full data copy).
    • Each branch has its own compute endpoint.
    • Use the neon CLI or MCP server to create, inspect, and compare branches.

    Link: https://neon.com/docs/introduction/branching.md

    For detailed branch creation workflows (normal vs schema-only branches, reset-from-parent, CLI/MCP selection), use the neon-postgres-branches skill. If it isn't installed, fetch it from https://neon.com/docs/ai/skills/neon-postgres-branches/SKILL.md or install it with:

    npx skills add neondatabase/agent-skills --skill neon-postgres-branches
    

    Migrations

    Test a migration on a branch of production, against production-like data, before applying it to production.

    Use a direct (non-pooled) connection string when you run the migration, not a pooled one. neon connection-string returns the direct string by default; make sure the hostname does not include the -pooler suffix.

    Autoscaling

    Use this when the user needs compute to scale automatically with workload and wants guidance on CU sizing and runtime behavior.

    Link: https://neon.com/docs/introduction/autoscaling.md

    Scale to Zero

    Use this when optimizing idle costs and discussing suspend/resume behavior, including cold-start trade-offs.

    Key points:

    • Idle computes suspend automatically after a default of 5 minutes; the timeout is configurable, and suspension can only be disabled on the Launch and Scale plans.
    • First query after suspend typically has a cold-start penalty (around hundreds of ms)
    • Storage remains active while compute is suspended.

    Link: https://neon.com/docs/introduction/scale-to-zero.md

    Instant Restore

    Use this when the user needs point-in-time recovery or wants to restore data state without traditional backup restore workflows.

    Key points:

    • History windows for instant restore depend on plan limits.
    • Users can create branches from historical points-in-time.
    • Time Travel queries can be used for historical inspection workflows.

    Link: https://neon.com/docs/introduction/branch-restore.md

    Read Replicas

    Use this for read-heavy workloads where the user needs dedicated read-only compute without duplicating storage.

    Key points:

    • Replicas are read-only compute endpoints sharing the same storage.
    • Creation is fast and scaling is independent from primary compute.
    • Typical use cases: analytics, reporting, and read-heavy APIs.

    Link: https://neon.com/docs/introduction/read-replicas.md

    Connection Pooling

    Use this when the user is in serverless or high-concurrency environments and needs safe, scalable Postgres connection management.

    Key points:

    • Neon pooling uses PgBouncer.
    • Add -pooler to endpoint hostnames to use pooled connections.
    • Pooling is especially important in serverless runtimes with bursty concurrency.

    Link: https://neon.com/docs/connect/connection-pooling.md

    IP Allow Lists

    Use this when the user needs to restrict database access by trusted networks, IPs, or CIDR ranges.

    Link: https://neon.com/docs/introduction/ip-allow.md

    Logical Replication

    Use this when integrating CDC pipelines, external Postgres sync, or replication-based data movement.

    Key points:

    • Neon supports native logical replication workflows.
    • Useful for replicating to/from external Postgres systems.

    Link: https://neon.com/docs/guides/logical-replication-guide.md

    Gotchas

    Pooled vs direct connections: use the direct URL for migrations, dumps, and replication

    Neon gives you two connection strings for the same database: a pooled one (hostname with the -pooler suffix) and a direct/unpooled one (no -pooler suffix). neon env pull writes them as DATABASE_URL and DATABASE_URL_UNPOOLED. The pooled connection routes through PgBouncer in transaction mode, which doesn't support session-level operations. Choose the right one:

    • Pooled (DATABASE_URL) — your application's normal query traffic, especially serverless and connection-per-request workloads.
    • Direct (DATABASE_URL_UNPOOLED) — schema migrations (Prisma Migrate, Drizzle Kit, Alembic, and others), pg_dump / pg_restore, logical replication, LISTEN/NOTIFY, and anything relying on SET or other session state.

    Running migrations, dumps, or replication over the pooled connection can fail, and never in a way that names pooling: prepared statement "s0" already exists from Prisma Migrate, a SET search_path that doesn't persist past its own transaction so the next query reports relation "mytable" does not exist, or a write intermittently hitting a read-only transaction (SQLSTATE 25006) that a pooled backend inherited from an earlier client. Migration tools generally take both strings at once — Prisma's directUrl alongside url — so point that at the direct one rather than swapping DATABASE_URL and losing pooling for the application. See https://neon.com/docs/connect/connection-pooling.md.

    Reproducido de neondatabase/agent-skills bajo licencia Apache-2.0. Leer esta página en markdown.

    Archivos

    1 archivo en el paquete. Solo se lee SKILL.md al activarse — las referencias se cargan si el skill decide que las necesita.

    Antes de instalar

    Requiere tener instalado o consultado el skill padre `neon`, y para branching detallado el skill `neon-postgres-branches`.

    Necesita en el PATH:npx

    Detalles

    Categoría
    Bases de datos
    Licencia
    Apache-2.0
    Recursos incluidos
    Solo SKILL.md
    Código fuente
    Ver SKILL.md

    Más de neondatabase/agent-skills

    Este repo incluye 9 skills. Si instalas uno, normalmente ya tienes los demás.

    Funciones HTTP de Node.js long-running y serverless desplegadas en tu rama de Neon, con DATABASE_URL inyectado automáticamente y compute que corre junto a tus datos.

    Costo de contexto al activarse
    9.6k tok
    Tamaño del paquete
    6 archivos
    Última actualización
    hace 4 días
    Oficialdevops infraestructura

    Visión general de Neon: primitivas de backend en la nube (Lakebase Postgres, Auth, Data API, Object Storage, Functions, AI Gateway), CLI/MCP y flujo branch-first.

    Costo de contexto al activarse
    7.1k tok
    Tamaño del paquete
    1 archivo
    Última actualización
    hace 4 días
    Oficialbases de datos

    Una sola API y una sola credencial para modelos LLM frontera y de código abierto, integrada en tu rama de Neon y con tecnología de Databricks.

    Costo de contexto al activarse
    5k tok
    Tamaño del paquete
    1 archivo
    Última actualización
    hace 8 días
    Oficialdesarrollo apis

    Almacenamiento de objetos compatible con S3 que se ramifica junto a tu proyecto Neon, para que archivos y base de datos se mantengan sincronizados en cada branch.

    Costo de contexto al activarse
    3.1k tok
    Tamaño del paquete
    1 archivo
    Última actualización
    hace 4 días
    Oficialbases de datos

    Elige y crea el tipo correcto de branch de Neon para testing y desarrollo: pruebas con datos reales, entornos aislados, branches schema-only, reset y lifecycles de CI/CD.

    Costo de contexto al activarse
    3.4k tok
    Tamaño del paquete
    1 archivo
    Última actualización
    hace 14 días
    Oficialbases de datos

    Diagnostica y corrige el egress excesivo de Postgres (transferencia de datos por red) en un código, cuando suben las facturas o hay picos de transferencia.

    Costo de contexto al activarse
    2.5k tok
    Tamaño del paquete
    1 archivo
    Última actualización
    hace 14 días
    Oficialbases de datos

    Skills relacionados

    Domina la optimización de consultas SQL, estrategias de indexado y análisis EXPLAIN para mejorar drásticamente el rendimiento de la base de datos y eliminar consultas lentas.

    Costo de contexto al activarse
    1.5k tok
    Tamaño del paquete
    2 archivos
    Última actualización
    hace 2 meses
    bases de datos

    Ejecuta migraciones de bases de datos entre ORMs y plataformas con estrategias zero-downtime, transformación de datos y procedimientos de rollback.

    Costo de contexto al activarse
    2k tok
    Tamaño del paquete
    2 archivos
    Última actualización
    hace 2 meses
    bases de datos

    Diseña e implementa event stores para sistemas de event sourcing: infraestructura, elección de tecnología y patrones de persistencia de eventos.

    Costo de contexto al activarse
    1k tok
    Tamaño del paquete
    2 archivos
    Última actualización
    hace 2 meses
    bases de datos