# CapyDB

> CapyDB is managed Postgres hosting: standard direct and pooled connections, disposable preview databases, backups and point-in-time restores, imports, integrations, webhooks, and an OpenAPI-documented HTTP API. No proprietary SDK or driver required.

The full documentation corpus in Markdown is available at /llms-full.txt.

## Documentation

- [Documentation](/docs): CapyDB is managed Postgres hosting. Standard direct and pooled connections, disposable previews, backups and PITR restores, imports, integrations, webhooks, and a real API. No proprietary SDK required.
- Getting Started
  - [Quickstart](/docs/getting-started/quickstart): Create a project, copy the connection string, and ship without learning a custom platform first.
  - [Connections](/docs/getting-started/connections): CapyDB speaks normal Postgres. One direct URL, one pooled URL, both usable from standard clients and frameworks.
  - [Regions](/docs/getting-started/regions): Where your database lives, how the region is chosen, and why it does not change afterwards.
  - Connect your framework
    - [Connect your framework](/docs/getting-started/connect): Keep your framework. Change the connection string.
    - [Next.js + Prisma](/docs/getting-started/connect/nextjs-prisma): Pooled URL for the app, direct URL for migrations, and Prisma handles the rest.
    - [Drizzle](/docs/getting-started/connect/drizzle): Drizzle ORM with node-postgres or postgres.js against CapyDB.
    - [Node: pg and postgres.js](/docs/getting-started/connect/node-postgres): Plain Node Postgres drivers against CapyDB, no ORM required.
    - [Django](/docs/getting-started/connect/django): Django's standard Postgres settings, pointed at CapyDB.
    - [Rails](/docs/getting-started/connect/rails): Active Record with CapyDB. database.yml stays boring.
    - [Laravel](/docs/getting-started/connect/laravel): Laravel's pgsql driver against CapyDB.
    - [Go: pgx](/docs/getting-started/connect/go-pgx): pgx and pgxpool against CapyDB.
    - [SQLAlchemy](/docs/getting-started/connect/sqlalchemy): SQLAlchemy 2.x and Alembic against CapyDB.
- Guides
  - [Preview databases](/docs/guides/previews): Disposable Postgres databases for testing, review apps, debugging, and other controlled forms of chaos.
  - [Backups and restores](/docs/guides/backups-and-restores): Backups and restore flows exist for the moments when confidence and correctness stop matching.
  - [Cutovers](/docs/guides/cutovers): Operator-assisted promotion of a preview database to production, with a verified pre-cutover backup taken first.
  - [Connection pooling](/docs/guides/connection-pooling): How the pooled endpoint actually works, what transaction pooling breaks, and which URL belongs in which slot.
  - [Credential rotation](/docs/guides/credential-rotation): What actually rotates, when the old password stops working, and which parts of your stack update themselves.
  - Imports & Migrations
    - [Imports](/docs/guides/imports): Move an existing Postgres database into CapyDB without rebuilding your app around a new platform.
    - [Migrate from Neon](/docs/guides/imports/migrate-from-neon): Move a Neon Postgres database into CapyDB.
    - [Migrate from Supabase](/docs/guides/imports/migrate-from-supabase): Move the Postgres database out of a Supabase project into CapyDB.
    - [Migrate from Railway](/docs/guides/imports/migrate-from-railway): Move a Railway Postgres database into CapyDB.
    - [Migrate from Render](/docs/guides/imports/migrate-from-render): Move a Render Postgres database into CapyDB.
    - [Migrate from Heroku Postgres](/docs/guides/imports/migrate-from-heroku): Move a Heroku Postgres database into CapyDB.
    - [Migrate from AWS RDS](/docs/guides/imports/migrate-from-aws-rds): Move an RDS (or Aurora) Postgres database into CapyDB.
    - [Migrate from Fly.io](/docs/guides/imports/migrate-from-fly): Move a Fly Postgres database into CapyDB.
  - Integrations
    - [Vercel](/docs/guides/integrations/vercel): Push connection strings into a Vercel project, keep them fresh, and get a preview database per git branch.
    - [Netlify](/docs/guides/integrations/netlify): Same shape as the Vercel integration - site ID plus personal access token, deploy hooks, branch-context env vars.
    - [Clerk auth sync](/docs/guides/integrations/clerk-auth-sync): Mirror your Clerk users into a capydb_auth.users table in your own database, so user data is one JOIN away.
    - [Auth0 auth sync](/docs/guides/integrations/auth0-sync): Mirror your Auth0 users into the capydb_auth.users table in your own database, fed by an Auth0 Log Stream or Action webhook.
    - [Better Auth sync](/docs/guides/integrations/better-auth-sync): Mirror your Better Auth users into the capydb_auth.users table in your own database, authenticated with an HMAC-SHA256 signature.
    - [GitHub Action](/docs/guides/integrations/github-action): A disposable preview database for every pull request - idempotent create, masked outputs, TTL backstop.
  - [Webhooks](/docs/guides/webhooks): Org-level outbound webhooks for lifecycle events, signed with HMAC-SHA256 and retried with backoff.
  - [Studio](/docs/guides/studio): A SQL runner and table browser in the dashboard, with deliberate guardrails.
  - [Observability](/docs/guides/observability): Live storage, connection, and query metrics per project. Enough to answer "why is it slow" without a separate APM.
  - [Alerts](/docs/guides/alerts): Usage threshold alerts on storage and connections — warning at 80%, critical at 95%, delivered to the dashboard, your webhooks, and the org billing email.
- Reference
  - [CLI](/docs/reference/cli): The capydb CLI links local apps to projects, writes env files, and runs every project operation from the terminal.
  - API
    - [API overview](/docs/reference/api): The CapyDB control plane is a plain HTTP API documented by an OpenAPI spec. Everything the dashboard and CLI do, you can do.
    - [Projects](/docs/reference/api/projects): Project (logical database) lifecycle.
    - [Connections](/docs/reference/api/connections): Connection strings and credential rotation.
    - [Previews](/docs/reference/api/previews): Disposable preview/branch databases.
    - [Backups](/docs/reference/api/backups): On-demand and scheduled backups.
    - [Restore](/docs/reference/api/restore): Backup and point-in-time restores, restore points.
    - [Imports](/docs/reference/api/imports): Importing external Postgres databases.
    - [Jobs](/docs/reference/api/jobs): Asynchronous job tracking.
    - [Webhooks](/docs/reference/api/webhooks): Outbound webhook endpoints and delivery history.
    - [A P I Keys](/docs/reference/api/api-keys): Org and project-scoped API key management.
    - [Organizations](/docs/reference/api/organizations): Organization profile and billing metadata.
    - [Studio](/docs/reference/api/studio): SQL console and table data browser/editor.
    - [Observability](/docs/reference/api/observability): Live database metrics for a project.
    - [Integrations](/docs/reference/api/integrations): Vercel and Netlify deployment integrations, auth-provider user sync (Clerk, Auth0, Better Auth), and their inbound webhooks.
    - [Audit](/docs/reference/api/audit): Project audit trail.
    - [Clusters](/docs/reference/api/clusters): Available database regions/clusters.
    - [Cutovers](/docs/reference/api/cutovers): Operator-assisted preview-to-production cutovers.
    - [Auth](/docs/reference/api/auth): Viewer identity and CLI device-login sessions.
    - [Health](/docs/reference/api/health): Service health, public status (overall and per-region), and API metadata.
  - [TypeScript SDK](/docs/reference/sdk): @capydb/sdk - fully typed client for the control plane, generated from the OpenAPI document.
  - [MCP server](/docs/reference/mcp): @capydb/mcp — let MCP-capable agents manage projects, previews, backups, extensions, and run SQL through the CapyDB API.
  - [Terraform provider](/docs/reference/terraform): The capy-base/capydb provider for Terraform and OpenTofu — projects, preview databases, API keys, and webhook endpoints as code.
  - [Limits](/docs/reference/limits): Plan entitlements and operational bounds, in one table-shaped place.
  - [Extensions](/docs/reference/extensions): The Postgres extensions available on CapyDB clusters, how to enable them per database, and why the list is an allowlist.
- Operations
  - [Security](/docs/operations/security): What is actually protecting your data, stated plainly. No badges we have not earned.
  - [Compliance](/docs/operations/compliance): What procurement can rely on today, what certifications do not exist yet, and which direction this is moving. No dates, no badges we have not earned.
  - [Disaster recovery](/docs/operations/disaster-recovery): The actual recovery layers - continuous archiving, base backups, nightly dumps - and the honest limits of a single-region product.
  - [Audit log](/docs/operations/audit-log): Every project-affecting action, who did it, and when - the actual event catalog, not an aspirational one.
  - [Troubleshooting](/docs/operations/troubleshooting): The errors you will actually see, what they mean, and the fix.
  - [FAQ](/docs/operations/faq): Short answers to the questions support actually gets.