Documentation
Get startedSign in
Concepts
Getting started with PlanetScale
What is PlanetScalePlanetScale workflowBranchingData Branching™Non-blocking schema changesDeploy requestsConnection stringsRegionsRead-only regionsDatabase sleeping
Security and access
Security & complianceAccess controlAuthentication methodsAccount password securityMulti-factor authenticationPassword rolesSecurity logSingle sign-onTeamsSecure connectionsService tokens
Deployment
Deployment options
Monitoring and analytics
Audit logQuery Insights
Query caching
Query caching with PlanetScale BoostWhat is PlanetScale Boost
CLI
PlanetScale CLI environment set up
API
PlanetScale and OAuth applications
BillingBack up and restoreWeb console
GuidesPlanetScale quickstartConnect any appConnect a MySQL GUIDjango
Golang
Go quickstartGORM quickstart
Node.js
Next.js
Next.js quickstartNext.js and Netlify templateDeploy to VercelDeploy to Netlify
PHP
Laravel quickstartSymfony quickstartPHP quickstart
Prisma
Prisma quickstartPrisma Data Platform integrationAutomatic Prisma migrations
Ruby on Rails
Ruby on Rails quickstartAutomatic Ruby on Rails migrations
Serverless JavaScript driver
Using the serverless driverNode.js example
Deploy your app
Deploy to NetlifyDeploy to VercelNext.js and Netlify templateDeploy a Django app to Heroku
AWS
AWS Lambda connection strings
PlanetScale Boost guides
Laravel guideRails guideGo guidePrisma guideNode.js guideServerless JavaScript driver guide
ImportsDatabase imports
Migration guides
AWS RDSAzureDigitalOceanGCP CloudSQL
Import tool public IP addressesImport tool user permissions
IntegrationsDatadogAirbyteStitch
Learn
Foreign key constraints
Operating without FK constraintsStrategies to maintain integrity
Schema changes
Comparison of Online Schema Change tools
Single unique key
Change single unique key
Table and column renames
Handling table and column renames
ReferencePlanetScale API and OAuth referenceMySQL compatibilityPlanetScale system limitsPlanetScale CLI overview
CLI command reference
audit-logauthbackupbranchcompletionconnectdatabasedeploy-requestorgpasswordregionservice-tokenshellsignup
SupportPlanetScale Support overview
Concepts
Getting started with PlanetScale
What is PlanetScalePlanetScale workflowBranchingData Branching™Non-blocking schema changesDeploy requestsConnection stringsRegionsRead-only regionsDatabase sleeping
Security and access
Security & complianceAccess controlAuthentication methodsAccount password securityMulti-factor authenticationPassword rolesSecurity logSingle sign-onTeamsSecure connectionsService tokens
Deployment
Deployment options
Monitoring and analytics
Audit logQuery Insights
Query caching
Query caching with PlanetScale BoostWhat is PlanetScale Boost
CLI
PlanetScale CLI environment set up
API
PlanetScale and OAuth applications
BillingBack up and restoreWeb console
GuidesPlanetScale quickstartConnect any appConnect a MySQL GUIDjango
Golang
Go quickstartGORM quickstart
Node.js
Next.js
Next.js quickstartNext.js and Netlify templateDeploy to VercelDeploy to Netlify
PHP
Laravel quickstartSymfony quickstartPHP quickstart
Prisma
Prisma quickstartPrisma Data Platform integrationAutomatic Prisma migrations
Ruby on Rails
Ruby on Rails quickstartAutomatic Ruby on Rails migrations
Serverless JavaScript driver
Using the serverless driverNode.js example
Deploy your app
Deploy to NetlifyDeploy to VercelNext.js and Netlify templateDeploy a Django app to Heroku
AWS
AWS Lambda connection strings
PlanetScale Boost guides
Laravel guideRails guideGo guidePrisma guideNode.js guideServerless JavaScript driver guide
ImportsDatabase imports
Migration guides
AWS RDSAzureDigitalOceanGCP CloudSQL
Import tool public IP addressesImport tool user permissions
IntegrationsDatadogAirbyteStitch
Learn
Foreign key constraints
Operating without FK constraintsStrategies to maintain integrity
Schema changes
Comparison of Online Schema Change tools
Single unique key
Change single unique key
Table and column renames
Handling table and column renames
ReferencePlanetScale API and OAuth referenceMySQL compatibilityPlanetScale system limitsPlanetScale CLI overview
CLI command reference
audit-logauthbackupbranchcompletionconnectdatabasedeploy-requestorgpasswordregionservice-tokenshellsignup
SupportPlanetScale Support overview

PlanetScale documentation

Learn how to use PlanetScale to power your application.

New to PlanetScale?

Follow this step-by-step guide to quickly get up and running with PlanetScale. You’ll learn the following:

  1. Account setup
  2. Creating your first database
  3. Branching and deployments
  4. Connecting to your database

Get started with PlanetScale

What is PlanetScale

Learn about how PlanetScale can help you scale and speed up development.

PlanetScale quickstart guide

Deploy a database and learn the basics of using PlanetScale with an example.

Import a database

Use our import tool to import a database to PlanetScale with no downtime.

Connection strings

PlanetScale provides secure connection strings for your database branches.

Tutorials

Ruby on Rails

Learn how to connect your Rails app to a PlanetScale database.

Vercel

Deploy a Next.js app with a PlanetScale database to Vercel.

Prisma

Learn how to use PlanetScale's automatic migrations with Prisma.

  • Privacy
  • Terms
  • Support
  • Contact
© 2023 PlanetScale Inc.