PlanetScale Docs - Categorized Links Source: https://planetscale.com/docs/llms.txt Total unique docs links: 444 ## Basic Usage (37) - [PlanetScale Model Context Protocol (MCP)](https://planetscale.com/docs/connect/mcp.md) - [PlanetScale documentation](https://planetscale.com/docs/index.md) - [Connections overview](https://planetscale.com/docs/postgres/connecting.md) - [IP restrictions](https://planetscale.com/docs/postgres/connecting/ip-restrictions.md) - [Using the Neon serverless driver](https://planetscale.com/docs/postgres/connecting/neon-serverless-driver.md) - [PgBouncer](https://planetscale.com/docs/postgres/connecting/pgbouncer.md) - [Connect privately with AWS PrivateLink](https://planetscale.com/docs/postgres/connecting/private-connections/aws-privatelink.md) - [Connect privately with GCP Private Service Connect](https://planetscale.com/docs/postgres/connecting/private-connections/gcp-private-service-connect.md) - [Connections quickstart](https://planetscale.com/docs/postgres/connecting/quickstart.md) - [Managing Roles for your Postgres database](https://planetscale.com/docs/postgres/connecting/roles.md) - [Connection resilience guide](https://planetscale.com/docs/postgres/connection-resilience.md) - [PlanetScale Postgres quickstart](https://planetscale.com/docs/postgres/tutorials/planetscale-postgres-quickstart.md) - [Connection strings](https://planetscale.com/docs/vitess/connecting/connection-strings.md) - [Network latency](https://planetscale.com/docs/vitess/connecting/network-latency.md) - [Connecting to PlanetScale privately on AWS](https://planetscale.com/docs/vitess/connecting/private-connections.md) - [Connecting to PlanetScale privately on GCP](https://planetscale.com/docs/vitess/connecting/private-connections-gcp.md) - [Connecting to PlanetScale securely](https://planetscale.com/docs/vitess/connecting/secure-connections.md) - [PlanetScale Connect](https://planetscale.com/docs/vitess/etl.md) - [Debezium connector for PlanetScale](https://planetscale.com/docs/vitess/integrations/debezium.md) - [Set up GCP Private Service Connect with PlanetScale Managed](https://planetscale.com/docs/vitess/managed/gcp/private-service-connect.md) - [Connection strings](https://planetscale.com/docs/vitess/security/connection-strings.md) - [What is a keyspace](https://planetscale.com/docs/vitess/sharding/keyspaces.md) - [Workflow: Unsharded to sharded keyspace](https://planetscale.com/docs/vitess/sharding/sharding-quickstart.md) - [AWS Lambda connection strings](https://planetscale.com/docs/vitess/tutorials/aws-lambda-connection-strings.md) - [Connect any application to PlanetScale](https://planetscale.com/docs/vitess/tutorials/connect-any-application.md) - [Connect a Django application to PlanetScale](https://planetscale.com/docs/vitess/tutorials/connect-django-app.md) - [Connect a Go application to PlanetScale](https://planetscale.com/docs/vitess/tutorials/connect-go-app.md) - [Connect a Go application using GORM to PlanetScale](https://planetscale.com/docs/vitess/tutorials/connect-go-gorm-app.md) - [Connect a Laravel application to PlanetScale](https://planetscale.com/docs/vitess/tutorials/connect-laravel-app.md) - [Connect a MySQL GUI to PlanetScale](https://planetscale.com/docs/vitess/tutorials/connect-mysql-gui.md) - [Connect a Next.js application to PlanetScale](https://planetscale.com/docs/vitess/tutorials/connect-nextjs-app.md) - [Connect a Node.js application to PlanetScale](https://planetscale.com/docs/vitess/tutorials/connect-nodejs-app.md) - [Connect a PHP application to PlanetScale](https://planetscale.com/docs/vitess/tutorials/connect-php-app.md) - [Connect a Rails application to PlanetScale](https://planetscale.com/docs/vitess/tutorials/connect-rails-app.md) - [Connect a Symfony application to PlanetScale](https://planetscale.com/docs/vitess/tutorials/connect-symfony-app.md) - [PlanetScale quickstart guide](https://planetscale.com/docs/vitess/tutorials/planetscale-quick-start-guide.md) - [What is PlanetScale?](https://planetscale.com/docs/what-is-planetscale.md) ## Debugging & Troubleshooting (9) - [PostgreSQL Proxy - Client Error Reference](https://planetscale.com/docs/postgres/connecting/client-error-reference.md) - [Errors](https://planetscale.com/docs/postgres/monitoring/errors.md) - [Out of memory (OOM)](https://planetscale.com/docs/postgres/troubleshooting/out-of-memory.md) - [Read-only mode](https://planetscale.com/docs/postgres/troubleshooting/read-only-mode.md) - [Import troubleshooting](https://planetscale.com/docs/vitess/imports/import-troubleshooting.md) - [Errors](https://planetscale.com/docs/vitess/monitoring/errors.md) - [PlanetScale database error reference](https://planetscale.com/docs/vitess/troubleshooting/errors.md) - [MySQL compatibility](https://planetscale.com/docs/vitess/troubleshooting/mysql-compatibility.md) - [Vitess system limits](https://planetscale.com/docs/vitess/troubleshooting/planetscale-system-limits.md) ## Monitoring & Observability (29) - [Extensions: pginsights](https://planetscale.com/docs/postgres/extensions/pginsights.md) - [Anomalies](https://planetscale.com/docs/postgres/monitoring/anomalies.md) - [Cluster Logs](https://planetscale.com/docs/postgres/monitoring/logs.md) - [Cluster Metrics](https://planetscale.com/docs/postgres/monitoring/metrics.md) - [pganalyze collector](https://planetscale.com/docs/postgres/monitoring/pganalyze.md) - [Sending Prometheus Metrics to Datadog for PlanetScale Postgres](https://planetscale.com/docs/postgres/monitoring/prometheus-metrics-datadog-postgres.md) - [Prometheus metrics for PlanetScale Postgres](https://planetscale.com/docs/postgres/monitoring/prometheus-metrics-postgres.md) - [Prometheus integration for PlanetScale Postgres](https://planetscale.com/docs/postgres/monitoring/prometheus-postgres.md) - [Query Insights](https://planetscale.com/docs/postgres/monitoring/query-insights.md) - [Schema recommendations](https://planetscale.com/docs/postgres/monitoring/schema-recommendations.md) - [Audit log](https://planetscale.com/docs/security/audit-log.md) - [Audit log](https://planetscale.com/docs/vitess/audit-log.md) - [Sending Prometheus Metrics to Datadog](https://planetscale.com/docs/vitess/guides/prometheus-metrics-datadog.md) - [Grafana Dashboard for PlanetScale Branches](https://planetscale.com/docs/vitess/guides/prometheus-metrics-grafana.md) - [Sending Prometheus Metrics to New Relic](https://planetscale.com/docs/vitess/guides/prometheus-metrics-newrelic.md) - [Datadog integration](https://planetscale.com/docs/vitess/integrations/datadog.md) - [Prometheus](https://planetscale.com/docs/vitess/integrations/prometheus.md) - [Prometheus metrics](https://planetscale.com/docs/vitess/integrations/prometheus-metrics.md) - [Anomalies](https://planetscale.com/docs/vitess/monitoring/anomalies.md) - [Datadog integration](https://planetscale.com/docs/vitess/monitoring/datadog.md) - [Sending Prometheus Metrics to Datadog](https://planetscale.com/docs/vitess/monitoring/prometheus-metrics-datadog.md) - [Grafana Dashboard for PlanetScale Branches](https://planetscale.com/docs/vitess/monitoring/prometheus-metrics-grafana.md) - [Sending Prometheus Metrics to New Relic](https://planetscale.com/docs/vitess/monitoring/prometheus-metrics-newrelic.md) - [Query Insights](https://planetscale.com/docs/vitess/monitoring/query-insights.md) - [Schema recommendations](https://planetscale.com/docs/vitess/monitoring/schema-recommendations.md) - [Prometheus](https://planetscale.com/docs/vitess/tutorials/prometheus.md) - [Sending Prometheus Metrics to Datadog](https://planetscale.com/docs/vitess/tutorials/prometheus-metrics-datadog.md) - [Grafana Dashboard for PlanetScale Branches](https://planetscale.com/docs/vitess/tutorials/prometheus-metrics-grafana.md) - [Sending Prometheus Metrics to New Relic](https://planetscale.com/docs/vitess/tutorials/prometheus-metrics-newrelic.md) ## Security & Access Control (16) - [Security and compliance](https://planetscale.com/docs/security.md) - [Access control](https://planetscale.com/docs/security/access-control.md) - [Account password security](https://planetscale.com/docs/security/account-password-security.md) - [Authentication methods](https://planetscale.com/docs/security/authentication-methods.md) - [Multi-factor authentication](https://planetscale.com/docs/security/multi-factor-authentication.md) - [Security log](https://planetscale.com/docs/security/security-log.md) - [Single sign-on](https://planetscale.com/docs/security/sso.md) - [Teams](https://planetscale.com/docs/security/teams.md) - [Vulnerability disclosure](https://planetscale.com/docs/security/vulnerability-disclosure.md) - [Cloud accounts and contents](https://planetscale.com/docs/vitess/managed/aws/security-and-access/cloud-accounts-and-contents.md) - [Data requests](https://planetscale.com/docs/vitess/managed/aws/security-and-access/data-requests.md) - [User management](https://planetscale.com/docs/vitess/managed/aws/security-and-access/user-management.md) - [Cloud accounts and contents](https://planetscale.com/docs/vitess/managed/gcp/security-and-access/cloud-accounts-and-contents.md) - [Data requests](https://planetscale.com/docs/vitess/managed/gcp/security-and-access/data-requests.md) - [User management](https://planetscale.com/docs/vitess/managed/gcp/security-and-access/user-management.md) - [Password roles](https://planetscale.com/docs/vitess/security/password-roles.md) ## Migrations, Deployments & Recovery (42) - [Deployment options](https://planetscale.com/docs/plans/deployment-options.md) - [Back up and restore](https://planetscale.com/docs/postgres/backups.md) - [Point-in-time recovery](https://planetscale.com/docs/postgres/backups/point-in-time-recovery.md) - [Branching](https://planetscale.com/docs/postgres/branching.md) - [Postgres Imports - PGDump and Restore](https://planetscale.com/docs/postgres/imports/postgres-migrate-dumprestore.md) - [Back up and restore](https://planetscale.com/docs/vitess/backups.md) - [How to make different types of schema changes](https://planetscale.com/docs/vitess/how-to-make-different-types-of-schema-changes.md) - [Amazon Aurora migration guide](https://planetscale.com/docs/vitess/imports/amazon-aurora-migration-guide.md) - [AWS RDS migration guide](https://planetscale.com/docs/vitess/imports/aws-rds-migration-guide.md) - [Azure Database for MySQL migration guide](https://planetscale.com/docs/vitess/imports/azure-database-for-mysql-migration-guide.md) - [DigitalOcean database migration guide](https://planetscale.com/docs/vitess/imports/digitalocean-database-migration-guide.md) - [GCP Cloud SQL Migration Guide](https://planetscale.com/docs/vitess/imports/gcp-cloudsql-migration-guide.md) - [Import public IP addresses](https://planetscale.com/docs/vitess/imports/import-tool-migration-addresses.md) - [MariaDB migration guide](https://planetscale.com/docs/vitess/imports/mariadb-migration-guide.md) - [Postgres to MySQL to PlanetScale migration guide](https://planetscale.com/docs/vitess/imports/postgres-mysql-planetscale-migration-guide.md) - [Postgres to PlanetScale for Vitess migration guide](https://planetscale.com/docs/vitess/imports/postgres-planetscale-migration-guide.md) - [Back up and restore in AWS](https://planetscale.com/docs/vitess/managed/aws/back-up-and-restore.md) - [Schema snapshots](https://planetscale.com/docs/vitess/managed/aws/security-and-access/schema-snapshots.md) - [Back up and restore in GCP](https://planetscale.com/docs/vitess/managed/gcp/back-up-and-restore.md) - [Schema snapshots](https://planetscale.com/docs/vitess/managed/gcp/security-and-access/schema-snapshots.md) - [Non-blocking schema changes](https://planetscale.com/docs/vitess/schema-changes.md) - [Aggressive deploy request cutover](https://planetscale.com/docs/vitess/schema-changes/aggressive-cutover.md) - [Branching](https://planetscale.com/docs/vitess/schema-changes/branching.md) - [Data Branching®](https://planetscale.com/docs/vitess/schema-changes/data-branching.md) - [Deploy requests](https://planetscale.com/docs/vitess/schema-changes/deploy-requests.md) - [Handling table and column renames](https://planetscale.com/docs/vitess/schema-changes/handling-table-and-column-renames.md) - [How Online Schema Change tools work](https://planetscale.com/docs/vitess/schema-changes/how-online-schema-change-tools-work.md) - [How to make different types of schema changes](https://planetscale.com/docs/vitess/schema-changes/how-to-make-different-types-of-schema-changes.md) - [Comparison of Online Schema Change tools](https://planetscale.com/docs/vitess/schema-changes/online-schema-change-tools-comparison.md) - [Online DDL change unique keys](https://planetscale.com/docs/vitess/schema-changes/onlineddl-change-unique-keys.md) - [Safe migrations](https://planetscale.com/docs/vitess/schema-changes/safe-migrations.md) - [Throttling deploy requests](https://planetscale.com/docs/vitess/schema-changes/throttling-deploy-requests.md) - [VSchema](https://planetscale.com/docs/vitess/sharding/vschema.md) - [Automatic Prisma migrations](https://planetscale.com/docs/vitess/tutorials/automatic-prisma-migrations.md) - [Automatic Rails migrations](https://planetscale.com/docs/vitess/tutorials/automatic-rails-migrations.md) - [Deploy a Django app to Heroku](https://planetscale.com/docs/vitess/tutorials/deploy-a-django-app-to-heroku.md) - [Deploy to Netlify](https://planetscale.com/docs/vitess/tutorials/deploy-to-netlify.md) - [Deploy to Vercel](https://planetscale.com/docs/vitess/tutorials/deploy-to-vercel.md) - [Deploy to Netlify](https://planetscale.com/docs/vitess/tutorials/deployments/deploy-to-netlify.md) - [Deploy to Vercel](https://planetscale.com/docs/vitess/tutorials/deployments/deploy-to-vercel.md) - [Next.js and PlanetScale Netlify template tutorial](https://planetscale.com/docs/vitess/tutorials/deployments/nextjs-planetscale-netlify-template.md) - [Deploy to Vercel](https://planetscale.com/docs/vitess/tutorials/nextjs-deploy-to-vercel.md) ## API & Automation (162) - [OpenAPI Spec](https://planetscale.com/docs/api/openapi-spec.md) - [PlanetScale API and OAuth applications](https://planetscale.com/docs/api/planetscale-api-oauth-applications.md) - [Add a member to a team](https://planetscale.com/docs/api/reference/add_organization_team_member.md) - [Cancel a resize request](https://planetscale.com/docs/api/reference/cancel_bouncer_resize_request.md) - [Cancel a change request](https://planetscale.com/docs/api/reference/cancel_branch_change_request.md) - [Cancel a queued deploy request](https://planetscale.com/docs/api/reference/cancel_deploy_request.md) - [Close a deploy request](https://planetscale.com/docs/api/reference/close_deploy_request.md) - [Complete an errored deploy](https://planetscale.com/docs/api/reference/complete_errored_deploy.md) - [Complete a gated deploy request](https://planetscale.com/docs/api/reference/complete_gated_deploy_request.md) - [Complete a revert](https://planetscale.com/docs/api/reference/complete_revert.md) - [Create a backup](https://planetscale.com/docs/api/reference/create_backup.md) - [Create a bouncer](https://planetscale.com/docs/api/reference/create_bouncer.md) - [Create a branch](https://planetscale.com/docs/api/reference/create_branch.md) - [Create a database](https://planetscale.com/docs/api/reference/create_database.md) - [Create an IP restriction entry](https://planetscale.com/docs/api/reference/create_database_postgres_cidr.md) - [Create a deploy request](https://planetscale.com/docs/api/reference/create_deploy_request.md) - [Create a keyspace](https://planetscale.com/docs/api/reference/create_keyspace.md) - [Create or renew an OAuth token](https://planetscale.com/docs/api/reference/create_oauth_token.md) - [Create an organization team](https://planetscale.com/docs/api/reference/create_organization_team.md) - [Create a password](https://planetscale.com/docs/api/reference/create_password.md) - [Create a new query patterns report](https://planetscale.com/docs/api/reference/create_query_patterns_report.md) - [Create role credentials](https://planetscale.com/docs/api/reference/create_role.md) - [Create a service token](https://planetscale.com/docs/api/reference/create_service_token.md) - [Create a webhook](https://planetscale.com/docs/api/reference/create_webhook.md) - [Create a workflow](https://planetscale.com/docs/api/reference/create_workflow.md) - [Delete a backup](https://planetscale.com/docs/api/reference/delete_backup.md) - [Delete a bouncer](https://planetscale.com/docs/api/reference/delete_bouncer.md) - [Delete a branch](https://planetscale.com/docs/api/reference/delete_branch.md) - [Delete a database](https://planetscale.com/docs/api/reference/delete_database.md) - [Delete an IP restriction entry](https://planetscale.com/docs/api/reference/delete_database_postgres_cidr.md) - [Delete a keyspace](https://planetscale.com/docs/api/reference/delete_keyspace.md) - [Delete an OAuth token](https://planetscale.com/docs/api/reference/delete_oauth_token.md) - [Delete an organization team](https://planetscale.com/docs/api/reference/delete_organization_team.md) - [Delete a password](https://planetscale.com/docs/api/reference/delete_password.md) - [Delete a query patterns report](https://planetscale.com/docs/api/reference/delete_query_patterns_report.md) - [Delete role credentials](https://planetscale.com/docs/api/reference/delete_role.md) - [Delete a service token](https://planetscale.com/docs/api/reference/delete_service_token.md) - [Delete a webhook](https://planetscale.com/docs/api/reference/delete_webhook.md) - [Demote a branch](https://planetscale.com/docs/api/reference/demote_branch.md) - [Disable safe migrations for a branch](https://planetscale.com/docs/api/reference/disable_safe_migrations.md) - [Dismiss a schema recommendation](https://planetscale.com/docs/api/reference/dismiss_schema_recommendation.md) - [Enable safe migrations for a branch](https://planetscale.com/docs/api/reference/enable_safe_migrations.md) - [Get a backup](https://planetscale.com/docs/api/reference/get_backup.md) - [Get a bouncer](https://planetscale.com/docs/api/reference/get_bouncer.md) - [Get a branch](https://planetscale.com/docs/api/reference/get_branch.md) - [Get a branch change request](https://planetscale.com/docs/api/reference/get_branch_change_request.md) - [Get a branch schema](https://planetscale.com/docs/api/reference/get_branch_schema.md) - [Get current user](https://planetscale.com/docs/api/reference/get_current_user.md) - [Get a database](https://planetscale.com/docs/api/reference/get_database.md) - [Get an IP restriction entry](https://planetscale.com/docs/api/reference/get_database_postgres_cidr.md) - [Get database throttler configurations](https://planetscale.com/docs/api/reference/get_database_throttler.md) - [Get the default postgres role](https://planetscale.com/docs/api/reference/get_default_role.md) - [Get the deploy queue](https://planetscale.com/docs/api/reference/get_deploy_queue.md) - [Get a deploy request](https://planetscale.com/docs/api/reference/get_deploy_request.md) - [Get deploy request throttler configurations](https://planetscale.com/docs/api/reference/get_deploy_request_throttler.md) - [Get a deployment](https://planetscale.com/docs/api/reference/get_deployment.md) - [Get an invoice](https://planetscale.com/docs/api/reference/get_invoice.md) - [Get invoice line items](https://planetscale.com/docs/api/reference/get_invoice_line_items.md) - [Get a keyspace](https://planetscale.com/docs/api/reference/get_keyspace.md) - [Get keyspace rollout status](https://planetscale.com/docs/api/reference/get_keyspace_rollout_status.md) - [Get the VSchema for the keyspace](https://planetscale.com/docs/api/reference/get_keyspace_vschema.md) - [Get an OAuth application](https://planetscale.com/docs/api/reference/get_oauth_application.md) - [Get an OAuth token](https://planetscale.com/docs/api/reference/get_oauth_token.md) - [Get an organization](https://planetscale.com/docs/api/reference/get_organization.md) - [Get an organization member](https://planetscale.com/docs/api/reference/get_organization_membership.md) - [Get an organization team](https://planetscale.com/docs/api/reference/get_organization_team.md) - [Get a team member](https://planetscale.com/docs/api/reference/get_organization_team_member.md) - [Get a password](https://planetscale.com/docs/api/reference/get_password.md) - [Download a finished query patterns report](https://planetscale.com/docs/api/reference/get_query_patterns_report.md) - [Show the status of a query patterns report](https://planetscale.com/docs/api/reference/get_query_patterns_report_status.md) - [Get a role](https://planetscale.com/docs/api/reference/get_role.md) - [Get a schema recommendation](https://planetscale.com/docs/api/reference/get_schema_recommendation.md) - [Get a service token](https://planetscale.com/docs/api/reference/get_service_token.md) - [Get a webhook](https://planetscale.com/docs/api/reference/get_webhook.md) - [Get a workflow](https://planetscale.com/docs/api/reference/get_workflow.md) - [Getting started with PlanetScale API](https://planetscale.com/docs/api/reference/getting-started-with-planetscale-api.md) - [Lint a branch schema](https://planetscale.com/docs/api/reference/lint_branch_schema.md) - [List audit logs](https://planetscale.com/docs/api/reference/list_audit_logs.md) - [List backups](https://planetscale.com/docs/api/reference/list_backups.md) - [Get bouncer resize requests](https://planetscale.com/docs/api/reference/list_bouncer_resize_requests.md) - [List bouncers](https://planetscale.com/docs/api/reference/list_bouncers.md) - [Get bouncer resize requests](https://planetscale.com/docs/api/reference/list_branch_bouncer_resize_requests.md) - [Get branch change requests](https://planetscale.com/docs/api/reference/list_branch_change_requests.md) - [List branches](https://planetscale.com/docs/api/reference/list_branches.md) - [List available cluster sizes](https://planetscale.com/docs/api/reference/list_cluster_size_skus.md) - [List IP restriction entries](https://planetscale.com/docs/api/reference/list_database_postgres_cidrs.md) - [List database regions](https://planetscale.com/docs/api/reference/list_database_regions.md) - [List databases](https://planetscale.com/docs/api/reference/list_databases.md) - [List deploy operations](https://planetscale.com/docs/api/reference/list_deploy_operations.md) - [List deploy request reviews](https://planetscale.com/docs/api/reference/list_deploy_request_reviews.md) - [List deploy requests](https://planetscale.com/docs/api/reference/list_deploy_requests.md) - [List cluster extensions](https://planetscale.com/docs/api/reference/list_extensions.md) - [List generated query patterns reports](https://planetscale.com/docs/api/reference/list_generated_query_patterns_reports.md) - [Get invoices](https://planetscale.com/docs/api/reference/list_invoices.md) - [Get keyspaces](https://planetscale.com/docs/api/reference/list_keyspaces.md) - [List OAuth applications](https://planetscale.com/docs/api/reference/list_oauth_applications.md) - [List organization members](https://planetscale.com/docs/api/reference/list_organization_members.md) - [List team members](https://planetscale.com/docs/api/reference/list_organization_team_members.md) - [List teams in an organization](https://planetscale.com/docs/api/reference/list_organization_teams.md) - [List organizations](https://planetscale.com/docs/api/reference/list_organizations.md) - [List cluster parameters](https://planetscale.com/docs/api/reference/list_parameters.md) - [List passwords](https://planetscale.com/docs/api/reference/list_passwords.md) - [List public regions](https://planetscale.com/docs/api/reference/list_public_regions.md) - [List read-only regions](https://planetscale.com/docs/api/reference/list_read_only_regions.md) - [List regions for an organization](https://planetscale.com/docs/api/reference/list_regions_for_organization.md) - [List roles](https://planetscale.com/docs/api/reference/list_roles.md) - [List schema recommendations](https://planetscale.com/docs/api/reference/list_schema_recommendations.md) - [List service tokens](https://planetscale.com/docs/api/reference/list_service_tokens.md) - [List webhooks](https://planetscale.com/docs/api/reference/list_webhooks.md) - [List workflows](https://planetscale.com/docs/api/reference/list_workflows.md) - [OAuth](https://planetscale.com/docs/api/reference/oauth.md) - [OAuth access scopes](https://planetscale.com/docs/api/reference/oauth-access-scopes.md) - [Create or refresh OAuth token](https://planetscale.com/docs/api/reference/oauth/create-token.md) - [Revoke OAuth token](https://planetscale.com/docs/api/reference/oauth/revoke-token.md) - [Get OAuth token info](https://planetscale.com/docs/api/reference/oauth/token-info.md) - [Pagination](https://planetscale.com/docs/api/reference/pagination.md) - [Promote a branch](https://planetscale.com/docs/api/reference/promote_branch.md) - [Queue a deploy request](https://planetscale.com/docs/api/reference/queue_deploy_request.md) - [Rate limits](https://planetscale.com/docs/api/reference/rate-limits.md) - [Reassign objects owned by one role to another role](https://planetscale.com/docs/api/reference/reassign_role_objects.md) - [Remove a member from an organization](https://planetscale.com/docs/api/reference/remove_organization_member.md) - [Remove a member from a team](https://planetscale.com/docs/api/reference/remove_organization_team_member.md) - [Renew a password](https://planetscale.com/docs/api/reference/renew_password.md) - [Renew role expiration](https://planetscale.com/docs/api/reference/renew_role.md) - [Reset default credentials](https://planetscale.com/docs/api/reference/reset_default_role.md) - [Reset a role's password](https://planetscale.com/docs/api/reference/reset_role.md) - [Review a deploy request](https://planetscale.com/docs/api/reference/review_deploy_request.md) - [Sample OAuth application](https://planetscale.com/docs/api/reference/sample-oauth-application.md) - [Service tokens](https://planetscale.com/docs/api/reference/service-tokens.md) - [Skip revert period](https://planetscale.com/docs/api/reference/skip_revert_period.md) - [Test a webhook](https://planetscale.com/docs/api/reference/test_webhook.md) - [Update auto-apply for deploy request](https://planetscale.com/docs/api/reference/update_auto_apply.md) - [Update auto-delete branch for deploy request](https://planetscale.com/docs/api/reference/update_auto_delete_branch.md) - [Update a backup](https://planetscale.com/docs/api/reference/update_backup.md) - [Upsert a bouncer resize request](https://planetscale.com/docs/api/reference/update_bouncer_resize_request.md) - [Update a branch](https://planetscale.com/docs/api/reference/update_branch.md) - [Upsert a change request](https://planetscale.com/docs/api/reference/update_branch_change_request.md) - [Change a branch cluster configuration](https://planetscale.com/docs/api/reference/update_branch_cluster_config.md) - [Update an IP restriction entry](https://planetscale.com/docs/api/reference/update_database_postgres_cidr.md) - [Update database settings](https://planetscale.com/docs/api/reference/update_database_settings.md) - [Update database throttler configurations](https://planetscale.com/docs/api/reference/update_database_throttler.md) - [Update deploy request throttler configurations](https://planetscale.com/docs/api/reference/update_deploy_request_throttler.md) - [Configure keyspace settings](https://planetscale.com/docs/api/reference/update_keyspace.md) - [Update the VSchema for the keyspace](https://planetscale.com/docs/api/reference/update_keyspace_vschema.md) - [Update an organization](https://planetscale.com/docs/api/reference/update_organization.md) - [Update organization member role](https://planetscale.com/docs/api/reference/update_organization_membership.md) - [Update an organization team](https://planetscale.com/docs/api/reference/update_organization_team.md) - [Update a password](https://planetscale.com/docs/api/reference/update_password.md) - [Update role name](https://planetscale.com/docs/api/reference/update_role.md) - [Update a webhook](https://planetscale.com/docs/api/reference/update_webhook.md) - [Verify workflow data](https://planetscale.com/docs/api/reference/verify_workflow.md) - [Cancel a workflow](https://planetscale.com/docs/api/reference/workflow_cancel.md) - [Complete a workflow](https://planetscale.com/docs/api/reference/workflow_complete.md) - [Cutover traffic](https://planetscale.com/docs/api/reference/workflow_cutover.md) - [Retry a failed workflow](https://planetscale.com/docs/api/reference/workflow_retry.md) - [Reverse traffic cutover](https://planetscale.com/docs/api/reference/workflow_reverse_cutover.md) - [Reverse traffic](https://planetscale.com/docs/api/reference/workflow_reverse_traffic.md) - [Switch primary traffic](https://planetscale.com/docs/api/reference/workflow_switch_primaries.md) - [Switch replica traffic](https://planetscale.com/docs/api/reference/workflow_switch_replicas.md) - [Service tokens](https://planetscale.com/docs/api/service-tokens.md) - [Webhook events reference](https://planetscale.com/docs/api/webhook-events.md) - [Webhooks](https://planetscale.com/docs/api/webhooks.md) ## CLI (25) - [PlanetScale CLI](https://planetscale.com/docs/cli.md) - [PlanetScale CLI commands: api](https://planetscale.com/docs/cli/api.md) - [PlanetScale CLI commands: audit log](https://planetscale.com/docs/cli/audit-log.md) - [PlanetScale CLI commands: auth](https://planetscale.com/docs/cli/auth.md) - [PlanetScale CLI commands: backup](https://planetscale.com/docs/cli/backup.md) - [PlanetScale CLI commands: branch](https://planetscale.com/docs/cli/branch.md) - [PlanetScale CLI commands: completion](https://planetscale.com/docs/cli/completion.md) - [PlanetScale CLI commands: connect](https://planetscale.com/docs/cli/connect.md) - [PlanetScale CLI commands: database](https://planetscale.com/docs/cli/database.md) - [PlanetScale CLI commands: deploy-request](https://planetscale.com/docs/cli/deploy-request.md) - [PlanetScale CLI commands: keyspace](https://planetscale.com/docs/cli/keyspace.md) - [PlanetScale CLI commands: mcp](https://planetscale.com/docs/cli/mcp.md) - [PlanetScale CLI commands: org](https://planetscale.com/docs/cli/org.md) - [PlanetScale CLI commands: password](https://planetscale.com/docs/cli/password.md) - [PlanetScale CLI commands: ping](https://planetscale.com/docs/cli/ping.md) - [PlanetScale environment set up](https://planetscale.com/docs/cli/planetscale-environment-setup.md) - [PlanetScale CLI commands: region](https://planetscale.com/docs/cli/region.md) - [PlanetScale CLI commands: role](https://planetscale.com/docs/cli/role.md) - [PlanetScale CLI commands: service-token](https://planetscale.com/docs/cli/service-token.md) - [Service tokens](https://planetscale.com/docs/cli/service-tokens.md) - [PlanetScale CLI commands: shell](https://planetscale.com/docs/cli/shell.md) - [PlanetScale CLI commands: signup](https://planetscale.com/docs/cli/signup.md) - [PlanetScale CLI commands: size](https://planetscale.com/docs/cli/size.md) - [PlanetScale CLI commands: webhook](https://planetscale.com/docs/cli/webhook.md) - [PlanetScale CLI commands: workflow](https://planetscale.com/docs/cli/workflow.md) ## Postgres (48) - [PlanetScale Postgres](https://planetscale.com/docs/postgres.md) - [Postgres vs Vitess](https://planetscale.com/docs/postgres-vs-vitess.md) - [Cluster configuration](https://planetscale.com/docs/postgres/cluster-configuration.md) - [Cluster storage configuration](https://planetscale.com/docs/postgres/cluster-configuration/cluster-storage.md) - [CPU Architectures](https://planetscale.com/docs/postgres/cluster-configuration/cpu-architectures.md) - [Disk autoscaling](https://planetscale.com/docs/postgres/cluster-configuration/disk-autoscaling.md) - [Maintenance windows](https://planetscale.com/docs/postgres/cluster-configuration/maintenance-windows.md) - [Cluster configuration parameters](https://planetscale.com/docs/postgres/cluster-configuration/parameters.md) - [Single node](https://planetscale.com/docs/postgres/cluster-configuration/single-node.md) - [Cluster updates](https://planetscale.com/docs/postgres/cluster-configuration/updates.md) - [Supported versions](https://planetscale.com/docs/postgres/cluster-configuration/versions.md) - [PlanetScale Postgres database dashboard](https://planetscale.com/docs/postgres/dashboard.md) - [Development Environments](https://planetscale.com/docs/postgres/development-environments.md) - [Extensions](https://planetscale.com/docs/postgres/extensions.md) - [Extensions: pg_cron](https://planetscale.com/docs/postgres/extensions/pg_cron.md) - [Extensions: pg_duckdb](https://planetscale.com/docs/postgres/extensions/pg_duckdb.md) - [Extensions: pg_hint_plan](https://planetscale.com/docs/postgres/extensions/pg_hint_plan.md) - [Extensions: pg_partman_bgw](https://planetscale.com/docs/postgres/extensions/pg_partman_bgw.md) - [Extensions: pg_squeeze](https://planetscale.com/docs/postgres/extensions/pg_squeeze.md) - [Extensions: pg_stat_statements](https://planetscale.com/docs/postgres/extensions/pg_stat_statements.md) - [Extensions: pg_strict](https://planetscale.com/docs/postgres/extensions/pg_strict.md) - [Extensions: TimescaleDB](https://planetscale.com/docs/postgres/extensions/timescaledb.md) - [Migrate from Aurora to PlanetScale](https://planetscale.com/docs/postgres/imports/aurora.md) - [Migrate from Aurora using Amazon DMS with CloudFormation](https://planetscale.com/docs/postgres/imports/aurora-dms.md) - [Migrate from Heroku to PlanetScale](https://planetscale.com/docs/postgres/imports/heroku.md) - [Import public IP addresses](https://planetscale.com/docs/postgres/imports/import-ips.md) - [Migrate from Neon to PlanetScale](https://planetscale.com/docs/postgres/imports/neon.md) - [Postgres Imports](https://planetscale.com/docs/postgres/imports/postgres-imports.md) - [Postgres Imports - Amazon DMS](https://planetscale.com/docs/postgres/imports/postgres-migrate-dms.md) - [Postgres Imports - WAL Streaming](https://planetscale.com/docs/postgres/imports/postgres-migrate-walstream.md) - [Migrate from Supabase to PlanetScale](https://planetscale.com/docs/postgres/imports/supabase.md) - [Logical replication and Change Data Capture (CDC)](https://planetscale.com/docs/postgres/integrations/logical-cdc.md) - [PlanetScale Postgres operations philosophy](https://planetscale.com/docs/postgres/operations-philosophy.md) - [PlanetScale Postgres architecture](https://planetscale.com/docs/postgres/postgres-architecture.md) - [Postgres compatibility](https://planetscale.com/docs/postgres/postgres-compatibility.md) - [PlanetScale Postgres pricing](https://planetscale.com/docs/postgres/pricing.md) - [Database replicas](https://planetscale.com/docs/postgres/scaling/replicas.md) - [Settings](https://planetscale.com/docs/postgres/settings.md) - [Horizontal Sharding for Postgres](https://planetscale.com/docs/postgres/sharding.md) - [PlanetScale Postgres with Bun](https://planetscale.com/docs/postgres/tutorials/planetscale-postgres-bun.md) - [PlanetScale Postgres with Cloudflare Workers](https://planetscale.com/docs/postgres/tutorials/planetscale-postgres-cloudflare-workers.md) - [PlanetScale Postgres with Drizzle](https://planetscale.com/docs/postgres/tutorials/planetscale-postgres-drizzle.md) - [PlanetScale Postgres with Kysely](https://planetscale.com/docs/postgres/tutorials/planetscale-postgres-kysely.md) - [PlanetScale Postgres with Laravel](https://planetscale.com/docs/postgres/tutorials/planetscale-postgres-laravel.md) - [PlanetScale Postgres with Node.js](https://planetscale.com/docs/postgres/tutorials/planetscale-postgres-node.md) - [PlanetScale Postgres with Prisma](https://planetscale.com/docs/postgres/tutorials/planetscale-postgres-prisma.md) - [PlanetScale Postgres with Ruby on Rails](https://planetscale.com/docs/postgres/tutorials/planetscale-postgres-rails.md) - [Postgres to Vitess imports](https://planetscale.com/docs/vitess/imports/postgres.md) ## Vitess (63) - [PlanetScale for Vitess](https://planetscale.com/docs/vitess.md) - [PlanetScale Vitess architecture](https://planetscale.com/docs/vitess/architecture.md) - [PlanetScale workflow for Vitess](https://planetscale.com/docs/vitess/best-practices.md) - [Cluster configuration](https://planetscale.com/docs/vitess/cluster-configuration.md) - [Deleting a database](https://planetscale.com/docs/vitess/delete-a-database.md) - [Foreign key constraints](https://planetscale.com/docs/vitess/foreign-key-constraints.md) - [Handling table and column renames](https://planetscale.com/docs/vitess/handling-table-and-column-renames.md) - [Database Imports](https://planetscale.com/docs/vitess/imports/database-imports.md) - [Import user permissions](https://planetscale.com/docs/vitess/imports/import-tool-user-requirements.md) - [Airbyte integration](https://planetscale.com/docs/vitess/integrations/airbyte.md) - [Cloudflare Workers database integration](https://planetscale.com/docs/vitess/integrations/cloudflare-workers.md) - [Fivetran integration](https://planetscale.com/docs/vitess/integrations/fivetran.md) - [PlanetScale GitHub Actions](https://planetscale.com/docs/vitess/integrations/github-actions.md) - [Hightouch integration](https://planetscale.com/docs/vitess/integrations/hightouch.md) - [Netlify](https://planetscale.com/docs/vitess/integrations/netlify.md) - [Stitch integration](https://planetscale.com/docs/vitess/integrations/stitch.md) - [Vantage integration](https://planetscale.com/docs/vitess/integrations/vantage.md) - [Maintenance schedules](https://planetscale.com/docs/vitess/maintenance-schedules.md) - [PlanetScale Managed overview](https://planetscale.com/docs/vitess/managed.md) - [PlanetScale Managed on AWS overview](https://planetscale.com/docs/vitess/managed/aws.md) - [Set up PlanetScale Managed in AWS](https://planetscale.com/docs/vitess/managed/aws/getting-started.md) - [Set up AWS PrivateLink with PlanetScale Managed](https://planetscale.com/docs/vitess/managed/aws/privatelink.md) - [Set up AWS Reverse PrivateLink with PlanetScale Managed](https://planetscale.com/docs/vitess/managed/aws/reverse-privatelink.md) - [PlanetScale Managed on GCP overview](https://planetscale.com/docs/vitess/managed/gcp.md) - [Set up PlanetScale Managed in GCP](https://planetscale.com/docs/vitess/managed/gcp/getting-started.md) - [MySQL compatibility](https://planetscale.com/docs/vitess/mysql-compatibility.md) - [Online DDL change unique keys](https://planetscale.com/docs/vitess/onlineddl-change-unique-keys.md) - [Operating without foreign key constraints](https://planetscale.com/docs/vitess/operating-without-foreign-key-constraints.md) - [Pricing](https://planetscale.com/docs/vitess/pricing.md) - [Regions](https://planetscale.com/docs/vitess/regions.md) - [Database replicas](https://planetscale.com/docs/vitess/replicas.md) - [Cluster configuration](https://planetscale.com/docs/vitess/scaling/cluster-configuration.md) - [Cluster sizing](https://planetscale.com/docs/vitess/scaling/cluster-sizing.md) - [Vitess system limits](https://planetscale.com/docs/vitess/scaling/planetscale-system-limits.md) - [Read-only regions](https://planetscale.com/docs/vitess/scaling/read-only-regions.md) - [Database replicas](https://planetscale.com/docs/vitess/scaling/replicas.md) - [VTGates](https://planetscale.com/docs/vitess/scaling/vtgates.md) - [What are workflows?](https://planetscale.com/docs/vitess/scaling/workflows.md) - [Sharding with PlanetScale](https://planetscale.com/docs/vitess/sharding.md) - [Avoiding cross-shard queries](https://planetscale.com/docs/vitess/sharding/avoiding-cross-shard-queries.md) - [Pre-sharding checklist](https://planetscale.com/docs/vitess/sharding/pre-sharding-checklist.md) - [Sequence Tables](https://planetscale.com/docs/vitess/sharding/sequence-tables.md) - [Workflow: Sharded to sharded keyspace](https://planetscale.com/docs/vitess/sharding/sharding-a-sharded-keyspace.md) - [Sharding new tables](https://planetscale.com/docs/vitess/sharding/sharding-new-tables.md) - [Sharding workflow state reference](https://planetscale.com/docs/vitess/sharding/sharding-workflow-state-reference.md) - [Targeting the correct keyspace](https://planetscale.com/docs/vitess/sharding/targeting-correct-keyspace.md) - [Vindexes](https://planetscale.com/docs/vitess/sharding/vindexes.md) - [Strategies for maintaining referential integrity](https://planetscale.com/docs/vitess/strategies-for-maintaining-referential-integrity.md) - [PlanetScale terminology](https://planetscale.com/docs/vitess/terminology.md) - [PlanetScale GitHub Actions](https://planetscale.com/docs/vitess/tutorials/github-actions.md) - [Next.js and PlanetScale Netlify template tutorial](https://planetscale.com/docs/vitess/tutorials/nextjs-planetscale-netlify-template.md) - [PlanetScale serverless driver for JavaScript](https://planetscale.com/docs/vitess/tutorials/planetscale-serverless-driver.md) - [Node.js example using the PlanetScale serverless driver](https://planetscale.com/docs/vitess/tutorials/planetscale-serverless-driver-node-example.md) - [Using the PlanetScale serverless driver with Prisma](https://planetscale.com/docs/vitess/tutorials/planetscale-serverless-driver-prisma-example.md) - [Prisma best practices](https://planetscale.com/docs/vitess/tutorials/prisma-best-practices.md) - [Using the PlanetScale serverless driver with Prisma](https://planetscale.com/docs/vitess/tutorials/prisma-example.md) - [Using PlanetScale with Prisma](https://planetscale.com/docs/vitess/tutorials/using-planetscale-with-prisma.md) - [Vector search and storage](https://planetscale.com/docs/vitess/vectors.md) - [Vector type and index reference](https://planetscale.com/docs/vitess/vectors/reference.md) - [Vector database terminology and concepts](https://planetscale.com/docs/vitess/vectors/terminology-and-concepts.md) - [Common use cases for Vector search](https://planetscale.com/docs/vitess/vectors/use-cases.md) - [Vectors with an ORM](https://planetscale.com/docs/vitess/vectors/using-with-an-orm.md) - [Web console](https://planetscale.com/docs/vitess/web-console.md) ## Plans, Billing & Org Admin (13) - [Billing](https://planetscale.com/docs/billing.md) - [How PlanetScale uses AI](https://planetscale.com/docs/how-we-use-ai.md) - [PlanetScale Metal](https://planetscale.com/docs/metal.md) - [Create a Metal database](https://planetscale.com/docs/metal/create-a-metal-database.md) - [How to check performance after upgrading to Metal](https://planetscale.com/docs/metal/metal-performance.md) - [PlanetScale plans](https://planetscale.com/docs/planetscale-plans.md) - [Cluster sizing](https://planetscale.com/docs/plans/cluster-sizing.md) - [PlanetScale Managed overview](https://planetscale.com/docs/plans/managed.md) - [Cluster sizes](https://planetscale.com/docs/plans/planetscale-skus.md) - [Vantage integration](https://planetscale.com/docs/plans/vantage.md) - [The proof of concept phase of an enterprise contract](https://planetscale.com/docs/proof-of-concept.md) - [Exploring Enterprise - the sales process](https://planetscale.com/docs/sales-process.md) - [PlanetScale Support](https://planetscale.com/docs/support.md)