Create reusable connection strings to connect to your PlanetScale database.
Creating a password
- To create a password, head to your database overview page at
https://app.planetscale.com/<organization>/<database-name>and click on the
Database overview page
- On this dialog, click on
Generate new passwordto create a new password to connect to the
mainbranch of your database. We will then generate a unique username & password pair for you that will not be repeated and can be used to only access the
mainbranch of your database.
Generate a new password
- Once created, you can browse the connection string in different framework formats.
Browse connection string in formats
Once you've created the password, you can head over to the
Passwords settings page available at
Organization > Database > Settings > Passwords to manage them.
mainon this page.
Manage passwords page
Clicking on the
... icon on the row for your password allows you to
Rename the password, and
Operations on a password
Renaming a password
Since the username & password pair is unique, the only metadata you can edit is the
display name of the password.
Rename a password
Deleting a password
Deleting a password will invalidate the username & password pair and disconnect any active clients using this password. Delete a password
Native MySQL authentication support
Use the tools you're familiar with to connect to PlanetScale databases. PlanetScale supports both MySQL native authentication which is widely used to provide a secure connection to MySQL servers, and MySQL Caching SHA-2 authentication which is the most secure authentication mechanism to connect to MySQL. Based on your application needs and platform support, you can switch between the authentication modes, with the same password.
Strong security model
PlanetScale Passwords are created for use with a single database branch. This strong security model allows you to generate passwords that are tied to a branch, and cannot access data/schema from another branch.
Disconnect clients by deleting passwords
PlanetScale automatically disconnects clients that are using a deleted password.
Head on over to the
Organization > Database > Settings > Passwords page on your database branch to delete passwords for that branch.
No plain text password storage
PlanetScale only stores hashes and metadata about your database passwords. We do not store any passwords in plain text to add an extra layer of security to your database.
GitHub Secret Scanning integration
All passwords and service tokens generated for use with PlanetScale databases are part of GitHub's Secret Scanning program. If any database passwords or service tokens are committed in plain text to any public GitHub repository, we will be notified and take corrective action to delete the access tokens and cut off their access.