# PgBeam Documentation

> Globally distributed PostgreSQL proxy with connection pooling, query caching, and low-latency queries across 6 regions.

## Pages

- [API Keys](https://pgbeam.com/docs/api-keys): Create, rotate, and revoke PgBeam API keys for programmatic access.
- [AWS Marketplace](https://pgbeam.com/docs/aws-marketplace): Subscribe to PgBeam through the AWS Marketplace — provision connection pooling and query caching with consolidated AWS billing.
- [Caching](https://pgbeam.com/docs/cache): How PgBeam caches query results at the edge, when it bypasses cache, and how to turn it on safely for your workload.
- [Crossplane](https://pgbeam.com/docs/crossplane): Manage PgBeam projects, databases, replicas, domains, and cache rules as Kubernetes custom resources using the Crossplane provider.
- [Custom Domains](https://pgbeam.com/docs/custom-domains): Use your own domain for PgBeam connection strings with automatic TLS certificate provisioning and renewal. Scale plan only.
- [Drizzle](https://pgbeam.com/docs/drizzle): Connect Drizzle ORM to your PostgreSQL database through PgBeam for connection pooling, caching, and global routing.
- [Error Codes](https://pgbeam.com/docs/error-codes): SQLSTATE error codes returned by PgBeam, what causes them, and how to resolve each one.
- [Getting Started](https://pgbeam.com/docs): Connect an existing PostgreSQL app to PgBeam without changing your driver or ORM.
- [JDBC](https://pgbeam.com/docs/jdbc): Connect Java applications to PgBeam using JDBC, HikariCP, and Spring Boot for connection pooling, caching, and global routing.
- [Organizations](https://pgbeam.com/docs/organizations): Manage teams, invite members, assign roles, and control access across projects.
- [pgx](https://pgbeam.com/docs/pgx): Connect Go applications using pgx to PgBeam for connection pooling, caching, and global routing.
- [Plans and Limits](https://pgbeam.com/docs/plans): Plan tiers, feature comparison, per-plan quotas, overage billing, rate limits, and default settings.
- [Connection Pooling](https://pgbeam.com/docs/pooling): How PgBeam pools upstream PostgreSQL connections per project, keyed by user credentials — and how to choose the right pool mode for your workload.
- [Prisma](https://pgbeam.com/docs/prisma): Connect Prisma to your PostgreSQL database through PgBeam for connection pooling, caching, and global routing.
- [psycopg](https://pgbeam.com/docs/psycopg): Connect Python applications using psycopg to PgBeam for connection pooling, caching, and global routing. Includes SQLAlchemy integration.
- [Pulumi](https://pgbeam.com/docs/pulumi): Manage PgBeam projects, databases, replicas, domains, and cache rules as infrastructure using Pulumi and the @pgbeam/pulumi package.
- [Read Replicas](https://pgbeam.com/docs/replicas): Distribute read load across PostgreSQL replicas with per-query SQL annotations and automatic health management.
- [Resilience](https://pgbeam.com/docs/resilience): How PgBeam keeps database connections reliable with circuit breakers, scale-to-zero, health checks, fail-open caching, and upstream TLS.
- [Routing & Regions](https://pgbeam.com/docs/routing): How PgBeam routes connections across 6 global regions using GeoDNS, peer relay, and edge caching — and what happens when things fail.
- [Serverless Driver](https://pgbeam.com/docs/serverless): Use @neondatabase/serverless to connect from edge runtimes and serverless functions through PgBeam with HTTP or WebSocket transports.
- [SSO (SAML / OIDC)](https://pgbeam.com/docs/sso): Configure Single Sign-On for your organization using SAML 2.0 or OpenID Connect. Scale plan only.
- [Terraform](https://pgbeam.com/docs/terraform): Manage PgBeam projects, databases, replicas, domains, and cache rules as infrastructure using Terraform and the pgbeam provider.
- [Troubleshooting](https://pgbeam.com/docs/troubleshooting): Common PgBeam failures, what they usually mean, and step-by-step instructions to diagnose and fix them.
- [Vercel Marketplace](https://pgbeam.com/docs/vercel-marketplace): Deploy PgBeam as a Vercel Marketplace integration — provision connection pooling and query caching directly from your Vercel dashboard.
- [Usage](https://pgbeam.com/docs/api): Control-plane API for projects, databases, analytics, onboarding, and platform state.
- [Response Conventions](https://pgbeam.com/docs/api/response-conventions): Status codes, error envelope, retries, and idempotency across the PgBeam API.
- [Global Options](https://pgbeam.com/docs/cli/global-options): Flags and environment variables available on every PgBeam CLI command.
- [Installation](https://pgbeam.com/docs/cli): Install the PgBeam CLI on macOS or Linux.
- [mcp](https://pgbeam.com/docs/cli/mcp): Start the MCP server for AI agent integration.
- [update](https://pgbeam.com/docs/cli/update): Check for and install CLI updates.
- [Error Handling](https://pgbeam.com/docs/go-sdk/error-handling): Catch and inspect API errors, configure retries, and use idempotency keys in the PgBeam Go SDK.
- [Installation & Setup](https://pgbeam.com/docs/go-sdk): Install the pgbeam-go package, configure the client, authenticate, and learn the service-based access pattern.
- [Error Handling](https://pgbeam.com/docs/ts-sdk/error-handling): Catch and inspect API errors, configure retries, and use idempotency keys in the PgBeam TypeScript SDK.
- [Installation & Setup](https://pgbeam.com/docs/ts-sdk): Install the PgBeam SDK, configure the client, authenticate, and learn the two access patterns.
- [Export account data](https://pgbeam.com/docs/api/account/exportAccountData): 
- [Get onboarding progress](https://pgbeam.com/docs/api/account/getOnboardingProgress): 
- [Update onboarding progress](https://pgbeam.com/docs/api/account/updateOnboardingProgress): 
- [Get organization plan](https://pgbeam.com/docs/api/analytics/getOrganizationPlan): 
- [Get organization usage](https://pgbeam.com/docs/api/analytics/getOrganizationUsage): 
- [Get query insights for a project](https://pgbeam.com/docs/api/analytics/getProjectInsights): 
- [Get project usage](https://pgbeam.com/docs/api/analytics/getProjectUsage): 
- [List available plans](https://pgbeam.com/docs/api/analytics/listPlans): 
- [Submit cancellation feedback](https://pgbeam.com/docs/api/analytics/submitCancellationFeedback): 
- [Update spend limit](https://pgbeam.com/docs/api/analytics/updateSpendLimit): 
- [Add a database](https://pgbeam.com/docs/api/databases/createDatabase): 
- [Delete a database](https://pgbeam.com/docs/api/databases/deleteDatabase): 
- [Get a database](https://pgbeam.com/docs/api/databases/getDatabase): 
- [List databases](https://pgbeam.com/docs/api/databases/listDatabases): 
- [Test database connection](https://pgbeam.com/docs/api/databases/testDatabaseConnection): 
- [Update a database](https://pgbeam.com/docs/api/databases/updateDatabase): 
- [Health check](https://pgbeam.com/docs/api/platform/getHealth): 
- [List available regions](https://pgbeam.com/docs/api/platform/listRegions): 
- [Add a custom domain](https://pgbeam.com/docs/api/projects/createCustomDomain): 
- [Create a project](https://pgbeam.com/docs/api/projects/createProject): 
- [Add a replica](https://pgbeam.com/docs/api/projects/createReplica): 
- [Delete a custom domain](https://pgbeam.com/docs/api/projects/deleteCustomDomain): 
- [Delete a project](https://pgbeam.com/docs/api/projects/deleteProject): 
- [Delete a replica](https://pgbeam.com/docs/api/projects/deleteReplica): 
- [Get a project](https://pgbeam.com/docs/api/projects/getProject): 
- [Get project metrics](https://pgbeam.com/docs/api/projects/getProjectMetrics): 
- [List cache rules](https://pgbeam.com/docs/api/projects/listCacheRules): 
- [List custom domains](https://pgbeam.com/docs/api/projects/listCustomDomains): 
- [List projects](https://pgbeam.com/docs/api/projects/listProjects): 
- [List replicas](https://pgbeam.com/docs/api/projects/listReplicas): 
- [Update cache rule](https://pgbeam.com/docs/api/projects/updateCacheRule): 
- [Update a project](https://pgbeam.com/docs/api/projects/updateProject): 
- [Verify custom domain DNS](https://pgbeam.com/docs/api/projects/verifyCustomDomain): 
- [account export](https://pgbeam.com/docs/cli/account/export): Export your account data.
- [insights](https://pgbeam.com/docs/cli/analytics/insights): Show query insights.
- [metrics](https://pgbeam.com/docs/cli/analytics/metrics): Show project metrics.
- [plans](https://pgbeam.com/docs/cli/analytics/plans): List available subscription plans.
- [api ls](https://pgbeam.com/docs/cli/api/ls): List all available API endpoints.
- [api request](https://pgbeam.com/docs/cli/api/request): Make a direct API request.
- [api schema](https://pgbeam.com/docs/cli/api/schema): Show the OpenAPI schema for a specific operation.
- [auth list](https://pgbeam.com/docs/cli/auth/list): List all saved authentication profiles.
- [auth login](https://pgbeam.com/docs/cli/auth/login): Authenticate with PgBeam via API key or browser-based OAuth.
- [auth logout](https://pgbeam.com/docs/cli/auth/logout): Remove an authentication profile.
- [auth status](https://pgbeam.com/docs/cli/auth/status): Show current authentication status.
- [auth switch](https://pgbeam.com/docs/cli/auth/switch): Switch the active authentication profile.
- [whoami](https://pgbeam.com/docs/cli/auth/whoami): Show current user and organization info.
- [db add](https://pgbeam.com/docs/cli/db/add): Add a database connection to the project.
- [db delete](https://pgbeam.com/docs/cli/db/delete): Delete a database connection.
- [db inspect](https://pgbeam.com/docs/cli/db/inspect): Show detailed database info including connection settings, pool config, and cache settings.
- [db list](https://pgbeam.com/docs/cli/db/list): List all databases in the linked project.
- [db test](https://pgbeam.com/docs/cli/db/test): Test the database connection.
- [db update](https://pgbeam.com/docs/cli/db/update): Update database configuration.
- [orgs activity](https://pgbeam.com/docs/cli/orgs/activity): Show organization activity feed.
- [orgs list](https://pgbeam.com/docs/cli/orgs/list): List organizations you belong to.
- [orgs plan](https://pgbeam.com/docs/cli/orgs/plan): Show current plan details and limits.
- [orgs switch](https://pgbeam.com/docs/cli/orgs/switch): Switch active organization.
- [orgs usage](https://pgbeam.com/docs/cli/orgs/usage): Show organization usage metrics.
- [health](https://pgbeam.com/docs/cli/platform/health): Check API health status.
- [regions](https://pgbeam.com/docs/cli/platform/regions): List available data plane regions.
- [projects create](https://pgbeam.com/docs/cli/projects/create): Create a new project.
- [projects delete](https://pgbeam.com/docs/cli/projects/delete): Delete a project.
- [projects inspect](https://pgbeam.com/docs/cli/projects/inspect): Show detailed project information.
- [projects link](https://pgbeam.com/docs/cli/projects/link): Link the current directory to a project.
- [projects list](https://pgbeam.com/docs/cli/projects/list): List all projects in your organization.
- [projects unlink](https://pgbeam.com/docs/cli/projects/unlink): Remove the project link from the current directory.
- [projects update](https://pgbeam.com/docs/cli/projects/update): Update project configuration.
- [projects usage](https://pgbeam.com/docs/cli/projects/usage): Show project usage metrics.
- [ExportAccountData](https://pgbeam.com/docs/go-sdk/account/exportAccountData): Export account data
- [GetOnboardingProgress](https://pgbeam.com/docs/go-sdk/account/getOnboardingProgress): Get onboarding progress
- [UpdateOnboardingProgress](https://pgbeam.com/docs/go-sdk/account/updateOnboardingProgress): Update onboarding progress
- [GetOrganizationPlan](https://pgbeam.com/docs/go-sdk/analytics/getOrganizationPlan): Get organization plan
- [GetOrganizationUsage](https://pgbeam.com/docs/go-sdk/analytics/getOrganizationUsage): Get organization usage
- [GetProjectInsights](https://pgbeam.com/docs/go-sdk/analytics/getProjectInsights): Get query insights for a project
- [GetProjectUsage](https://pgbeam.com/docs/go-sdk/analytics/getProjectUsage): Get project usage
- [ListPlans](https://pgbeam.com/docs/go-sdk/analytics/listPlans): List available plans
- [SubmitCancellationFeedback](https://pgbeam.com/docs/go-sdk/analytics/submitCancellationFeedback): Submit cancellation feedback
- [UpdateSpendLimit](https://pgbeam.com/docs/go-sdk/analytics/updateSpendLimit): Update spend limit
- [CreateDatabase](https://pgbeam.com/docs/go-sdk/databases/createDatabase): Add a database
- [DeleteDatabase](https://pgbeam.com/docs/go-sdk/databases/deleteDatabase): Delete a database
- [GetDatabase](https://pgbeam.com/docs/go-sdk/databases/getDatabase): Get a database
- [ListDatabases](https://pgbeam.com/docs/go-sdk/databases/listDatabases): List databases
- [TestDatabaseConnection](https://pgbeam.com/docs/go-sdk/databases/testDatabaseConnection): Test database connection
- [UpdateDatabase](https://pgbeam.com/docs/go-sdk/databases/updateDatabase): Update a database
- [GetHealth](https://pgbeam.com/docs/go-sdk/platform/getHealth): Health check
- [ListRegions](https://pgbeam.com/docs/go-sdk/platform/listRegions): List available regions
- [CreateCustomDomain](https://pgbeam.com/docs/go-sdk/projects/createCustomDomain): Add a custom domain
- [CreateProject](https://pgbeam.com/docs/go-sdk/projects/createProject): Create a project
- [CreateReplica](https://pgbeam.com/docs/go-sdk/projects/createReplica): Add a replica
- [DeleteCustomDomain](https://pgbeam.com/docs/go-sdk/projects/deleteCustomDomain): Delete a custom domain
- [DeleteProject](https://pgbeam.com/docs/go-sdk/projects/deleteProject): Delete a project
- [DeleteReplica](https://pgbeam.com/docs/go-sdk/projects/deleteReplica): Delete a replica
- [GetProject](https://pgbeam.com/docs/go-sdk/projects/getProject): Get a project
- [GetProjectMetrics](https://pgbeam.com/docs/go-sdk/projects/getProjectMetrics): Get project metrics
- [ListCacheRules](https://pgbeam.com/docs/go-sdk/projects/listCacheRules): List cache rules
- [ListCustomDomains](https://pgbeam.com/docs/go-sdk/projects/listCustomDomains): List custom domains
- [ListProjects](https://pgbeam.com/docs/go-sdk/projects/listProjects): List projects
- [ListReplicas](https://pgbeam.com/docs/go-sdk/projects/listReplicas): List replicas
- [UpdateCacheRule](https://pgbeam.com/docs/go-sdk/projects/updateCacheRule): Update cache rule
- [UpdateProject](https://pgbeam.com/docs/go-sdk/projects/updateProject): Update a project
- [VerifyCustomDomain](https://pgbeam.com/docs/go-sdk/projects/verifyCustomDomain): Verify custom domain DNS
- [exportAccountData](https://pgbeam.com/docs/ts-sdk/account/exportAccountData): Export account data
- [getOnboardingProgress](https://pgbeam.com/docs/ts-sdk/account/getOnboardingProgress): Get onboarding progress
- [updateOnboardingProgress](https://pgbeam.com/docs/ts-sdk/account/updateOnboardingProgress): Update onboarding progress
- [getOrganizationPlan](https://pgbeam.com/docs/ts-sdk/analytics/getOrganizationPlan): Get organization plan
- [getOrganizationUsage](https://pgbeam.com/docs/ts-sdk/analytics/getOrganizationUsage): Get organization usage
- [getProjectInsights](https://pgbeam.com/docs/ts-sdk/analytics/getProjectInsights): Get query insights for a project
- [getProjectUsage](https://pgbeam.com/docs/ts-sdk/analytics/getProjectUsage): Get project usage
- [listPlans](https://pgbeam.com/docs/ts-sdk/analytics/listPlans): List available plans
- [submitCancellationFeedback](https://pgbeam.com/docs/ts-sdk/analytics/submitCancellationFeedback): Submit cancellation feedback
- [updateSpendLimit](https://pgbeam.com/docs/ts-sdk/analytics/updateSpendLimit): Update spend limit
- [createDatabase](https://pgbeam.com/docs/ts-sdk/databases/createDatabase): Add a database
- [deleteDatabase](https://pgbeam.com/docs/ts-sdk/databases/deleteDatabase): Delete a database
- [getDatabase](https://pgbeam.com/docs/ts-sdk/databases/getDatabase): Get a database
- [listDatabases](https://pgbeam.com/docs/ts-sdk/databases/listDatabases): List databases
- [testDatabaseConnection](https://pgbeam.com/docs/ts-sdk/databases/testDatabaseConnection): Test database connection
- [updateDatabase](https://pgbeam.com/docs/ts-sdk/databases/updateDatabase): Update a database
- [getHealth](https://pgbeam.com/docs/ts-sdk/platform/getHealth): Health check
- [listRegions](https://pgbeam.com/docs/ts-sdk/platform/listRegions): List available regions
- [createCustomDomain](https://pgbeam.com/docs/ts-sdk/projects/createCustomDomain): Add a custom domain
- [createProject](https://pgbeam.com/docs/ts-sdk/projects/createProject): Create a project
- [createReplica](https://pgbeam.com/docs/ts-sdk/projects/createReplica): Add a replica
- [deleteCustomDomain](https://pgbeam.com/docs/ts-sdk/projects/deleteCustomDomain): Delete a custom domain
- [deleteProject](https://pgbeam.com/docs/ts-sdk/projects/deleteProject): Delete a project
- [deleteReplica](https://pgbeam.com/docs/ts-sdk/projects/deleteReplica): Delete a replica
- [getProject](https://pgbeam.com/docs/ts-sdk/projects/getProject): Get a project
- [getProjectMetrics](https://pgbeam.com/docs/ts-sdk/projects/getProjectMetrics): Get project metrics
- [listCacheRules](https://pgbeam.com/docs/ts-sdk/projects/listCacheRules): List cache rules
- [listCustomDomains](https://pgbeam.com/docs/ts-sdk/projects/listCustomDomains): List custom domains
- [listProjects](https://pgbeam.com/docs/ts-sdk/projects/listProjects): List projects
- [listReplicas](https://pgbeam.com/docs/ts-sdk/projects/listReplicas): List replicas
- [updateCacheRule](https://pgbeam.com/docs/ts-sdk/projects/updateCacheRule): Update cache rule
- [updateProject](https://pgbeam.com/docs/ts-sdk/projects/updateProject): Update a project
- [verifyCustomDomain](https://pgbeam.com/docs/ts-sdk/projects/verifyCustomDomain): Verify custom domain DNS
- [cache-rules list](https://pgbeam.com/docs/cli/projects/cache-rules/list): List tracked query shapes with cache recommendations.
- [cache-rules set](https://pgbeam.com/docs/cli/projects/cache-rules/set): Enable or disable caching for a query shape.
- [domains add](https://pgbeam.com/docs/cli/projects/domains/add): Register a custom domain for a project.
- [domains delete](https://pgbeam.com/docs/cli/projects/domains/delete): Remove a custom domain.
- [domains list](https://pgbeam.com/docs/cli/projects/domains/list): List custom domains and their verification status.
- [domains verify](https://pgbeam.com/docs/cli/projects/domains/verify): Verify domain DNS records and provision TLS certificate.
- [env pull](https://pgbeam.com/docs/cli/projects/env/pull): Pull DATABASE_URL to a local .env file.
- [replicas add](https://pgbeam.com/docs/cli/projects/replicas/add): Add a read replica to a database.
- [replicas delete](https://pgbeam.com/docs/cli/projects/replicas/delete): Remove a read replica.
- [replicas list](https://pgbeam.com/docs/cli/projects/replicas/list): List read replicas for a database.