PlanetScale Docs - Categorized Links Source: https://planetscale.com/docs/llms.txt Total unique docs links: 444
Basic Usage (37)
- PlanetScale Model Context Protocol (MCP)
- PlanetScale documentation
- Connections overview
- IP restrictions
- Using the Neon serverless driver
- PgBouncer
- Connect privately with AWS PrivateLink
- Connect privately with GCP Private Service Connect
- Connections quickstart
- Managing Roles for your Postgres database
- Connection resilience guide
- PlanetScale Postgres quickstart
- Connection strings
- Network latency
- Connecting to PlanetScale privately on AWS
- Connecting to PlanetScale privately on GCP
- Connecting to PlanetScale securely
- PlanetScale Connect
- Debezium connector for PlanetScale
- Set up GCP Private Service Connect with PlanetScale Managed
- Connection strings
- What is a keyspace
- Workflow: Unsharded to sharded keyspace
- AWS Lambda connection strings
- Connect any application to PlanetScale
- Connect a Django application to PlanetScale
- Connect a Go application to PlanetScale
- Connect a Go application using GORM to PlanetScale
- Connect a Laravel application to PlanetScale
- Connect a MySQL GUI to PlanetScale
- Connect a Next.js application to PlanetScale
- Connect a Node.js application to PlanetScale
- Connect a PHP application to PlanetScale
- Connect a Rails application to PlanetScale
- Connect a Symfony application to PlanetScale
- PlanetScale quickstart guide
- What is PlanetScale?
Debugging & Troubleshooting (9)
- PostgreSQL Proxy - Client Error Reference
- Errors
- Out of memory (OOM)
- Read-only mode
- Import troubleshooting
- Errors
- PlanetScale database error reference
- MySQL compatibility
- Vitess system limits
Monitoring & Observability (29)
- Extensions: pginsights
- Anomalies
- Cluster Logs
- Cluster Metrics
- pganalyze collector
- Sending Prometheus Metrics to Datadog for PlanetScale Postgres
- Prometheus metrics for PlanetScale Postgres
- Prometheus integration for PlanetScale Postgres
- Query Insights
- Schema recommendations
- Audit log
- Audit log
- Sending Prometheus Metrics to Datadog
- Grafana Dashboard for PlanetScale Branches
- Sending Prometheus Metrics to New Relic
- Datadog integration
- Prometheus
- Prometheus metrics
- Anomalies
- Datadog integration
- Sending Prometheus Metrics to Datadog
- Grafana Dashboard for PlanetScale Branches
- Sending Prometheus Metrics to New Relic
- Query Insights
- Schema recommendations
- Prometheus
- Sending Prometheus Metrics to Datadog
- Grafana Dashboard for PlanetScale Branches
- Sending Prometheus Metrics to New Relic
Security & Access Control (16)
- Security and compliance
- Access control
- Account password security
- Authentication methods
- Multi-factor authentication
- Security log
- Single sign-on
- Teams
- Vulnerability disclosure
- Cloud accounts and contents
- Data requests
- User management
- Cloud accounts and contents
- Data requests
- User management
- Password roles
Migrations, Deployments & Recovery (42)
- Deployment options
- Back up and restore
- Point-in-time recovery
- Branching
- Postgres Imports - PGDump and Restore
- Back up and restore
- How to make different types of schema changes
- Amazon Aurora migration guide
- AWS RDS migration guide
- Azure Database for MySQL migration guide
- DigitalOcean database migration guide
- GCP Cloud SQL Migration Guide
- Import public IP addresses
- MariaDB migration guide
- Postgres to MySQL to PlanetScale migration guide
- Postgres to PlanetScale for Vitess migration guide
- Back up and restore in AWS
- Schema snapshots
- Back up and restore in GCP
- Schema snapshots
- Non-blocking schema changes
- Aggressive deploy request cutover
- Branching
- Data Branching®
- Deploy requests
- Handling table and column renames
- How Online Schema Change tools work
- How to make different types of schema changes
- Comparison of Online Schema Change tools
- Online DDL change unique keys
- Safe migrations
- Throttling deploy requests
- VSchema
- Automatic Prisma migrations
- Automatic Rails migrations
- Deploy a Django app to Heroku
- Deploy to Netlify
- Deploy to Vercel
- Deploy to Netlify
- Deploy to Vercel
- Next.js and PlanetScale Netlify template tutorial
- Deploy to Vercel
API & Automation (162)
- OpenAPI Spec
- PlanetScale API and OAuth applications
- Add a member to a team
- Cancel a resize request
- Cancel a change request
- Cancel a queued deploy request
- Close a deploy request
- Complete an errored deploy
- Complete a gated deploy request
- Complete a revert
- Create a backup
- Create a bouncer
- Create a branch
- Create a database
- Create an IP restriction entry
- Create a deploy request
- Create a keyspace
- Create or renew an OAuth token
- Create an organization team
- Create a password
- Create a new query patterns report
- Create role credentials
- Create a service token
- Create a webhook
- Create a workflow
- Delete a backup
- Delete a bouncer
- Delete a branch
- Delete a database
- Delete an IP restriction entry
- Delete a keyspace
- Delete an OAuth token
- Delete an organization team
- Delete a password
- Delete a query patterns report
- Delete role credentials
- Delete a service token
- Delete a webhook
- Demote a branch
- Disable safe migrations for a branch
- Dismiss a schema recommendation
- Enable safe migrations for a branch
- Get a backup
- Get a bouncer
- Get a branch
- Get a branch change request
- Get a branch schema
- Get current user
- Get a database
- Get an IP restriction entry
- Get database throttler configurations
- Get the default postgres role
- Get the deploy queue
- Get a deploy request
- Get deploy request throttler configurations
- Get a deployment
- Get an invoice
- Get invoice line items
- Get a keyspace
- Get keyspace rollout status
- Get the VSchema for the keyspace
- Get an OAuth application
- Get an OAuth token
- Get an organization
- Get an organization member
- Get an organization team
- Get a team member
- Get a password
- Download a finished query patterns report
- Show the status of a query patterns report
- Get a role
- Get a schema recommendation
- Get a service token
- Get a webhook
- Get a workflow
- Getting started with PlanetScale API
- Lint a branch schema
- List audit logs
- List backups
- Get bouncer resize requests
- List bouncers
- Get bouncer resize requests
- Get branch change requests
- List branches
- List available cluster sizes
- List IP restriction entries
- List database regions
- List databases
- List deploy operations
- List deploy request reviews
- List deploy requests
- List cluster extensions
- List generated query patterns reports
- Get invoices
- Get keyspaces
- List OAuth applications
- List organization members
- List team members
- List teams in an organization
- List organizations
- List cluster parameters
- List passwords
- List public regions
- List read-only regions
- List regions for an organization
- List roles
- List schema recommendations
- List service tokens
- List webhooks
- List workflows
- OAuth
- OAuth access scopes
- Create or refresh OAuth token
- Revoke OAuth token
- Get OAuth token info
- Pagination
- Promote a branch
- Queue a deploy request
- Rate limits
- Reassign objects owned by one role to another role
- Remove a member from an organization
- Remove a member from a team
- Renew a password
- Renew role expiration
- Reset default credentials
- Reset a role's password
- Review a deploy request
- Sample OAuth application
- Service tokens
- Skip revert period
- Test a webhook
- Update auto-apply for deploy request
- Update auto-delete branch for deploy request
- Update a backup
- Upsert a bouncer resize request
- Update a branch
- Upsert a change request
- Change a branch cluster configuration
- Update an IP restriction entry
- Update database settings
- Update database throttler configurations
- Update deploy request throttler configurations
- Configure keyspace settings
- Update the VSchema for the keyspace
- Update an organization
- Update organization member role
- Update an organization team
- Update a password
- Update role name
- Update a webhook
- Verify workflow data
- Cancel a workflow
- Complete a workflow
- Cutover traffic
- Retry a failed workflow
- Reverse traffic cutover
- Reverse traffic
- Switch primary traffic
- Switch replica traffic
- Service tokens
- Webhook events reference
- Webhooks
CLI (25)
- PlanetScale CLI
- PlanetScale CLI commands: api
- PlanetScale CLI commands: audit log
- PlanetScale CLI commands: auth
- PlanetScale CLI commands: backup
- PlanetScale CLI commands: branch
- PlanetScale CLI commands: completion
- PlanetScale CLI commands: connect
- PlanetScale CLI commands: database
- PlanetScale CLI commands: deploy-request
- PlanetScale CLI commands: keyspace
- PlanetScale CLI commands: mcp
- PlanetScale CLI commands: org
- PlanetScale CLI commands: password
- PlanetScale CLI commands: ping
- PlanetScale environment set up
- PlanetScale CLI commands: region
- PlanetScale CLI commands: role
- PlanetScale CLI commands: service-token
- Service tokens
- PlanetScale CLI commands: shell
- PlanetScale CLI commands: signup
- PlanetScale CLI commands: size
- PlanetScale CLI commands: webhook
- PlanetScale CLI commands: workflow
Postgres (48)
- PlanetScale Postgres
- Postgres vs Vitess
- Cluster configuration
- Cluster storage configuration
- CPU Architectures
- Disk autoscaling
- Maintenance windows
- Cluster configuration parameters
- Single node
- Cluster updates
- Supported versions
- PlanetScale Postgres database dashboard
- Development Environments
- Extensions
- Extensions: pg_cron
- Extensions: pg_duckdb
- Extensions: pg_hint_plan
- Extensions: pg_partman_bgw
- Extensions: pg_squeeze
- Extensions: pg_stat_statements
- Extensions: pg_strict
- Extensions: TimescaleDB
- Migrate from Aurora to PlanetScale
- Migrate from Aurora using Amazon DMS with CloudFormation
- Migrate from Heroku to PlanetScale
- Import public IP addresses
- Migrate from Neon to PlanetScale
- Postgres Imports
- Postgres Imports - Amazon DMS
- Postgres Imports - WAL Streaming
- Migrate from Supabase to PlanetScale
- Logical replication and Change Data Capture (CDC)
- PlanetScale Postgres operations philosophy
- PlanetScale Postgres architecture
- Postgres compatibility
- PlanetScale Postgres pricing
- Database replicas
- Settings
- Horizontal Sharding for Postgres
- PlanetScale Postgres with Bun
- PlanetScale Postgres with Cloudflare Workers
- PlanetScale Postgres with Drizzle
- PlanetScale Postgres with Kysely
- PlanetScale Postgres with Laravel
- PlanetScale Postgres with Node.js
- PlanetScale Postgres with Prisma
- PlanetScale Postgres with Ruby on Rails
- Postgres to Vitess imports
Vitess (63)
- PlanetScale for Vitess
- PlanetScale Vitess architecture
- PlanetScale workflow for Vitess
- Cluster configuration
- Deleting a database
- Foreign key constraints
- Handling table and column renames
- Database Imports
- Import user permissions
- Airbyte integration
- Cloudflare Workers database integration
- Fivetran integration
- PlanetScale GitHub Actions
- Hightouch integration
- Netlify
- Stitch integration
- Vantage integration
- Maintenance schedules
- PlanetScale Managed overview
- PlanetScale Managed on AWS overview
- Set up PlanetScale Managed in AWS
- Set up AWS PrivateLink with PlanetScale Managed
- Set up AWS Reverse PrivateLink with PlanetScale Managed
- PlanetScale Managed on GCP overview
- Set up PlanetScale Managed in GCP
- MySQL compatibility
- Online DDL change unique keys
- Operating without foreign key constraints
- Pricing
- Regions
- Database replicas
- Cluster configuration
- Cluster sizing
- Vitess system limits
- Read-only regions
- Database replicas
- VTGates
- What are workflows?
- Sharding with PlanetScale
- Avoiding cross-shard queries
- Pre-sharding checklist
- Sequence Tables
- Workflow: Sharded to sharded keyspace
- Sharding new tables
- Sharding workflow state reference
- Targeting the correct keyspace
- Vindexes
- Strategies for maintaining referential integrity
- PlanetScale terminology
- PlanetScale GitHub Actions
- Next.js and PlanetScale Netlify template tutorial
- PlanetScale serverless driver for JavaScript
- Node.js example using the PlanetScale serverless driver
- Using the PlanetScale serverless driver with Prisma
- Prisma best practices
- Using the PlanetScale serverless driver with Prisma
- Using PlanetScale with Prisma
- Vector search and storage
- Vector type and index reference
- Vector database terminology and concepts
- Common use cases for Vector search
- Vectors with an ORM
- Web console
Plans, Billing & Org Admin (13)
- Billing
- How PlanetScale uses AI
- PlanetScale Metal
- Create a Metal database
- How to check performance after upgrading to Metal
- PlanetScale plans
- Cluster sizing
- PlanetScale Managed overview
- Cluster sizes
- Vantage integration
- The proof of concept phase of an enterprise contract
- Exploring Enterprise - the sales process
- PlanetScale Support