# Planetscale > When you set up your PlanetScale account, you're asked to create an **Organization**. ## Pages - [Access control](access-control.md): When you set up your PlanetScale account, you're asked to create an **Organization**. - [Account password security](account-password-security.md): In addition to best practices like [multi-factor authentication](/docs/security/multi-factor-authentication), PlanetS... - [Aggressive deploy request cutover](aggressive-cutover.md): Cutover is the critical final step in an online schema migration where Vitess atomically replaces the original table ... - [Airbyte integration](airbyte.md): With PlanetScale Connect, you can extract data from your PlanetScale database and safely load it into other destinati... - [Amazon Aurora migration guide](amazon-aurora-migration-guide.md): This document will demonstrate how to migrate a database from Amazon Aurora (MySQL compatible) to PlanetScale. - [Anomalies](anomalies.md): Anomalies are defined as periods with a substantially elevated percentage of slow-running queries. - [PlanetScale Vitess architecture](architecture.md): PlanetScale's Vitess product is designed for reliability, scalability, and developer productivity. - [PlanetScale CLI commands: audit log](audit-log.md): Make sure to first [set up your PlanetScale developer environment](/docs/cli/planetscale-environment-setup). Once you... - [Postgres Imports - Amazon DMS with CloudFormation](aurora-dms.md): This method uses Infrastructure as Code with Step Functions workflow automation for a completely managed migration ex... - [Migrate from Aurora to PlanetScale](aurora.md): Use this guide to migrate an existing Aurora (Postgres) database to PlanetScale Postgres. - [PlanetScale CLI commands: auth](auth.md): Make sure to first [set up your PlanetScale developer environment](/docs/cli/planetscale-environment-setup). Once you... - [Authentication methods](authentication-methods.md): There are three ways to authenticate with PlanetScale: _email address and password_, _single sign-on_, and _OAuth via... - [Automatic Prisma migrations](automatic-prisma-migrations.md): This document has been updated to include the recommended Prisma and PlanetScale workflow, specifically the - [Automatic Rails migrations](automatic-rails-migrations.md): If you are using PlanetScale with a Rails application, go to your database's Settings page in the web app and enable - [Avoiding cross-shard queries](avoiding-cross-shard-queries.md): export const YouTubeEmbed = ({id, title}) => { - [AWS Lambda connection strings](aws-lambda-connection-strings.md): In this guide, you'll learn how to properly store and use PlanetScale MySQL connection strings for use in AWS Lambda ... - [Connect privately with AWS PrivateLink](aws-privatelink.md): When you use AWS PrivateLink, your network traffic between your VPC and PlanetScale stays within the AWS network, wit... - [AWS RDS migration guide](aws-rds-migration-guide.md): This document will demonstrate how to migrate a database from AWS Relational Database Services (RDS) to PlanetScale. - [PlanetScale Managed on AWS overview](aws.md): PlanetScale Managed on Amazon Web Services (AWS) is a single-tenant deployment of PlanetScale in your AWS organizatio... - [Azure Database for MySQL migration guide](azure-database-for-mysql-migration-guide.md): This document will demonstrate how to migrate a database from Azure Database for MySQL to PlanetScale. We recommend r... - [Back up and restore in AWS](back-up-and-restore.md): PlanetScale Managed backup and restore functions like the hosted PlanetScale product. For more info, see [how to crea... - [PlanetScale CLI commands: backup](backup.md): Make sure to first [set up your PlanetScale developer environment](/docs/cli/planetscale-environment-setup). Once you... - [Back up and restore](backups.md): PlanetScale Postgres databases include comprehensive backup and restore capabilities to protect your data. The backup... - [PlanetScale workflow for Vitess](best-practices.md): PlanetScale databases are designed for developers and developer workflows. Deploy a fully managed database cluster wi... - [Billing](billing.md): PlanetScale applies billing plans at the **database level**. You can create several databases under one Organization. - [PlanetScale CLI commands: branch](branch.md): Make sure to first [set up your PlanetScale developer environment](/docs/cli/planetscale-environment-setup). Once you... - [Branching](branching.md): Branches on PlanetScale Postgres are isolated database deployments that provide you with separate environments for de... - [Cancel a resize request](cancel-bouncer-resize-request.md): > - [Cancel a change request](cancel-branch-change-request.md): > - [Cancel a queued deploy request](cancel-deploy-request.md): > - [PlanetScale CLI](cli.md): To interact with PlanetScale and manage your databases, you can use the`pscale`CLI to do the following: - [PostgreSQL Proxy - Client Error Reference](client-error-reference.md): This document provides a comprehensive reference of all error messages that the Exosphere PostgreSQL proxy may send t... - [Close a deploy request](close-deploy-request.md): > - [Cloud accounts and contents](cloud-accounts-and-contents.md): PlanetScale is not responsible for the general configuration of services shared across the cloud organization in whic... - [Cloudflare Workers database integration](cloudflare-workers.md): [Cloudflare Workers database integration](https://developers.cloudflare.com/workers/learning/integrations/databases/#... - [Cluster configuration](cluster-configuration.md): The Clusters page in your PlanetScale dashboard allows you to monitor your cluster utilization and configure cluster ... - [Cluster sizing](cluster-sizing.md): export const YouTubeEmbed = ({id, title}) => { - [Cluster storage configuration](cluster-storage.md): You can configure storage settings for network-attached storage PlanetScale Postgres clusters in the "**Storage**" ta... - [Complete an errored deploy](complete-errored-deploy.md): > - [Complete a gated deploy request](complete-gated-deploy-request.md): > - [Complete a revert](complete-revert.md): > - [PlanetScale CLI commands: completion](completion.md): Make sure to first [set up your PlanetScale developer environment](/docs/cli/planetscale-environment-setup). Once you... - [Connect any application to PlanetScale](connect-any-application.md): In this tutorial, you'll learn how to connect any application to your PlanetScale database. - [Connect a Django application to PlanetScale](connect-django-app.md): In this tutorial, you'll learn how to connect a Django application to a PlanetScale MySQL database using a pre-built ... - [Connect a Go application to PlanetScale](connect-go-app.md): export const VimeoEmbed = ({id, title}) => { - [Connect a Go application using GORM to PlanetScale](connect-go-gorm-app.md): In this tutorial, you'll learn how to connect a Go application to a PlanetScale MySQL database using a sample Go star... - [Connect a Laravel application to PlanetScale](connect-laravel-app.md): In this tutorial, you'll learn how to connect a Laravel 12 application to a PlanetScale MySQL database using a sample... - [Connect a MySQL GUI to PlanetScale](connect-mysql-gui.md): In this tutorial, you'll learn how to connect to a PlanetScale database using a MySQL GUI. While this tutorial uses S... - [Connect a Next.js application to PlanetScale](connect-nextjs-app.md): In this tutorial, you'll create a [Next.js](https://nextjs.org/) application that uses [Tailwind CSS](https://tailwin... - [Connect a Node.js application to PlanetScale](connect-nodejs-app.md): In this tutorial, you'll create a simple Node.js and Express.js application and connect it to a PlanetScale database. - [Connect a PHP application to PlanetScale](connect-php-app.md): In this tutorial, you'll learn how to connect a PHP application to a PlanetScale MySQL database with a sample PHP sta... - [Connect a Rails application to PlanetScale](connect-rails-app.md): In this tutorial, you’re going to create a simple Rails application named *blog* and connect it to a PlanetScale data... - [Connect a Symfony application to PlanetScale](connect-symfony-app.md): In this tutorial, you'll learn how to connect a Symfony application to a PlanetScale MySQL database using a sample Sy... - [PlanetScale CLI commands: connect](connect.md): Make sure to first [set up your PlanetScale developer environment](/docs/cli/planetscale-environment-setup). Once you... - [Connections overview](connecting.md): There are several ways to connect to Postgres databases, each with their advantages and tradeoffs. - [Connection strings](connection-strings.md): To create a password, head to your database dashboard page at` - [CPU Architectures](cpu-architectures.md): When deploying PostgreSQL databases, choosing the right CPU architecture is crucial for optimizing performance, cost,... - [Create a Metal database](create-a-metal-database.md): export const YouTubeEmbed = ({id, title}) => { - [Create a backup](create-backup.md): > - [Create a bouncer](create-bouncer.md): > - [Create a branch](create-branch.md): > - [Create a database](create-database.md): > - [Create an IP restriction entry](create-database-postgres-cidr.md): > - [Create a deploy request](create-deploy-request.md): > - [Create a keyspace](create-keyspace.md): > - [Create or renew an OAuth token](create-oauth-token.md): Create an OAuth token from an authorization grant code, or refresh an OAuth token from a refresh token - [Create an organization team](create-organization-team.md): > - [Create a password](create-password.md): > - [Create a new query patterns report](create-query-patterns-report.md): > - [Create role credentials](create-role.md): > - [Create a service token](create-service-token.md): Create a new service token for the organization. - [Create a webhook](create-webhook.md): > - [Create a workflow](create-workflow.md): > - [PlanetScale Postgres database dashboard](dashboard.md): When you navigate to a database in your PlanetScale organization, you'll see a comprehensive view of your cluster hea... - [Data branching®](data-branching.md): export const VimeoEmbed = ({id, title}) => { - [PlanetScale CLI commands: data-imports](data-imports.md): Make sure to first [set up your PlanetScale developer environment](/docs/cli/planetscale-environment-setup). Once you... - [Data requests](data-requests.md): Some laws require you and your company to allow your end-users to control their personal data. PlanetScale allows you... - [Database Imports](database-imports.md): PlanetScale provides an import tool in the dashboard that allows you to painlessly import an **existing internet-acce... - [PlanetScale CLI commands: database](database.md): Make sure to first [set up your PlanetScale developer environment](/docs/cli/planetscale-environment-setup). Once you... - [Datadog integration](datadog.md): PlanetScale can push metrics to Datadog to assist your team with understanding your database usage and performance. - [Debezium connector for PlanetScale](debezium.md): The Debezium connector for PlanetScale is a connector for [Debezium](https://debezium.io/), an open-source distribute... - [Deleting a database](delete-a-database.md): How to remove a database from PlanetScale. - [Delete a backup](delete-backup.md): > - [Delete a bouncer](delete-bouncer.md): > - [Delete a branch](delete-branch.md): > - [Delete a database](delete-database.md): > - [Delete an IP restriction entry](delete-database-postgres-cidr.md): > - [Delete a keyspace](delete-keyspace.md): > - [Delete an OAuth token](delete-oauth-token.md): > - [Delete an organization team](delete-organization-team.md): > - [Delete a password](delete-password.md): > - [Delete a query patterns report](delete-query-patterns-report.md): > - [Delete role credentials](delete-role.md): > - [Delete a service token](delete-service-token.md): Delete a service token from the organization. - [Delete a webhook](delete-webhook.md): > - [Demote a branch](demote-branch.md): Demotes a branch from production to development - [Deploy a Django app to Heroku](deploy-a-django-app-to-heroku.md): This article will describe how to deploy a Django app to Heroku, which includes the necessary setup in Heroku’s dashb... - [PlanetScale CLI commands: deploy-request](deploy-request.md): Make sure to first [set up your PlanetScale developer environment](/docs/cli/planetscale-environment-setup). Once you... - [Deploy requests](deploy-requests.md): Deploy requests are an integral part of the [PlanetScale workflow](/docs/vitess/best-practices). - [Deploy to Netlify](deploy-to-netlify.md): This guide will walk you through setting up and deploying your PlanetScale database on Netlify. - [Deploy to Vercel](deploy-to-vercel.md): This guide will walk you through setting up and deploying your PlanetScale database on Vercel. - [Deployment options](deployment-options.md): PlanetScale offers two deployment options to accommodate your application and business needs: multi-tenancy and singl... - [Development Environments](development-environments.md): When using development environments, it's important to have a way to work with your database and test schema changes ... - [DigitalOcean database migration guide](digitalocean-database-migration-guide.md): In this article, we’ll walk through migrating a MySQL database from DigitalOcean to PlanetScale using the [Import too... - [Disable safe migrations for a branch](disable-safe-migrations.md): > - [Disk autoscaling](disk-autoscaling.md): Disk autoscaling automatically increases storage when your database approaches a disk size utilization threshold, pre... - [Enable safe migrations for a branch](enable-safe-migrations.md): > - [PlanetScale database error reference](errors.md): This documentation covers some commonly encountered errors and approaches for addressing them. - [PlanetScale Connect](etl.md): PlanetScale Connect is one of the underlying mechanisms we use to transfer data between parties. - [Extensions](extensions.md): PostgreSQL extensions are add-on modules that extend the functionality of your database beyond the core features. The... - [Fivetran integration](fivetran.md): With PlanetScale Connect, you can extract data from your PlanetScale database and safely load it into other destinati... - [Foreign key constraints](foreign-key-constraints.md): A **foreign key** is a logical association of rows between two tables in a parent-child relationship. A row in a “par... - [GCP Cloud SQL Migration Guide](gcp-cloudsql-migration-guide.md): This document will demonstrate how to migrate a database from Google Cloud Platform (GCP) Cloud SQL MySQL Cluster to ... - [Connect privately with GCP Private Service Connect](gcp-private-service-connect.md): When you use GCP Private Service Connect, your network traffic between your VPC and PlanetScale stays within the Goog... - [PlanetScale Managed on GCP overview](gcp.md): PlanetScale Managed on Google Cloud Platform (GCP) is a single-tenant deployment of PlanetScale in your GCP organizat... - [Get a backup](get-backup.md): > - [Get a bouncer](get-bouncer.md): > - [Get a branch](get-branch.md): > - [Get a branch change request](get-branch-change-request.md): > - [Get a branch schema](get-branch-schema.md): > - [Get current user](get-current-user.md): Get the user associated with this service token - [Get a database](get-database.md): > - [Get an IP restriction entry](get-database-postgres-cidr.md): > - [Get database throttler configurations](get-database-throttler.md): > - [Get the default postgres role](get-default-role.md): > - [Get the deploy queue](get-deploy-queue.md): The deploy queue returns the current list of deploy requests in the order they will be deployed. - [Get a deploy request](get-deploy-request.md): > - [Get deploy request throttler configurations](get-deploy-request-throttler.md): > - [Get a deployment](get-deployment.md): Get the deployment for a deploy request - [Get an invoice](get-invoice.md): > - [Get invoice line items](get-invoice-line-items.md): Get the line items for an invoice - [Get a keyspace](get-keyspace.md): > - [Get keyspace rollout status](get-keyspace-rollout-status.md): > - [Get the VSchema for the keyspace](get-keyspace-vschema.md): > - [Get an OAuth application](get-oauth-application.md): > - [Get an OAuth token](get-oauth-token.md): > - [Get an organization](get-organization.md): > - [Get an organization member](get-organization-membership.md): > - [Get an organization team](get-organization-team.md): > - [Get a password](get-password.md): > - [Download a finished query patterns report](get-query-patterns-report.md): > - [Show the status of a query patterns report](get-query-patterns-report-status.md): > - [Get a role](get-role.md): > - [Get a service token](get-service-token.md): Get information about a service token. - [Get a webhook](get-webhook.md): > - [Get a workflow](get-workflow.md): > - [Getting started with PlanetScale API](getting-started-with-planetscale-api.md): Learn how to start using the PlanetScale API. - [Set up PlanetScale Managed in AWS](getting-started.md): The following guide will walk you through setting up a PlanetScale Managed cluster in your Amazon Web Services (AWS) ... - [PlanetScale GitHub Actions](github-actions.md): See our [tech talk on Databases + CI/CD](https://planetscale.com/blog/databases-ci-cd-pipeline) to see pscale + GitHu... - [Handling table and column renames](handling-table-and-column-renames.md): In SQL, it is possible to`RENAME`either a column or a table using an [`ALTER`statement](https://dev.mysql.com/doc/... - [Hightouch integration](hightouch.md): Hightouch is a platform that allows you to sync data between systems using a simple and intuitive UI. - [How Online Schema Change tools work](how-online-schema-change-tools-work.md): Changing a table's schema is one of the most challenging problems in relational databases, and in MySQL in particular... - [How to make different types of schema changes](how-to-make-different-types-of-schema-changes.md): Your database has to grow and change with your application and product. - [How PlanetScale uses AI](how-we-use-ai.md): Which PlanetScale features use generative AI, and how we ensure customer data stays secure and private. - [Import public IP addresses](import-ips.md): When importing a database, you may have IP restrictions in place on your source database and may need to grant a set ... - [Import public IP addresses](import-tool-migration-addresses.md): When importing a database using our [Import tool](/docs/vitess/imports/database-imports), you need to grant a set of ... - [Import user permissions](import-tool-user-requirements.md): When importing a database using our [Import tool](/docs/vitess/imports/database-imports), you will need to connect to... - [Import troubleshooting](import-troubleshooting.md): This guide covers common issues you might run into when importing a database to PlanetScale and how to fix them. - [PlanetScale documentation](index.md): PlanetScale is a relational database platform that brings you scale, performance, and reliability — without sacrifici... - [IP restrictions](ip-restrictions.md): Manage which IP addresses can establish connections to your database. - [PlanetScale CLI commands: keyspace](keyspace.md): Make sure to first [set up your PlanetScale developer environment](/docs/cli/planetscale-environment-setup). Once you... - [What is a keyspace](keyspaces.md): In Vitess, a keyspace is a logical database that maps to one or many MySQL instances. - [Lint a branch schema](lint-branch-schema.md): > - [List audit logs](list-audit-logs.md): > - [List backups](list-backups.md): > - [Get bouncer resize requests](list-bouncer-resize-requests.md): > - [List bouncers](list-bouncers.md): > - [Get bouncer resize requests](list-branch-bouncer-resize-requests.md): > - [Get branch change requests](list-branch-change-requests.md): > - [List branches](list-branches.md): > - [List available cluster sizes](list-cluster-size-skus.md): List available cluster sizes for an organization - [List IP restriction entries](list-database-postgres-cidrs.md): > - [List database regions](list-database-regions.md): > - [List databases](list-databases.md): > - [List deploy operations](list-deploy-operations.md): List deploy operations for a deploy request - [List deploy request reviews](list-deploy-request-reviews.md): > - [List deploy requests](list-deploy-requests.md): List deploy requests for a database - [List cluster extensions](list-extensions.md): > - [List generated query patterns reports](list-generated-query-patterns-reports.md): > - [Get invoices](list-invoices.md): Get the invoices for an organization - [Get keyspaces](list-keyspaces.md): > - [List OAuth applications](list-oauth-applications.md): > - [List OAuth tokens](list-oauth-tokens.md): List OAuth tokens created by an OAuth application - [List organization members](list-organization-members.md): > - [List teams in an organization](list-organization-teams.md): > - [List organizations](list-organizations.md): When using a service token, returns the list of organizations the service token has access to. When using an OAuth to... - [List cluster parameters](list-parameters.md): Returns the parameters for a branch. To update the parameters, use the "Upsert a change request" endpoint. - [List passwords](list-passwords.md): > - [List public regions](list-public-regions.md): Endpoint is available without authentication. - [List read-only regions](list-read-only-regions.md): List read-only regions for the database's default branch - [List regions for an organization](list-regions-for-organization.md): > - [List roles](list-roles.md): > - [List service tokens](list-service-tokens.md): List service tokens for an organization. - [List webhooks](list-webhooks.md): List webhooks for a database - [List workflows](list-workflows.md): > - [Logical replication and Change Data Capture (CDC)](logical-cdc.md): Change Data Capture (CDC) allows you to track and stream data changes from your PostgreSQL database to external syste... - [Cluster Logs](logs.md): The Logs dashboard provides comprehensive logging and debugging capabilities for your PlanetScale Postgres database c... - [Maintenance schedules](maintenance-schedules.md): Enterprise customers have the option to enable scheduled maintenance windows on databases. - [Maintenance windows](maintenance-windows.md): Maintenance windows have been temporarily disabled for PlanetScale Postgres databases. - [PlanetScale Managed overview](managed.md): PlanetScale Managed is a single-tenant deployment of PlanetScale within your Amazon Web Services (AWS) or Google Clou... - [MariaDB migration guide](mariadb-migration-guide.md): In this article, you’ll learn how to migrate a database from MariaDB, a fork of MySQL, into PlanetScale. - [PlanetScale CLI commands: mcp](mcp.md): Make sure to first [set up your PlanetScale developer environment](/docs/cli/planetscale-environment-setup). Once you... - [How to check performance after upgrading to Metal](metal-performance.md): PlanetScale [Metal](/docs/metal) databases offer performance benefits for many types of workloads. - [PlanetScale Metal](metal.md): PlanetScale Metal databases are the same PlanetScale databases you know and love, powered by blazing-fast, locally-at... - [Cluster Metrics](metrics.md): The Metrics dashboard provides comprehensive monitoring and observability for your PostgreSQL database cluster. - [Multi-factor authentication](multi-factor-authentication.md): Multi-factor authentication (MFA) provides better safety for your databases and prevents unauthorized access to your ... - [MySQL compatibility](mysql-compatibility.md): PlanetScale's Vitess product is built on top of open-source Vitess, a database clustering system for horizontal scali... - [Using the Neon serverless driver](neon-serverless-driver.md): PlanetScale supports connections via the [Neon serverless driver](https://neon.com/docs/serverless/serverless-driver). - [Migrate from Neon to PlanetScale](neon.md): Use this guide to migrate an existing Neon database to PlanetScale Postgres. - [Network latency](network-latency.md): When connecting to PlanetScale, it's important to understand how network latency can impact query speed. - [Deploy to Vercel](nextjs-deploy-to-vercel.md): This guide will walk you through setting up and deploying your PlanetScale database on Vercel. - [Next.js and PlanetScale Netlify template tutorial](nextjs-planetscale-netlify-template.md): This guide will show you how to get up and running with the [Netlify, Next.js, and PlanetScale starter template](http... - [OAuth access scopes](oauth-access-scopes.md): The full list of OAuth application access scopes. - [OAuth](oauth.md): Using PlanetScale OAuth enables your users to connect their accounts to PlanetScale. - [Comparison of Online Schema Change tools](online-schema-change-tools-comparison.md): Online Schema Change tools for MySQL [share a similar basic design](/docs/vitess/schema-changes/how-online-schema-cha... - [Online DDL change unique keys](onlineddl-change-unique-keys.md): It is possible to modify or replace a table's`PRIMARY KEY`, or any other`UNIQUE KEY`s according to the limitation d... - [OpenAPI Spec](openapi-spec.md): Download the PlanetScale API OpenAPI 3.0 specification - [Operating without foreign key constraints](operating-without-foreign-key-constraints.md): A **foreign key** is a logical association of rows between two tables, in a parent-child relationship. - [PlanetScale Postgres operations philosophy](operations-philosophy.md): PlanetScale has a high standard for uptime and availability of Postgres databases. - [PlanetScale CLI commands: org](org.md): Make sure to first [set up your PlanetScale developer environment](/docs/cli/planetscale-environment-setup). Once you... - [Pagination](pagination.md): How to paginate API responses - [Cluster configuration parameters](parameters.md): You can configure your PlanetScale Postgres cluster settings in the "**Parameters**" tab on the Clusters page for you... - [Password roles](password-roles.md): PlanetScale allows you to [create and manage passwords](/docs/vitess/connecting/connection-strings) for each branch o... - [PlanetScale CLI commands: password](password.md): Make sure to first [set up your PlanetScale developer environment](/docs/cli/planetscale-environment-setup). Once you... - [Extensions: pg_cron](pg-cron.md): pg_cron is a simple cron-based job scheduler for PostgreSQL. It allows you to run SQL commands on a schedule, similar... - [Extensions: pg_duckdb](pg-duckdb.md): pg_duckdb is a Postgres extension that embeds DuckDB, a high-performance analytical database, directly into Postgres. - [Extensions: pg_hint_plan](pg-hint-plan.md): The pg_hint_plan extension allows you to influence the query planner's decisions by providing hints. It can be used t... - [Extensions: pg_partman_bgw](pg-partman-bgw.md): The pg_partman_bgw extension is a background worker for managing partitioned tables in PostgreSQL. It automates the c... - [Extensions: pg_squeeze](pg-squeeze.md): pg_squeeze automatically cleans up unused space in tables (table bloat). pg_squeeze helps maintain optimal table perf... - [Extensions: pg_stat_statements](pg-stat-statements.md): pg_state_statements is a PostgreSQL extension that tracks execution statistics of all SQL statements executed by a se... - [PgBouncer](pgbouncer.md): PgBouncer provides connection pooling for your Postgres database. - [Extensions: pginsights](pginsights.md): The pginsights extension is a PlanetScale Insights plugin that provides query performance monitoring and analysis cap... - [PlanetScale CLI commands: ping](ping.md): Make sure to first [set up your PlanetScale developer environment](/docs/cli/planetscale-environment-setup). Once you... - [PlanetScale API and OAuth applications](planetscale-api-oauth-applications.md): The PlanetScale API allows you to manage your PlanetScale databases programmatically. - [PlanetScale environment set up](planetscale-environment-setup.md): To install the PlanetScale CLI on macOS, we recommend using Homebrew. - [PlanetScale plans](planetscale-plans.md): PlanetScale is built to accommodate all companies at all stages. Whether you need a hassle-free managed database for ... - [PlanetScale Postgres with Bun](planetscale-postgres-bun.md): Create a new Postgres database and integrate it with Bun. - [PlanetScale Postgres with Drizzle](planetscale-postgres-drizzle.md): Create a new Postgres database and integrate it with Drizzle. - [PlanetScale Postgres with Kysely](planetscale-postgres-kysely.md): Create a new Postgres database and integrate it with Kysely. - [PlanetScale Postgres with Node.js](planetscale-postgres-node.md): Create a new Postgres database and integrate it with Node.js. - [PlanetScale Postgres with Prisma](planetscale-postgres-prisma.md): Create a new Postgres database and integrate it with Prisma. - [PlanetScale Postgres quickstart](planetscale-postgres-quickstart.md): This guide will walk you through how to create a new PlanetScale Postgres database. - [PlanetScale quickstart guide](planetscale-quick-start-guide.md): export const VimeoEmbed = ({id, title}) => { - [Node.js example using the PlanetScale serverless driver](planetscale-serverless-driver-node-example.md): This guide will cover how to use the provided Node.js sample application using the PlanetScale serverless driver for ... - [Using the PlanetScale serverless driver with Prisma](planetscale-serverless-driver-prisma-example.md): This document outlines how you can use the [PlanetScale serverless driver](/docs/vitess/tutorials/planetscale-serverl... - [PlanetScale serverless driver for JavaScript](planetscale-serverless-driver.md): Before learning how to use the PlanetScale serverless driver for JavaScript, it’s worth understanding why you should ... - [Cluster sizes](planetscale-skus.md): Here you'll find a complete list of all the database sizes available to you on PlanetScale. - [Vitess system limits](planetscale-system-limits.md): We can sometimes manually adjust limits on a per-database level. If you are facing issues or have questions, the best... - [Point-in-time recovery](point-in-time-recovery.md): Point-in-time recovery (PITR) allows you to restore your PlanetScale Postgres database to any specific moment within ... - [PlanetScale Postgres architecture](postgres-architecture.md): PlanetScale Postgres is a managed PostgreSQL service built on modern cloud infrastructure. - [Postgres Imports](postgres-imports.md): For customers looking to migrate their Postgres databases to PlanetScale Postgres, you have several options for how t... - [Postgres Imports - Amazon DMS](postgres-migrate-dms.md): [Amazon Database Migration Service (DMS)](https://aws.amazon.com/dms/) provides a managed migration service that can ... - [Postgres Imports - PGDump and Restore](postgres-migrate-dumprestore.md): The [pg\_dump](https://www.postgresql.org/docs/current/app-pgdump.html) and restore method is the simplest approach f... - [Postgres Imports - WAL Streaming](postgres-migrate-walstream.md): [Write-Ahead Logging (WAL)](https://www.postgresql.org/docs/current/wal-intro.html) streaming provides a near-zero do... - [Postgres to MySQL to PlanetScale migration guide](postgres-mysql-planetscale-migration-guide.md): **PlanetScale now supports Postgres**. This guide is for migrating from Postgres to PlanetScale's Vitess product. You... - [Postgres to PlanetScale for Vitess migration guide](postgres-planetscale-migration-guide.md): **PlanetScale now supports Postgres**. This guide is for migrating from Postgres to PlanetScale's Vitess product. You... - [Postgres vs Vitess](postgres-vs-vitess.md): Compare PlanetScale's Postgres and Vitess products to choose the best fit for your application - [PlanetScale Postgres](postgres.md): PlanetScale Postgres is a fully-managed PostgreSQL-compatible database that brings you scale, performance, and reliab... - [Pre-sharding checklist](pre-sharding-checklist.md): When you begin a new [unsharded to sharded workflow](/docs/vitess/sharding/sharding-quickstart), there are a number o... - [PlanetScale Postgres pricing](pricing.md): PlanetScale Postgres databases are billed based on their configuration and usage. - [Prisma best practices](prisma-best-practices.md): This document provides various best practices for getting the most out of Prisma, a next-generation ORM for Node.js a... - [Using the PlanetScale serverless driver with Prisma](prisma-example.md): This document outlines how you can use the [PlanetScale serverless driver](/docs/vitess/tutorials/planetscale-serverl... - [Connecting to PlanetScale privately on GCP](private-connections-gcp.md): When your compliance mandates that your connections do not route through the public Internet, PlanetScale provides pr... - [Connecting to PlanetScale privately on AWS](private-connections.md): When your compliance mandates that your connections do not route through the public Internet, PlanetScale provides pr... - [Set up GCP Private Service Connect with PlanetScale Managed](private-service-connect.md): PlanetScale Managed can connect you to your databases via [GCP Private Service Connect](https://cloud.google.com/vpc/... - [Set up AWS PrivateLink with PlanetScale Managed](privatelink.md): PlanetScale Managed can connect you to your databases via [AWS PrivateLink](https://aws.amazon.com/privatelink/). The... - [Sending Prometheus Metrics to Datadog for PlanetScale Postgres](prometheus-metrics-datadog-postgres.md): If you're looking for more metrics than PlanetScale's native Datadog integration provides, this tutorial will show ho... - [Sending Prometheus Metrics to Datadog](prometheus-metrics-datadog.md): If you're looking for more metrics than PlanetScale's native Datadog integration provides, this tutorial will show ho... - [Grafana Dashboard for PlanetScale Branches](prometheus-metrics-grafana.md): In this tutorial, you'll learn how to set up Grafana and connect it to a Prometheus instance to see metrics about you... - [Sending Prometheus Metrics to New Relic](prometheus-metrics-newrelic.md): If you're looking for your PlanetScale database metrics in your New Relic account, this tutorial will show how to con... - [Prometheus metrics for PlanetScale Postgres](prometheus-metrics-postgres.md): PlanetScale Postgres exposes a Prometheus-compatible endpoint per-branch that allows you to scrape metrics for your d... - [Prometheus metrics](prometheus-metrics.md): PlanetScale exposes a Prometheus-compatible endpoint per-branch that allows you to scrape metrics for your database. - [Prometheus integration for PlanetScale Postgres](prometheus-postgres.md): PlanetScale Postgres exposes Prometheus-compatible metrics endpoints for scraping metrics about your database branche... - [Prometheus](prometheus.md): PlanetScale exposes Prometheus-compatible metrics endpoints for scraping metrics about your database branches. This, ... - [Promote a branch](promote-branch.md): Promotes a branch from development to production - [The proof of concept phase of an enterprise contract](proof-of-concept.md): We get many customers that come to us with existing large, production databases. - [Query Insights](query-insights.md): PlanetScale Insights gives you a detailed look into **all active queries** running against your database. - [Queue a deploy request](queue-deploy-request.md): > - [Connections quickstart](quickstart.md): PlanetScale Postgres works with any standard PostgreSQL driver or library that supports SSL connections. - [Rate limits](rate-limits.md): The current rate limit on the PlanetScale API is 600 requests per minute. This rate limit is subject to change based ... - [Read-only mode](read-only-mode.md): PlanetScale may automatically enable read-only mode on a cluster to maintain stability and availability when certain ... - [Read-only regions](read-only-regions.md): Replicate your production database across the globe by creating read-only regions in any available [PlanetScale regio... - [Reassign objects owned by one role to another role](reassign-role-objects.md): > - [Vector type and index reference](reference.md): PlanetScale MySQL provides a`VECTOR(X)`type that can be used to store vectors. - [PlanetScale CLI commands: region](region.md): Make sure to first [set up your PlanetScale developer environment](/docs/cli/planetscale-environment-setup). Once you... - [Regions](regions.md): PlanetScale currently offers database deployment in multiple regions. Select the region closest to your application s... - [Remove a member from an organization](remove-organization-member.md): > - [Renew a password](renew-password.md): > - [Renew role expiration](renew-role.md): > - [Database replicas](replicas.md): A replica is a continuously updated copy of your Postgres database. - [Reset default credentials](reset-default-role.md): > - [Reset a role's password](reset-role.md): > - [Set up AWS Reverse PrivateLink with PlanetScale Managed](reverse-privatelink.md): [PlanetScale Managed](/docs/vitess/managed/aws) can connect to your existing databases via AWS PrivateLink for the pu... - [Review a deploy request](review-deploy-request.md): Review a deploy request by either approving or commenting on the deploy request - [PlanetScale CLI commands: role](role.md): Make sure to first [set up your PlanetScale developer environment](/docs/cli/planetscale-environment-setup). Once you... - [Managing Roles for your Postgres database](roles.md): When you connect to your database, you have the option to connect with the default role or a user-generated role. Thi... - [Safe migrations](safe-migrations.md): Safe migrations is an optional but highly recommended feature for branches in PlanetScale. With safe migrations enabl... - [Exploring Enterprise - the sales process](sales-process.md): In an effort to make the process as smooth and quick as possible for you, we've outlined what the typical sales proce... - [Sample OAuth application](sample-oauth-application.md): This sample OAuth application shows how to implement OAuth authentication with PlanetScale in a Next.js application. - [Non-blocking schema changes](schema-changes.md): **Non-blocking schema changes** in PlanetScale provide a schema change workflow that allows users to update database ... - [Schema recommendations](schema-recommendations.md): With schema recommendations inside of [PlanetScale Insights](/docs/postgres/monitoring/query-insights), you will auto... - [Schema snapshots](schema-snapshots.md): Snapshots of database schemas within PlanetScale Managed accounts are transferred to PlanetScale's control plane to f... - [Connecting to PlanetScale securely](secure-connections.md): When you are using passwords to connect to PlanetScale, it is essential to correctly validate the server side certifi... - [Security log](security-log.md): The Security log gives you insight into recent authentication and other security-related`actions`for your account. ... - [Security and compliance](security.md): PlanetScale is committed to delivering a powerful and easy-to-use database platform while keeping your data secure. - [Sequence Tables](sequence-tables.md): In MySQL, it is common to have an integer primary key that uses the`AUTO_INCREMENT`feature for assigning IDs. - [PlanetScale CLI commands: service-token](service-token.md): Make sure to first [set up your PlanetScale developer environment](/docs/cli/planetscale-environment-setup). Once you... - [Service tokens](service-tokens.md): Using service tokens with the PlanetScale API. - [Settings](settings.md): The Settings page allows you to configure general settings and options for your PlanetScale Postgres database. - [Workflow: Sharded to sharded keyspace](sharding-a-sharded-keyspace.md): This tutorial covers how to adjust the number of shards in a sharded keyspace. This may become necessary if your shar... - [Sharding new tables](sharding-new-tables.md): This tutorial shows you how to create new tables in a sharded keyspace. If you have an existing table that you want t... - [Workflow: Unsharded to sharded keyspace](sharding-quickstart.md): This tutorial covers how to shard **existing tables** in your PlanetScale database. This is done using the unsharded ... - [Sharding workflow state reference](sharding-workflow-state-reference.md): This document can be used as reference when going through the [Sharding quickstart](/docs/vitess/sharding/sharding-qu... - [Sharding with PlanetScale](sharding.md): You can create sharded keyspaces on any plan by adding a new sharded keyspace using the [Clusters page](/docs/vitess/... - [PlanetScale CLI commands: shell](shell.md): Make sure to first [set up your PlanetScale developer environment](/docs/cli/planetscale-environment-setup). Once you... - [PlanetScale CLI commands: signup](signup.md): Make sure to first [set up your PlanetScale developer environment](/docs/cli/planetscale-environment-setup). Once you... - [Single node](single-node.md): Single node Postgres databases come with a single primary and no replicas, and are a great cost-effective option for ... - [PlanetScale CLI commands: size](size.md): Lists the sizes for various components within PlanetScale. - [Skip revert period](skip-revert-period.md): Skips the revert period for a deploy request - [Single sign-on](sso.md): Single sign-on (SSO) provides additional account security by allowing company administrators to require the use of an... - [Stitch integration](stitch.md): With PlanetScale Connect, you can extract data from your PlanetScale database and safely load it into other destinati... - [Strategies for maintaining referential integrity](strategies-for-maintaining-referential-integrity.md): If you choose to not use foreign key constraints, cascading actions need to be addressed via code instead of letting ... - [Migrate from Supabase to PlanetScale](supabase.md): Use this guide to migrate an existing Supabase database to PlanetScale Postgres. - [PlanetScale Support](support.md): PlanetScale’s team has a combined 600 years of experience running databases at scale. - [Targeting the correct keyspace](targeting-correct-keyspace.md): Once you have more than one keyspace, with tables distributed across both keyspaces, your application may not know ho... - [Teams](teams.md): PlanetScale allows you to create teams within organizations. - [Vector database terminology and concepts](terminology-and-concepts.md): There are many concepts, algorithms and data structures that are used when discussing vector databases. - [PlanetScale terminology](terminology.md): Here we provide definitions for technologies and concepts you will see throughout our documentation and product. Some... - [Test a webhook](test-webhook.md): Sends a test event to the webhook - [Throttling deploy requests](throttling-deploy-requests.md): Deploy requests, though non-blocking, do of course consume some resources as the online schema change process occurs.... - [Extensions: TimescaleDB](timescaledb.md): TimescaleDB is a time-series database for high-performance real-time analytics packaged as a Postgres extension. - [Update auto-apply for deploy request](update-auto-apply.md): Enables or disabled the auto-apply setting for a deploy request - [Update auto-delete branch for deploy request](update-auto-delete-branch.md): Enables or disabled the auto-delete branch setting for a deploy request - [Update a backup](update-backup.md): > - [Upsert a bouncer resize request](update-bouncer-resize-request.md): > - [Upsert a change request](update-branch-change-request.md): > - [Change a branch cluster configuration](update-branch-cluster-config.md): > - [Update an IP restriction entry](update-database-postgres-cidr.md): > - [Update database settings](update-database-settings.md): > - [Update database throttler configurations](update-database-throttler.md): > - [Update deploy request throttler configurations](update-deploy-request-throttler.md): > - [Configure keyspace settings](update-keyspace.md): > - [Update the VSchema for the keyspace](update-keyspace-vschema.md): > - [Update an organization](update-organization.md): > - [Update organization member role](update-organization-membership.md): > - [Update an organization team](update-organization-team.md): > - [Update a password](update-password.md): > - [Update role name](update-role.md): > - [Update a webhook](update-webhook.md): > - [Cluster updates](updates.md): PlanetScale occasionally releases software updates for your Postgres cluster. - [Common use cases for Vector search](use-cases.md): The ability to store and search vector data in your MySQL database, right alongside the rest of your relational data,... - [User management](user-management.md): The customer's initial administrative user creates an organization on PlanetScale. Administrative accounts have the`... - [Using PlanetScale with Prisma](using-planetscale-with-prisma.md): [Prisma](https://www.prisma.io/) ORM provides type-safe database access through an intuitive API, eliminating the nee... - [Vectors with an ORM](using-with-an-orm.md): Many modern web development frameworks provide ORMs to make mapping data between your database and the objects in you... - [Vantage integration](vantage.md): With [Vantage](https://www.vantage.sh/), you can set up [PlanetScale cost management](https://vantage.sh/integrations... - [Vector search and storage](vectors.md): Vectors are a data structure that captures opaque semantic meaning about something and allows a database to search fo... - [Verify workflow data](verify-workflow.md): > - [Supported versions](versions.md): When creating a PlanetScale Postgres cluster, you can choose from any of the Postgres versions we support. - [Vindexes](vindexes.md): When configuring a horizontally [sharded](/docs/vitess/sharding) keyspace, one of the most important decisions to mak... - [PlanetScale for Vitess](vitess.md): [Vitess](https://vitess.io) is a battle-hardened open source technology invented at YouTube for deploying, scaling, a... - [VSchema](vschema.md): PlanetScale databases are powered by Vitess. - [VTGates](vtgates.md): A VTGate, or Vitess Gateway, is the layer of Vitess that acts as a proxy between your application servers and the MyS... - [Vulnerability disclosure](vulnerability-disclosure.md): PlanetScale is actively seeking vulnerability reports for the following components that make up the product and its P... - [Web console](web-console.md): The PlanetScale web console is an interactive interface for running MySQL queries and DDL (Create, Alter, and Delete)... - [Webhook events reference](webhook-events.md): Webhooks in PlanetScale allow you to trigger an HTTP POST callback to a configured URL when specific events happen wi... - [PlanetScale CLI commands: webhook](webhook.md): Make sure to first [set up your PlanetScale developer environment](/docs/cli/planetscale-environment-setup). Once you... - [Webhooks](webhooks.md): With a webhook in PlanetScale, you can trigger an HTTP POST callback to a configured URL when a specific event occurs... - [What is PlanetScale?](what-is-planetscale.md): export const VimeoEmbed = ({id, title}) => { - [PlanetScale CLI commands: workflow](workflow.md): Make sure to first [set up your PlanetScale developer environment](/docs/cli/planetscale-environment-setup). Once you... - [Cancel a workflow](workflow-cancel.md): > - [Complete a workflow](workflow-complete.md): > - [Cutover traffic](workflow-cutover.md): > - [Retry a failed workflow](workflow-retry.md): > - [Reverse traffic cutover](workflow-reverse-cutover.md): > - [Reverse traffic](workflow-reverse-traffic.md): > - [Switch primary traffic](workflow-switch-primaries.md): > - [Switch replica traffic](workflow-switch-replicas.md): > - [What are workflows?](workflows.md): PlanetScale workflows provide pre-defined recipes that make it simple to run operations on your databases.