# PlanetScale ## Docs - [OpenAPI Spec](https://planetscale.com/docs/api/openapi-spec.md): Download the PlanetScale API OpenAPI 3.0 specification - [PlanetScale API and OAuth applications](https://planetscale.com/docs/api/planetscale-api-oauth-applications.md): The PlanetScale API allows you to manage your PlanetScale databases programmatically. - [Add a member to a team](https://planetscale.com/docs/api/reference/add_organization_team_member.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Cancel a resize request](https://planetscale.com/docs/api/reference/cancel_bouncer_resize_request.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Cancel a change request](https://planetscale.com/docs/api/reference/cancel_branch_change_request.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Cancel a queued deploy request](https://planetscale.com/docs/api/reference/cancel_deploy_request.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Close a deploy request](https://planetscale.com/docs/api/reference/close_deploy_request.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Complete an errored deploy](https://planetscale.com/docs/api/reference/complete_errored_deploy.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Complete a gated deploy request](https://planetscale.com/docs/api/reference/complete_gated_deploy_request.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Complete a revert](https://planetscale.com/docs/api/reference/complete_revert.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Create a backup](https://planetscale.com/docs/api/reference/create_backup.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Create a bouncer](https://planetscale.com/docs/api/reference/create_bouncer.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Create a branch](https://planetscale.com/docs/api/reference/create_branch.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Create a database](https://planetscale.com/docs/api/reference/create_database.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Create an IP restriction entry](https://planetscale.com/docs/api/reference/create_database_postgres_cidr.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Create a deploy request](https://planetscale.com/docs/api/reference/create_deploy_request.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Create a keyspace](https://planetscale.com/docs/api/reference/create_keyspace.md): ### Authorization A service token must have at least one of the following access in order to use this API endpoint: - [Create or renew an OAuth token](https://planetscale.com/docs/api/reference/create_oauth_token.md): Create an OAuth token from an authorization grant code, or refresh an OAuth token from a refresh token ### Authorization A service token must have at least one of the following access in order to use this API endpoint: - [Create an organization team](https://planetscale.com/docs/api/reference/create_organization_team.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Create a password](https://planetscale.com/docs/api/reference/create_password.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Create a new query patterns report](https://planetscale.com/docs/api/reference/create_query_patterns_report.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Create role credentials](https://planetscale.com/docs/api/reference/create_role.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Create a service token](https://planetscale.com/docs/api/reference/create_service_token.md): Create a new service token for the organization. ### Authorization A service token must have at least one of the following access in order to use this API endpoint: - [Create a webhook](https://planetscale.com/docs/api/reference/create_webhook.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Create a workflow](https://planetscale.com/docs/api/reference/create_workflow.md) - [Delete a backup](https://planetscale.com/docs/api/reference/delete_backup.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Delete a bouncer](https://planetscale.com/docs/api/reference/delete_bouncer.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Delete a branch](https://planetscale.com/docs/api/reference/delete_branch.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Delete a database](https://planetscale.com/docs/api/reference/delete_database.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Delete an IP restriction entry](https://planetscale.com/docs/api/reference/delete_database_postgres_cidr.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Delete a keyspace](https://planetscale.com/docs/api/reference/delete_keyspace.md): ### Authorization A service token must have at least one of the following access in order to use this API endpoint: - [Delete an OAuth token](https://planetscale.com/docs/api/reference/delete_oauth_token.md): ### Authorization A service token must have at least one of the following access in order to use this API endpoint: - [Delete an organization team](https://planetscale.com/docs/api/reference/delete_organization_team.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Delete a password](https://planetscale.com/docs/api/reference/delete_password.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Delete a query patterns report](https://planetscale.com/docs/api/reference/delete_query_patterns_report.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Delete role credentials](https://planetscale.com/docs/api/reference/delete_role.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Delete a service token](https://planetscale.com/docs/api/reference/delete_service_token.md): Delete a service token from the organization. ### Authorization A service token must have at least one of the following access in order to use this API endpoint: - [Delete a webhook](https://planetscale.com/docs/api/reference/delete_webhook.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Demote a branch](https://planetscale.com/docs/api/reference/demote_branch.md): Demotes a branch from production to development ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [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): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [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): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Get a bouncer](https://planetscale.com/docs/api/reference/get_bouncer.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Get a branch](https://planetscale.com/docs/api/reference/get_branch.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Get a branch change request](https://planetscale.com/docs/api/reference/get_branch_change_request.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Get a branch schema](https://planetscale.com/docs/api/reference/get_branch_schema.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Get current user](https://planetscale.com/docs/api/reference/get_current_user.md): Get the user associated with this service token ### Authorization A OAuth token must have at least one of the following scopes in order to use this API endpoint: - [Get a database](https://planetscale.com/docs/api/reference/get_database.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Get an IP restriction entry](https://planetscale.com/docs/api/reference/get_database_postgres_cidr.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Get database throttler configurations](https://planetscale.com/docs/api/reference/get_database_throttler.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Get the default postgres role](https://planetscale.com/docs/api/reference/get_default_role.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Get the deploy queue](https://planetscale.com/docs/api/reference/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](https://planetscale.com/docs/api/reference/get_deploy_request.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Get deploy request throttler configurations](https://planetscale.com/docs/api/reference/get_deploy_request_throttler.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Get a deployment](https://planetscale.com/docs/api/reference/get_deployment.md): Get the deployment for a deploy request ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Get an invoice](https://planetscale.com/docs/api/reference/get_invoice.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Get invoice line items](https://planetscale.com/docs/api/reference/get_invoice_line_items.md): Get the line items for an invoice ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Get a keyspace](https://planetscale.com/docs/api/reference/get_keyspace.md): ### Authorization A service token must have at least one of the following access in order to use this API endpoint: - [Get keyspace rollout status](https://planetscale.com/docs/api/reference/get_keyspace_rollout_status.md): ### Authorization A service token must have at least one of the following access in order to use this API endpoint: - [Get the VSchema for the keyspace](https://planetscale.com/docs/api/reference/get_keyspace_vschema.md): ### Authorization A service token must have at least one of the following access in order to use this API endpoint: - [Get an OAuth application](https://planetscale.com/docs/api/reference/get_oauth_application.md): ### Authorization A service token must have at least one of the following access in order to use this API endpoint: - [Get an OAuth token](https://planetscale.com/docs/api/reference/get_oauth_token.md): ### Authorization A service token must have at least one of the following access in order to use this API endpoint: - [Get an organization](https://planetscale.com/docs/api/reference/get_organization.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Get an organization member](https://planetscale.com/docs/api/reference/get_organization_membership.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Get an organization team](https://planetscale.com/docs/api/reference/get_organization_team.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Get a team member](https://planetscale.com/docs/api/reference/get_organization_team_member.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Get a password](https://planetscale.com/docs/api/reference/get_password.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Download a finished query patterns report](https://planetscale.com/docs/api/reference/get_query_patterns_report.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Show the status of a query patterns report](https://planetscale.com/docs/api/reference/get_query_patterns_report_status.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Get a role](https://planetscale.com/docs/api/reference/get_role.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Get a schema recommendation](https://planetscale.com/docs/api/reference/get_schema_recommendation.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Get a service token](https://planetscale.com/docs/api/reference/get_service_token.md): Get information about a service token. ### Authorization A service token must have at least one of the following access in order to use this API endpoint: - [Get a webhook](https://planetscale.com/docs/api/reference/get_webhook.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [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): Learn how to start using the PlanetScale API. - [Lint a branch schema](https://planetscale.com/docs/api/reference/lint_branch_schema.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [List audit logs](https://planetscale.com/docs/api/reference/list_audit_logs.md): ### Authorization A service token must have at least one of the following access in order to use this API endpoint: - [List backups](https://planetscale.com/docs/api/reference/list_backups.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Get bouncer resize requests](https://planetscale.com/docs/api/reference/list_bouncer_resize_requests.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [List bouncers](https://planetscale.com/docs/api/reference/list_bouncers.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Get bouncer resize requests](https://planetscale.com/docs/api/reference/list_branch_bouncer_resize_requests.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Get branch change requests](https://planetscale.com/docs/api/reference/list_branch_change_requests.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [List branches](https://planetscale.com/docs/api/reference/list_branches.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [List available cluster sizes](https://planetscale.com/docs/api/reference/list_cluster_size_skus.md): List available cluster sizes for an organization ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [List IP restriction entries](https://planetscale.com/docs/api/reference/list_database_postgres_cidrs.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [List database regions](https://planetscale.com/docs/api/reference/list_database_regions.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [List databases](https://planetscale.com/docs/api/reference/list_databases.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [List deploy operations](https://planetscale.com/docs/api/reference/list_deploy_operations.md): List deploy operations for a deploy request ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [List deploy request reviews](https://planetscale.com/docs/api/reference/list_deploy_request_reviews.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [List deploy requests](https://planetscale.com/docs/api/reference/list_deploy_requests.md): List deploy requests for a database ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [List cluster extensions](https://planetscale.com/docs/api/reference/list_extensions.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [List generated query patterns reports](https://planetscale.com/docs/api/reference/list_generated_query_patterns_reports.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Get invoices](https://planetscale.com/docs/api/reference/list_invoices.md): Get the invoices for an organization ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Get keyspaces](https://planetscale.com/docs/api/reference/list_keyspaces.md): ### Authorization A service token must have at least one of the following access in order to use this API endpoint: - [List OAuth applications](https://planetscale.com/docs/api/reference/list_oauth_applications.md): ### Authorization A service token must have at least one of the following access in order to use this API endpoint: - [List organization members](https://planetscale.com/docs/api/reference/list_organization_members.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [List team members](https://planetscale.com/docs/api/reference/list_organization_team_members.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [List teams in an organization](https://planetscale.com/docs/api/reference/list_organization_teams.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [List organizations](https://planetscale.com/docs/api/reference/list_organizations.md): When using a service token, returns the list of organizations the service token has access to. When using an OAuth token, returns the list of organizations the user has access to. ### Authorization A OAuth token must have at least one of the following scopes in order to use this API endpoint: - [List cluster parameters](https://planetscale.com/docs/api/reference/list_parameters.md): Returns the parameters for a branch. To update the parameters, use the "Upsert a change request" endpoint. - [List passwords](https://planetscale.com/docs/api/reference/list_passwords.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [List public regions](https://planetscale.com/docs/api/reference/list_public_regions.md): Endpoint is available without authentication. - [List read-only regions](https://planetscale.com/docs/api/reference/list_read_only_regions.md): List read-only regions for the database's default branch ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [List regions for an organization](https://planetscale.com/docs/api/reference/list_regions_for_organization.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [List roles](https://planetscale.com/docs/api/reference/list_roles.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [List schema recommendations](https://planetscale.com/docs/api/reference/list_schema_recommendations.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [List service tokens](https://planetscale.com/docs/api/reference/list_service_tokens.md): List service tokens for an organization. ### Authorization A service token must have at least one of the following access in order to use this API endpoint: - [List webhooks](https://planetscale.com/docs/api/reference/list_webhooks.md): List webhooks for a database ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [List workflows](https://planetscale.com/docs/api/reference/list_workflows.md) - [OAuth](https://planetscale.com/docs/api/reference/oauth.md): Using PlanetScale OAuth enables your users to connect their accounts to PlanetScale. - [OAuth access scopes](https://planetscale.com/docs/api/reference/oauth-access-scopes.md): The full list of OAuth application access scopes. - [Create or refresh OAuth token](https://planetscale.com/docs/api/reference/oauth/create-token.md): Exchange an authorization code for an access token or refresh an expired token - [Revoke OAuth token](https://planetscale.com/docs/api/reference/oauth/revoke-token.md): Revoke an OAuth access token or refresh token - [Get OAuth token info](https://planetscale.com/docs/api/reference/oauth/token-info.md): Retrieve information about the current OAuth access token - [Pagination](https://planetscale.com/docs/api/reference/pagination.md): How to paginate API responses - [Promote a branch](https://planetscale.com/docs/api/reference/promote_branch.md): Promotes a branch from development to production ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Queue a deploy request](https://planetscale.com/docs/api/reference/queue_deploy_request.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Rate limits](https://planetscale.com/docs/api/reference/rate-limits.md): The current rate limit on the PlanetScale API is 600 requests per minute. This rate limit is subject to change. - [Reassign objects owned by one role to another role](https://planetscale.com/docs/api/reference/reassign_role_objects.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Remove a member from an organization](https://planetscale.com/docs/api/reference/remove_organization_member.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Remove a member from a team](https://planetscale.com/docs/api/reference/remove_organization_team_member.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Renew a password](https://planetscale.com/docs/api/reference/renew_password.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Renew role expiration](https://planetscale.com/docs/api/reference/renew_role.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Reset default credentials](https://planetscale.com/docs/api/reference/reset_default_role.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Reset a role's password](https://planetscale.com/docs/api/reference/reset_role.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Review a deploy request](https://planetscale.com/docs/api/reference/review_deploy_request.md): Review a deploy request by either approving or commenting on the deploy request ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Sample OAuth application](https://planetscale.com/docs/api/reference/sample-oauth-application.md): This sample OAuth application shows how to implement OAuth authentication with PlanetScale in a Next.js application. - [Service tokens](https://planetscale.com/docs/api/reference/service-tokens.md): Using service tokens with the PlanetScale API. - [Skip revert period](https://planetscale.com/docs/api/reference/skip_revert_period.md): Skips the revert period for a deploy request ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Test a webhook](https://planetscale.com/docs/api/reference/test_webhook.md): Sends a test event to the webhook ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Update auto-apply for deploy request](https://planetscale.com/docs/api/reference/update_auto_apply.md): Enables or disabled the auto-apply setting for a deploy request ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Update auto-delete branch for deploy request](https://planetscale.com/docs/api/reference/update_auto_delete_branch.md): Enables or disabled the auto-delete branch setting for a deploy request ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Update a backup](https://planetscale.com/docs/api/reference/update_backup.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Upsert a bouncer resize request](https://planetscale.com/docs/api/reference/update_bouncer_resize_request.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Update a branch](https://planetscale.com/docs/api/reference/update_branch.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Upsert a change request](https://planetscale.com/docs/api/reference/update_branch_change_request.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Change a branch cluster configuration](https://planetscale.com/docs/api/reference/update_branch_cluster_config.md): ### Authorization A service token must have at least one of the following access in order to use this API endpoint: - [Update an IP restriction entry](https://planetscale.com/docs/api/reference/update_database_postgres_cidr.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Update database settings](https://planetscale.com/docs/api/reference/update_database_settings.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Update database throttler configurations](https://planetscale.com/docs/api/reference/update_database_throttler.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Update deploy request throttler configurations](https://planetscale.com/docs/api/reference/update_deploy_request_throttler.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Configure keyspace settings](https://planetscale.com/docs/api/reference/update_keyspace.md): ### Authorization A service token must have at least one of the following access in order to use this API endpoint: - [Update the VSchema for the keyspace](https://planetscale.com/docs/api/reference/update_keyspace_vschema.md): ### Authorization A service token must have at least one of the following access in order to use this API endpoint: - [Update an organization](https://planetscale.com/docs/api/reference/update_organization.md): ### Authorization A OAuth token must have at least one of the following scopes in order to use this API endpoint: - [Update organization member role](https://planetscale.com/docs/api/reference/update_organization_membership.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Update an organization team](https://planetscale.com/docs/api/reference/update_organization_team.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Update a password](https://planetscale.com/docs/api/reference/update_password.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Update role name](https://planetscale.com/docs/api/reference/update_role.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Update a webhook](https://planetscale.com/docs/api/reference/update_webhook.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [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): PlanetScale provides the ability to create service tokens for your PlanetScale organization via the CLI or directly in the UI. - [Webhook events reference](https://planetscale.com/docs/api/webhook-events.md): Webhooks in PlanetScale allow you to trigger an HTTP POST callback to a configured URL when specific events happen within your PlanetScale organization. - [Webhooks](https://planetscale.com/docs/api/webhooks.md) - [Billing](https://planetscale.com/docs/billing.md): PlanetScale applies billing plans at the **database level**. You can create several databases under one Organization. - [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 provides the ability to create service tokens for your PlanetScale organization via the CLI or directly in the UI. - [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) - [AI-enhanced development](https://planetscale.com/docs/connect/ai-tooling.md): Improve your database development experience with AI-powered tooling specifically designed for PlanetScale - [PlanetScale Model Context Protocol (MCP)](https://planetscale.com/docs/connect/mcp.md): Connect Claude, Cursor, Notion, and other MCP-compatible tools to your PlanetScale databases and Insights - [How PlanetScale uses AI](https://planetscale.com/docs/how-we-use-ai.md): Which PlanetScale features use generative AI, and how we ensure customer data stays secure and private. - [PlanetScale documentation](https://planetscale.com/docs/index.md): PlanetScale is a relational database platform that brings you scale, performance, and reliability — without sacrificing developer experience. - [PlanetScale Metal](https://planetscale.com/docs/metal.md): PlanetScale Metal databases are the same PlanetScale databases you know and love, powered by blazing-fast, locally-attached NVMe SSD drives instead of network-attached storage. - [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 [Metal](/metal) databases offer performance benefits for many types of workloads. - [PlanetScale plans](https://planetscale.com/docs/planetscale-plans.md) - [Cluster sizing](https://planetscale.com/docs/plans/cluster-sizing.md) - [Deployment options](https://planetscale.com/docs/plans/deployment-options.md): PlanetScale offers two deployment options to accommodate your application and business needs: multi-tenancy and single-tenancy. - [PlanetScale Managed overview](https://planetscale.com/docs/plans/managed.md) - [Cluster sizes](https://planetscale.com/docs/plans/planetscale-skus.md): Here you'll find a complete list of all the database sizes available to you on PlanetScale. - [Vantage integration](https://planetscale.com/docs/plans/vantage.md): With [Vantage](https://www.vantage.sh/), you can set up [PlanetScale cost management](https://vantage.sh/integrations/planetscale) to report on PlanetScale costs alongside other infrastructure providers, such as AWS or GCP. - [PlanetScale Postgres](https://planetscale.com/docs/postgres.md) - [Postgres vs Vitess](https://planetscale.com/docs/postgres-vs-vitess.md): Compare PlanetScale's Postgres and Vitess products to choose the best fit for your application - [Back up and restore](https://planetscale.com/docs/postgres/backups.md): PlanetScale Postgres databases include comprehensive backup and restore capabilities to protect your data. The backup system provides both automated scheduled backups and manual on-demand backups, as well as [point-in-time recovery (PITR)](/postgres/backups/point-in-time-recovery) support through Wr… - [Point-in-time recovery](https://planetscale.com/docs/postgres/backups/point-in-time-recovery.md): Point-in-time recovery (PITR) allows you to restore your PlanetScale Postgres database to any specific moment within your backup retention window. Unlike traditional backups that restore to specific backup snapshots, PITR gives you precise control over when to restore your data. - [Branching](https://planetscale.com/docs/postgres/branching.md): Branches on PlanetScale Postgres are isolated database deployments that provide you with separate environments for development and testing, as well as restoring from backups. - [Cluster configuration](https://planetscale.com/docs/postgres/cluster-configuration.md) - [Cluster storage configuration](https://planetscale.com/docs/postgres/cluster-configuration/cluster-storage.md): You can configure storage settings for network-attached storage PlanetScale Postgres clusters in the "**Storage**" tab on the Clusters page for your database. - [CPU Architectures](https://planetscale.com/docs/postgres/cluster-configuration/cpu-architectures.md): When deploying PostgreSQL databases, choosing the right CPU architecture is crucial for optimizing performance, cost, and efficiency. PlanetScale Postgres supports both x86-64 and ARM64 (aarch64) architectures, with ARM64 instances powered by AWS Graviton processors. - [Disk autoscaling](https://planetscale.com/docs/postgres/cluster-configuration/disk-autoscaling.md): Disk autoscaling automatically increases storage when your database approaches a disk size utilization threshold, preventing storage-related outages without manual intervention. You can also enable automatic disk shrinking to shrink your disk allocation. - [Maintenance windows](https://planetscale.com/docs/postgres/cluster-configuration/maintenance-windows.md): Maintenance windows have been temporarily disabled for PlanetScale Postgres databases. - [Cluster configuration parameters](https://planetscale.com/docs/postgres/cluster-configuration/parameters.md): You can configure your PlanetScale Postgres cluster settings in the "**Parameters**" tab on the Clusters page for your database. - [Single node](https://planetscale.com/docs/postgres/cluster-configuration/single-node.md): Single node Postgres databases come with a single primary and no replicas, and are a great cost-effective option for development or production workloads that do not require high availability. - [Cluster updates](https://planetscale.com/docs/postgres/cluster-configuration/updates.md): PlanetScale occasionally releases software updates for your Postgres cluster. - [Supported versions](https://planetscale.com/docs/postgres/cluster-configuration/versions.md): When creating a PlanetScale Postgres cluster, you can choose from any of the Postgres versions we support. - [Connections overview](https://planetscale.com/docs/postgres/connecting.md): There are several ways to connect to Postgres databases, each with their advantages and tradeoffs. - [PostgreSQL Proxy - Client Error Reference](https://planetscale.com/docs/postgres/connecting/client-error-reference.md): This document provides a comprehensive reference of all error messages that the Exosphere PostgreSQL proxy may send to clients. These errors follow the PostgreSQL wire protocol format and include standard SQLSTATE error codes. - [IP restrictions](https://planetscale.com/docs/postgres/connecting/ip-restrictions.md): Manage which IP addresses can establish connections to your database. - [Using the Neon serverless driver](https://planetscale.com/docs/postgres/connecting/neon-serverless-driver.md) - [PgBouncer](https://planetscale.com/docs/postgres/connecting/pgbouncer.md): PgBouncer provides connection pooling for your Postgres database. - [Connect privately with AWS PrivateLink](https://planetscale.com/docs/postgres/connecting/private-connections/aws-privatelink.md): When you use AWS PrivateLink, your network traffic between your VPC and PlanetScale stays within the AWS network, without traversing the public internet. - [Connect privately with GCP Private Service Connect](https://planetscale.com/docs/postgres/connecting/private-connections/gcp-private-service-connect.md): When you use GCP Private Service Connect, your network traffic between your VPC and PlanetScale stays within the Google Cloud network, without traversing the public internet. - [Connections quickstart](https://planetscale.com/docs/postgres/connecting/quickstart.md): PlanetScale Postgres works with any standard PostgreSQL driver or library that supports SSL connections. - [Managing Roles for your Postgres database](https://planetscale.com/docs/postgres/connecting/roles.md): When you connect to your database, you have the option to connect with the default role or a user-generated role. This document covers the differences between each option and how to create new roles. - [Connection resilience guide](https://planetscale.com/docs/postgres/connection-resilience.md): Configure PlanetScale Postgres for maximum availability in demanding OLTP workloads. - [PlanetScale Postgres database dashboard](https://planetscale.com/docs/postgres/dashboard.md): When you navigate to a database in your PlanetScale organization, you'll see a comprehensive view of your cluster health, performance metrics, and management options. You can filter this view by [branch](/postgres/branching) by selecting from the branch dropdown at the top. - [Development Environments](https://planetscale.com/docs/postgres/development-environments.md): When using development environments, it's important to have a way to work with your database and test schema changes in isolation from production. We have several recommendations for how to accomplish this when using PlanetScale Postgres. - [Extensions](https://planetscale.com/docs/postgres/extensions.md): PostgreSQL extensions are add-on modules that extend the functionality of your database beyond the core features. They provide additional data types, functions, operators, indexes, and other capabilities without requiring modifications to the PostgreSQL source code. - [Extensions: pg_cron](https://planetscale.com/docs/postgres/extensions/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 to how cron jobs work in Unix-like systems. - [Extensions: pg_duckdb](https://planetscale.com/docs/postgres/extensions/pg_duckdb.md): pg_duckdb is a Postgres extension that embeds DuckDB, a high-performance analytical database, directly into Postgres. - [Extensions: pg_hint_plan](https://planetscale.com/docs/postgres/extensions/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 to optimize query performance by guiding the planner towards more efficient execution plans. - [Extensions: pg_partman_bgw](https://planetscale.com/docs/postgres/extensions/pg_partman_bgw.md): The pg_partman_bgw extension is a background worker for managing partitioned tables in PostgreSQL. It automates the creation and maintenance of partitioned tables, making it easier to manage large datasets. - [Extensions: pg_squeeze](https://planetscale.com/docs/postgres/extensions/pg_squeeze.md): pg_squeeze automatically cleans up unused space in tables (table bloat). pg_squeeze helps maintain optimal table performance by removing dead space that accumulates over time from UPDATE and DELETE operations. - [Extensions: pg_stat_statements](https://planetscale.com/docs/postgres/extensions/pg_stat_statements.md): pg_stat_statements is a PostgreSQL extension that tracks execution statistics of all SQL statements executed by a server. It provides insights into query performance, allowing you to identify slow queries and optimize them - [Extensions: pg_strict](https://planetscale.com/docs/postgres/extensions/pg_strict.md): pg_strict blocks dangerous queries before they run. It prevents common mistakes like UPDATE or DELETE statements without WHERE clauses that would affect every row in a table. - [Extensions: pginsights](https://planetscale.com/docs/postgres/extensions/pginsights.md): The pginsights extension is a PlanetScale Insights plugin that provides query performance monitoring and analysis capabilities. This extension is always enabled for PlanetScale databases and integrates with the Query Insights feature. - [Extensions: TimescaleDB](https://planetscale.com/docs/postgres/extensions/timescaledb.md): TimescaleDB is a time-series database for high-performance real-time analytics packaged as a Postgres extension. - [Migrate from Aurora to PlanetScale](https://planetscale.com/docs/postgres/imports/aurora.md): Use this guide to migrate an existing Aurora (Postgres) database to PlanetScale Postgres. - [Migrate from Aurora using Amazon DMS with CloudFormation](https://planetscale.com/docs/postgres/imports/aurora-dms.md): This method uses Infrastructure as Code with Step Functions workflow automation for a completely managed migration experience. - [Discovery Tool](https://planetscale.com/docs/postgres/imports/discovery-tool.md): Assess your PostgreSQL database and cloud infrastructure before migrating to PlanetScale Postgres. - [Migrate from Heroku to PlanetScale](https://planetscale.com/docs/postgres/imports/heroku.md): Bucardo asynchronous replication from Heroku to PlanetScale Postgres. - [Import public IP addresses](https://planetscale.com/docs/postgres/imports/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 of IP addresses access to your Postgres database so that PlanetScale can make the connection. - [Migrate from Neon to PlanetScale](https://planetscale.com/docs/postgres/imports/neon.md): Use this guide to migrate an existing Neon database to PlanetScale Postgres. - [Postgres Imports](https://planetscale.com/docs/postgres/imports/postgres-imports.md): For customers looking to migrate their Postgres databases to PlanetScale Postgres, you have several options for how to make this the smoothest event for your business. - [Postgres Imports - Amazon DMS](https://planetscale.com/docs/postgres/imports/postgres-migrate-dms.md) - [Postgres Imports - PGDump and Restore](https://planetscale.com/docs/postgres/imports/postgres-migrate-dumprestore.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): Change Data Capture (CDC) allows you to track and stream data changes from your PostgreSQL database to external systems in real-time. PlanetScale Postgres supports logical replication, enabling CDC through various tools and integrations. - [Anomalies](https://planetscale.com/docs/postgres/monitoring/anomalies.md): Anomalies are defined as periods with a substantially elevated percentage of slow-running queries. - [Errors](https://planetscale.com/docs/postgres/monitoring/errors.md): The Errors page surfaces any errors that have been captured on your database in a 24 hour period. - [Cluster Logs](https://planetscale.com/docs/postgres/monitoring/logs.md): The Logs dashboard provides comprehensive logging and debugging capabilities for your PlanetScale Postgres database cluster. This centralized view helps you monitor database activity, troubleshoot issues, and analyze system behavior in real-time. - [Cluster Metrics](https://planetscale.com/docs/postgres/monitoring/metrics.md): The Metrics dashboard provides comprehensive monitoring and observability for your PostgreSQL database cluster. - [pganalyze collector](https://planetscale.com/docs/postgres/monitoring/pganalyze.md): Set up pganalyze monitoring on your PlanetScale Postgres databases for query analysis, performance insights, log collection, and alerting through the pganalyze platform. - [Sending Prometheus Metrics to Datadog for PlanetScale Postgres](https://planetscale.com/docs/postgres/monitoring/prometheus-metrics-datadog-postgres.md): If you're looking for more metrics than PlanetScale's native Datadog integration provides, this tutorial will show how to configure your [Datadog agent](https://docs.datadoghq.com/agent/) to scrape PlanetScale's [Prometheus infrastructure](/vitess/integrations/prometheus-metrics) automatically, allo… - [Prometheus metrics for PlanetScale Postgres](https://planetscale.com/docs/postgres/monitoring/prometheus-metrics-postgres.md): PlanetScale Postgres exposes a Prometheus-compatible endpoint per-branch that allows you to scrape metrics for your database. - [Prometheus integration for PlanetScale Postgres](https://planetscale.com/docs/postgres/monitoring/prometheus-postgres.md): PlanetScale Postgres exposes Prometheus-compatible metrics endpoints for scraping metrics about your database branches. This, along with our API-driven service discovery, allows you to automatically get in-depth information about all of the Postgres databases in your organization. - [Query Insights](https://planetscale.com/docs/postgres/monitoring/query-insights.md): PlanetScale Insights gives you a detailed look into **all active queries** running against your database. - [Schema recommendations](https://planetscale.com/docs/postgres/monitoring/schema-recommendations.md): With schema recommendations inside of [PlanetScale Insights](/postgres/monitoring/query-insights), you will automatically receive recommendations to improve database performance, reduce memory and storage, and improve your schema. - [PlanetScale Postgres operations philosophy](https://planetscale.com/docs/postgres/operations-philosophy.md): PlanetScale has a high standard for uptime and availability of Postgres databases. - [PlanetScale Postgres architecture](https://planetscale.com/docs/postgres/postgres-architecture.md): PlanetScale Postgres is a managed PostgreSQL service built on modern cloud infrastructure. - [Postgres compatibility](https://planetscale.com/docs/postgres/postgres-compatibility.md): PlanetScale Postgres is built on standard PostgreSQL, providing full compatibility with PostgreSQL features. This page documents the specific behaviors, limitations, and differences you should be aware of when using PlanetScale Postgres. - [PlanetScale Postgres pricing](https://planetscale.com/docs/postgres/pricing.md): PlanetScale Postgres databases are billed based on their configuration and usage. - [Database replicas](https://planetscale.com/docs/postgres/scaling/replicas.md): A replica is a continuously updated copy of your Postgres database. - [Settings](https://planetscale.com/docs/postgres/settings.md): The Settings page allows you to configure general settings and options for your PlanetScale Postgres database. - [Horizontal Sharding for Postgres](https://planetscale.com/docs/postgres/sharding.md): Learn about Neki, PlanetScale's upcoming horizontal sharding solution for Postgres - [Out of memory (OOM)](https://planetscale.com/docs/postgres/troubleshooting/out-of-memory.md): Understanding and resolving out of memory events on PlanetScale Postgres clusters. - [Read-only mode](https://planetscale.com/docs/postgres/troubleshooting/read-only-mode.md): PlanetScale may automatically enable read-only mode on a cluster to maintain stability and availability when certain conditions are detected. - [PlanetScale Postgres with Bun](https://planetscale.com/docs/postgres/tutorials/planetscale-postgres-bun.md): Create a new Postgres database and integrate it with Bun. - [PlanetScale Postgres with Cloudflare Workers](https://planetscale.com/docs/postgres/tutorials/planetscale-postgres-cloudflare-workers.md): Create a new Postgres database and integrate it with Cloudflare Workers and Hyperdrive. - [PlanetScale Postgres with Drizzle](https://planetscale.com/docs/postgres/tutorials/planetscale-postgres-drizzle.md): Create a new Postgres database and integrate it with Drizzle. - [PlanetScale Postgres with Kysely](https://planetscale.com/docs/postgres/tutorials/planetscale-postgres-kysely.md): Create a new Postgres database and integrate it with Kysely. - [PlanetScale Postgres with Laravel](https://planetscale.com/docs/postgres/tutorials/planetscale-postgres-laravel.md): Create a new Postgres database and integrate it with Laravel. - [PlanetScale Postgres with Node.js](https://planetscale.com/docs/postgres/tutorials/planetscale-postgres-node.md): Create a new Postgres database and integrate it with Node.js. - [PlanetScale Postgres with Prisma](https://planetscale.com/docs/postgres/tutorials/planetscale-postgres-prisma.md): Create a new Postgres database and integrate it with Prisma. - [PlanetScale Postgres quickstart](https://planetscale.com/docs/postgres/tutorials/planetscale-postgres-quickstart.md): This guide will walk you through how to create a new PlanetScale Postgres database. - [PlanetScale Postgres with Ruby on Rails](https://planetscale.com/docs/postgres/tutorials/planetscale-postgres-rails.md): Create a new Postgres database and integrate it with Ruby on Rails. - [The proof of concept phase of an enterprise contract](https://planetscale.com/docs/proof-of-concept.md): We get many customers that come to us with existing large, production databases. - [Exploring Enterprise - the sales process](https://planetscale.com/docs/sales-process.md) - [Security and compliance](https://planetscale.com/docs/security.md): PlanetScale is committed to delivering a powerful and easy-to-use database platform while keeping your data secure. - [Access control](https://planetscale.com/docs/security/access-control.md) - [Account password security](https://planetscale.com/docs/security/account-password-security.md): In addition to best practices like [multi-factor authentication](/security/multi-factor-authentication), PlanetScale securely stores your account passwords and validates passwords against known security breaches. - [Audit log](https://planetscale.com/docs/security/audit-log.md): The organization audit log grants [Organization Administrators](/security/access-control#organization-administrator) access to review **actions** performed by individual members of the organization. - [Authentication methods](https://planetscale.com/docs/security/authentication-methods.md): There are three ways to authenticate with PlanetScale: _email address and password_, _single sign-on_, and _OAuth via GitHub_. - [Multi-factor authentication](https://planetscale.com/docs/security/multi-factor-authentication.md): Multi-factor authentication (MFA) provides better safety for your databases and prevents unauthorized access to your user account. - [Security log](https://planetscale.com/docs/security/security-log.md): The Security log gives you insight into recent authentication and other security-related `actions` for your account. Your security log also details when you performed each `action`. - [Single sign-on](https://planetscale.com/docs/security/sso.md): Single sign-on (SSO) provides additional account security by allowing company administrators to require the use of an identity provider when logging into PlanetScale. - [Teams](https://planetscale.com/docs/security/teams.md): PlanetScale allows you to create teams within organizations. - [Vulnerability disclosure](https://planetscale.com/docs/security/vulnerability-disclosure.md) - [PlanetScale Support](https://planetscale.com/docs/support.md): PlanetScale’s team has a combined 600 years of experience running databases at scale. - [PlanetScale Terraform provider](https://planetscale.com/docs/terraform.md): A resource model for Vitess and Postgres databases, designed for Terraform and OpenTofu. - [PlanetScale for Vitess](https://planetscale.com/docs/vitess.md) - [PlanetScale Vitess architecture](https://planetscale.com/docs/vitess/architecture.md): PlanetScale's Vitess product is designed for reliability, scalability, and developer productivity. - [Audit log](https://planetscale.com/docs/vitess/audit-log.md): The organization audit log grants [Organization Administrators](/security/access-control#organization-administrator) access to review **actions** performed by individual members of the organization. - [Back up and restore](https://planetscale.com/docs/vitess/backups.md) - [PlanetScale workflow for Vitess](https://planetscale.com/docs/vitess/best-practices.md) - [Cluster configuration](https://planetscale.com/docs/vitess/cluster-configuration.md): The Clusters page in your PlanetScale dashboard allows you to configure your PlanetScale cluster. - [Connection strings](https://planetscale.com/docs/vitess/connecting/connection-strings.md) - [Network latency](https://planetscale.com/docs/vitess/connecting/network-latency.md): When connecting to PlanetScale, it's important to understand how network latency can impact query speed. - [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) - [Deleting a database](https://planetscale.com/docs/vitess/delete-a-database.md): How to remove a database from PlanetScale. - [PlanetScale Connect](https://planetscale.com/docs/vitess/etl.md): PlanetScale Connect is one of the underlying mechanisms we use to transfer data between parties. - [Foreign key constraints](https://planetscale.com/docs/vitess/foreign-key-constraints.md) - [Sending Prometheus Metrics to Datadog](https://planetscale.com/docs/vitess/guides/prometheus-metrics-datadog.md): If you're looking for more metrics than PlanetScale's native Datadog integration provides, this tutorial will show how to configure your [Datadog agent](https://docs.datadoghq.com/agent/) to scrape PlanetScale's [Prometheus infrastructure](/vitess/integrations/prometheus) automatically, allowing you… - [Grafana Dashboard for PlanetScale Branches](https://planetscale.com/docs/vitess/guides/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 your PlanetScale database. - [Sending Prometheus Metrics to New Relic](https://planetscale.com/docs/vitess/guides/prometheus-metrics-newrelic.md): If you're looking for your PlanetScale database metrics in your New Relic account, this tutorial will show how to configure a [Prometheus](https://prometheus.io/) instance to scrape PlanetScale's [Prometheus infrastructure](/vitess/integrations/prometheus) automatically, allowing you to collect deta… - [Handling table and column renames](https://planetscale.com/docs/vitess/handling-table-and-column-renames.md) - [How to make different types of schema changes](https://planetscale.com/docs/vitess/how-to-make-different-types-of-schema-changes.md): Your database has to grow and change with your application and product. - [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) - [Database Import Workflow](https://planetscale.com/docs/vitess/imports/database-imports.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): When importing a database using our [Import tool](/vitess/imports/database-imports), you need to grant a set of IP addresses access to your external MySQL database so that PlanetScale can make the connection. - [Import user permissions](https://planetscale.com/docs/vitess/imports/import-tool-user-requirements.md): When importing a database using our [Import tool](/vitess/imports/database-imports), you will need to connect to your existing database with a user that has the proper permissions to set up the necessary configurations to start importing data. - [Import troubleshooting](https://planetscale.com/docs/vitess/imports/import-troubleshooting.md) - [MariaDB migration guide](https://planetscale.com/docs/vitess/imports/mariadb-migration-guide.md) - [Postgres to Vitess imports](https://planetscale.com/docs/vitess/imports/postgres.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) - [Airbyte integration](https://planetscale.com/docs/vitess/integrations/airbyte.md): With PlanetScale Connect, you can extract data from your PlanetScale database and safely load it into other destinations for analysis, transformation, and more. - [Cloudflare Workers database integration](https://planetscale.com/docs/vitess/integrations/cloudflare-workers.md): Create a new Vitess database and integrate it with Cloudflare Workers and Hyperdrive. - [Datadog integration](https://planetscale.com/docs/vitess/integrations/datadog.md): PlanetScale can push metrics to Datadog to assist your team with understanding your database usage and performance. - [Debezium connector for PlanetScale](https://planetscale.com/docs/vitess/integrations/debezium.md): The Debezium connector for PlanetScale is a connector for [Debezium](https://debezium.io/), an open-source distributed platform for change data capture. - [Fivetran integration](https://planetscale.com/docs/vitess/integrations/fivetran.md): With PlanetScale Connect, you can extract data from your PlanetScale database and safely load it into other destinations for analysis, transformation, and more. - [PlanetScale GitHub Actions](https://planetscale.com/docs/vitess/integrations/github-actions.md) - [Hightouch integration](https://planetscale.com/docs/vitess/integrations/hightouch.md): Hightouch is a platform that allows you to sync data between systems using a simple and intuitive UI. - [Netlify](https://planetscale.com/docs/vitess/integrations/netlify.md) - [Prometheus](https://planetscale.com/docs/vitess/integrations/prometheus.md): PlanetScale exposes Prometheus-compatible metrics endpoints for scraping metrics about your database branches. This, along with our API-driven service discovery, allow you to automatically get in-depth information about all of the databases in your organization. - [Prometheus metrics](https://planetscale.com/docs/vitess/integrations/prometheus-metrics.md): PlanetScale exposes a Prometheus-compatible endpoint per-branch that allows you to scrape metrics for your database. - [Stitch integration](https://planetscale.com/docs/vitess/integrations/stitch.md): With PlanetScale Connect, you can extract data from your PlanetScale database and safely load it into other destinations for analysis, transformation, and more. - [Vantage integration](https://planetscale.com/docs/vitess/integrations/vantage.md): With [Vantage](https://www.vantage.sh/), you can set up [PlanetScale cost management](https://vantage.sh/integrations/planetscale) to report on PlanetScale costs alongside other infrastructure providers, such as AWS or GCP. - [Maintenance schedules](https://planetscale.com/docs/vitess/maintenance-schedules.md): Enterprise customers have the option to enable scheduled maintenance windows on databases. - [PlanetScale Managed overview](https://planetscale.com/docs/vitess/managed.md) - [PlanetScale Managed on AWS overview](https://planetscale.com/docs/vitess/managed/aws.md): PlanetScale Managed on Amazon Web Services (AWS) is a single-tenant deployment of PlanetScale in your AWS organization within an isolated AWS Organizations member account. - [Back up and restore in AWS](https://planetscale.com/docs/vitess/managed/aws/back-up-and-restore.md): PlanetScale Managed backup and restore functions like the hosted PlanetScale product. For more info, see [how to create, schedule, and restore backups for your PlanetScale databases](/vitess/backups). - [Set up PlanetScale Managed in AWS](https://planetscale.com/docs/vitess/managed/aws/getting-started.md): The following guide will walk you through setting up a PlanetScale Managed cluster in your Amazon Web Services (AWS) organization. - [Set up AWS PrivateLink with PlanetScale Managed](https://planetscale.com/docs/vitess/managed/aws/privatelink.md): PlanetScale Managed can connect you to your databases via [AWS PrivateLink](https://aws.amazon.com/privatelink/). The following guide describes how PlanetScale Managed with AWS PrivateLink works and how to set it up. - [Set up AWS Reverse PrivateLink with PlanetScale Managed](https://planetscale.com/docs/vitess/managed/aws/reverse-privatelink.md): [PlanetScale Managed](/vitess/managed/aws) can connect to your existing databases via AWS PrivateLink for the purposes of data imports. - [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) - [Schema snapshots](https://planetscale.com/docs/vitess/managed/aws/security-and-access/schema-snapshots.md) - [User management](https://planetscale.com/docs/vitess/managed/aws/security-and-access/user-management.md) - [PlanetScale Managed on GCP overview](https://planetscale.com/docs/vitess/managed/gcp.md): PlanetScale Managed on Google Cloud Platform (GCP) is a single-tenant deployment of PlanetScale in your GCP organization within an isolated project. - [Back up and restore in GCP](https://planetscale.com/docs/vitess/managed/gcp/back-up-and-restore.md): PlanetScale Managed backup and restore functions like the hosted PlanetScale product. For more info, see [how to create, schedule, and restore backups for your PlanetScale databases](/vitess/backups). - [Set up PlanetScale Managed in GCP](https://planetscale.com/docs/vitess/managed/gcp/getting-started.md): The following guide will walk you through setting up a PlanetScale Managed cluster in your Google Cloud Platform (GCP) organization. - [Set up GCP Private Service Connect with PlanetScale Managed](https://planetscale.com/docs/vitess/managed/gcp/private-service-connect.md): PlanetScale Managed can connect you to your databases via [GCP Private Service Connect](https://cloud.google.com/vpc/docs/private-service-connect). - [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) - [Schema snapshots](https://planetscale.com/docs/vitess/managed/gcp/security-and-access/schema-snapshots.md) - [User management](https://planetscale.com/docs/vitess/managed/gcp/security-and-access/user-management.md) - [Anomalies](https://planetscale.com/docs/vitess/monitoring/anomalies.md): Anomalies are defined as periods with a substantially elevated percentage of slow-running queries. - [Datadog integration](https://planetscale.com/docs/vitess/monitoring/datadog.md): PlanetScale can push metrics to Datadog to assist your team with understanding your database usage and performance. - [Errors](https://planetscale.com/docs/vitess/monitoring/errors.md): The Errors page surfaces any errors that have been captured on your database in a 24 hour period. - [Sending Prometheus Metrics to Datadog](https://planetscale.com/docs/vitess/monitoring/prometheus-metrics-datadog.md): If you're looking for more metrics than PlanetScale's native Datadog integration provides, this tutorial will show how to configure your [Datadog agent](https://docs.datadoghq.com/agent/) to scrape PlanetScale's [Prometheus infrastructure](/vitess/integrations/prometheus) automatically, allowing you… - [Grafana Dashboard for PlanetScale Branches](https://planetscale.com/docs/vitess/monitoring/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 your PlanetScale database. - [Sending Prometheus Metrics to New Relic](https://planetscale.com/docs/vitess/monitoring/prometheus-metrics-newrelic.md): If you're looking for your PlanetScale database metrics in your New Relic account, this tutorial will show how to configure a [Prometheus](https://prometheus.io/) instance to scrape PlanetScale's [Prometheus infrastructure](/vitess/integrations/prometheus) automatically, allowing you to collect deta… - [Query Insights](https://planetscale.com/docs/vitess/monitoring/query-insights.md): PlanetScale Insights gives you a detailed look into **all active queries** running against your database. - [Schema recommendations](https://planetscale.com/docs/vitess/monitoring/schema-recommendations.md): With schema recommendations inside of PlanetScale Insights, you will automatically receive recommendations to improve database performance, reduce memory and storage, and improve your schema based on production database traffic. - [MySQL compatibility](https://planetscale.com/docs/vitess/mysql-compatibility.md): PlanetScale Vitess is built on open-source Vitess, a database clustering system for horizontal scaling of MySQL. - [Online DDL change unique keys](https://planetscale.com/docs/vitess/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 described below, followed by examples. - [Operating without foreign key constraints](https://planetscale.com/docs/vitess/operating-without-foreign-key-constraints.md): A **foreign key** is a logical association of rows between two tables, in a parent-child relationship. - [Pricing](https://planetscale.com/docs/vitess/pricing.md): A single Vitess database cluster includes the resources equivalent to 5 always-on instances within the base monthly plan cost. - [Regions](https://planetscale.com/docs/vitess/regions.md) - [Database replicas](https://planetscale.com/docs/vitess/replicas.md): A replica is a continuously updated copy of your Vitess database. - [Cluster configuration](https://planetscale.com/docs/vitess/scaling/cluster-configuration.md): The Clusters page in your PlanetScale dashboard allows you to configure your PlanetScale cluster. - [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): PlanetScale workflows provide pre-defined recipes that make it simple to run operations on your databases, including moving tables between keyspaces and importing external databases. - [Non-blocking schema changes](https://planetscale.com/docs/vitess/schema-changes.md): **Non-blocking schema changes** in PlanetScale provide a schema change workflow that allows users to update database tables without locking or causing downtime for production databases. - [Aggressive deploy request cutover](https://planetscale.com/docs/vitess/schema-changes/aggressive-cutover.md) - [Branching](https://planetscale.com/docs/vitess/schema-changes/branching.md): PlanetScale allows you to branch database schemas the same way you branch your code. - [Data Branching®](https://planetscale.com/docs/vitess/schema-changes/data-branching.md) - [Deploy requests](https://planetscale.com/docs/vitess/schema-changes/deploy-requests.md): Deploy requests are an integral part of the [PlanetScale workflow](/vitess/best-practices). - [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): Your database has to grow and change with your application and product. - [Comparison of Online Schema Change tools](https://planetscale.com/docs/vitess/schema-changes/online-schema-change-tools-comparison.md): Online Schema Change tools for MySQL [share a similar basic design](/vitess/schema-changes/how-online-schema-change-tools-work), but differ in implementation. - [Online DDL change unique keys](https://planetscale.com/docs/vitess/schema-changes/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 described below, followed by examples. - [Safe migrations](https://planetscale.com/docs/vitess/schema-changes/safe-migrations.md): Safe migrations is an optional but highly recommended feature for branches in PlanetScale. With safe migrations enabled on a branch, you’ll gain zero-downtime schema migrations, schema reverts, and protection against accidental schema changes. The safe migrations setting is recommended for all produ… - [Throttling deploy requests](https://planetscale.com/docs/vitess/schema-changes/throttling-deploy-requests.md) - [Connection strings](https://planetscale.com/docs/vitess/security/connection-strings.md) - [Password roles](https://planetscale.com/docs/vitess/security/password-roles.md): PlanetScale allows you to [create and manage passwords](/vitess/connecting/connection-strings) for each branch of your database. - [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) - [What is a keyspace](https://planetscale.com/docs/vitess/sharding/keyspaces.md): In Vitess, a keyspace is a logical database that maps to one or many MySQL instances. - [Pre-sharding checklist](https://planetscale.com/docs/vitess/sharding/pre-sharding-checklist.md): When you begin a new [unsharded to sharded workflow](/vitess/sharding/sharding-quickstart), there are a number of steps that happen behind the scenes. This document covers some of the pre-sharding work that PlanetScale handles for you. - [Sequence Tables](https://planetscale.com/docs/vitess/sharding/sequence-tables.md): In MySQL, it is common to have an integer primary key that uses the `AUTO_INCREMENT` feature for assigning IDs. - [Workflow: Sharded to sharded keyspace](https://planetscale.com/docs/vitess/sharding/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 sharded keyspace grows significantly and requires additional shards. - [Sharding new tables](https://planetscale.com/docs/vitess/sharding/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 to shard, follow the [Sharding quickstart](/vitess/sharding/sharding-quickstart) instead. - [Workflow: Unsharded to sharded keyspace](https://planetscale.com/docs/vitess/sharding/sharding-quickstart.md): This tutorial covers how to shard **existing tables** in your PlanetScale database. This is done using the unsharded to sharded keyspace [workflow](/vitess/scaling/workflows). - [Sharding workflow state reference](https://planetscale.com/docs/vitess/sharding/sharding-workflow-state-reference.md): This document can be used as reference when going through the [Sharding quickstart](/vitess/sharding/sharding-quickstart). It covers the various states you may enter during the workflow. - [Targeting the correct keyspace](https://planetscale.com/docs/vitess/sharding/targeting-correct-keyspace.md): Once you have more than one keyspace, with tables distributed across both keyspaces, your application may not know how to properly route queries to the correct keyspace. - [Vindexes](https://planetscale.com/docs/vitess/sharding/vindexes.md): When configuring a horizontally [sharded](/vitess/sharding) keyspace, one of the most important decisions to make is _how_ to distribute the data across shards. - [VSchema](https://planetscale.com/docs/vitess/sharding/vschema.md): PlanetScale databases are powered by Vitess. - [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): Here we provide definitions for technologies and concepts you will see throughout our documentation and product. Some of these are common terms in the databases space, while others are Vitess or PlanetScale specific. - [PlanetScale database error reference](https://planetscale.com/docs/vitess/troubleshooting/errors.md) - [MySQL compatibility](https://planetscale.com/docs/vitess/troubleshooting/mysql-compatibility.md): PlanetScale Vitess is built on open-source Vitess, a database clustering system for horizontal scaling of MySQL. - [Vitess system limits](https://planetscale.com/docs/vitess/troubleshooting/planetscale-system-limits.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) - [AWS Lambda connection strings](https://planetscale.com/docs/vitess/tutorials/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 Functions. - [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): In this tutorial, you'll learn how to connect a Laravel 12 application to a PlanetScale MySQL database using a sample Laravel starter app. - [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): 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](https://planetscale.com/docs/vitess/tutorials/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 starter app using [MySQLi](https://www.php.net/manual/en/book.mysqli.php). - [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): In this tutorial, you'll learn how to connect a Symfony application to a PlanetScale MySQL database using a sample Symfony starter app. - [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): This guide will walk you through setting up and deploying your PlanetScale database on Netlify. - [Deploy to Vercel](https://planetscale.com/docs/vitess/tutorials/deploy-to-vercel.md): This guide will walk you through setting up and deploying your PlanetScale database on Vercel. - [Deploy to Netlify](https://planetscale.com/docs/vitess/tutorials/deployments/deploy-to-netlify.md): This guide will walk you through setting up and deploying your PlanetScale database on Netlify. - [Deploy to Vercel](https://planetscale.com/docs/vitess/tutorials/deployments/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](https://planetscale.com/docs/vitess/tutorials/deployments/nextjs-planetscale-netlify-template.md) - [PlanetScale GitHub Actions](https://planetscale.com/docs/vitess/tutorials/github-actions.md) - [Deploy to Vercel](https://planetscale.com/docs/vitess/tutorials/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](https://planetscale.com/docs/vitess/tutorials/nextjs-planetscale-netlify-template.md) - [PlanetScale Vitess quickstart guide](https://planetscale.com/docs/vitess/tutorials/planetscale-quick-start-guide.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): This guide will cover how to use the provided Node.js sample application using the PlanetScale serverless driver for JavaScript. - [Using the PlanetScale serverless driver with Prisma](https://planetscale.com/docs/vitess/tutorials/planetscale-serverless-driver-prisma-example.md): This document outlines how you can use the [PlanetScale serverless driver](/vitess/tutorials/planetscale-serverless-driver) along with Prisma in your application. - [Prisma best practices](https://planetscale.com/docs/vitess/tutorials/prisma-best-practices.md): This document provides various best practices for getting the most out of Prisma, a next-generation ORM for Node.js and TypeScript, and PlanetScale. It also includes relevant links to Prisma's documentation. - [Using the PlanetScale serverless driver with Prisma](https://planetscale.com/docs/vitess/tutorials/prisma-example.md): This document outlines how you can use the [PlanetScale serverless driver](/vitess/tutorials/planetscale-serverless-driver) along with Prisma in your application. - [Prometheus](https://planetscale.com/docs/vitess/tutorials/prometheus.md): PlanetScale exposes Prometheus-compatible metrics endpoints for scraping metrics about your database branches. This, along with our API-driven service discovery, allow you to automatically get in-depth information about all of the databases in your organization. - [Sending Prometheus Metrics to Datadog](https://planetscale.com/docs/vitess/tutorials/prometheus-metrics-datadog.md): If you're looking for more metrics than PlanetScale's native Datadog integration provides, this tutorial will show how to configure your [Datadog agent](https://docs.datadoghq.com/agent/) to scrape PlanetScale's [Prometheus infrastructure](/vitess/integrations/prometheus) automatically, allowing you… - [Grafana Dashboard for PlanetScale Branches](https://planetscale.com/docs/vitess/tutorials/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 your PlanetScale database. - [Sending Prometheus Metrics to New Relic](https://planetscale.com/docs/vitess/tutorials/prometheus-metrics-newrelic.md): If you're looking for your PlanetScale database metrics in your New Relic account, this tutorial will show how to configure a [Prometheus](https://prometheus.io/) instance to scrape PlanetScale's [Prometheus infrastructure](/vitess/integrations/prometheus) automatically, allowing you to collect deta… - [Using PlanetScale with Prisma](https://planetscale.com/docs/vitess/tutorials/using-planetscale-with-prisma.md): [Prisma](https://www.prisma.io/) ORM provides type-safe database access through an intuitive API, eliminating the need to write SQL queries manually. - [Vector search and storage](https://planetscale.com/docs/vitess/vectors.md): Vectors are a data structure that captures opaque semantic meaning about something and allows a database to search for resources by similarity based on this opaque meaning. - [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): The PlanetScale web console is an interactive interface for running MySQL queries and DDL (Create, Alter, and Delete) against your PlanetScale database branches. - [What is PlanetScale?](https://planetscale.com/docs/what-is-planetscale.md) ## OpenAPI Specs - [openapi](https://planetscale.com/docs/openapi.yaml) ## Optional - [Blog](https://planetscale.com/blog) - [Contact Us](https://planetscale.com/contact) - [Status](https://www.planetscalestatus.com/) - [Benchmarks](https://planetscale.com/benchmarks) Built with [Mintlify](https://mintlify.com).