Connect a Rails application to PlanetScale
Spin up a PlanetScale MySQL serverless database in seconds and connect to a Rails application
In this tutorial, you’re going to create a simple Rails application named blog and connect it to a PlanetScale database. You’ll perform the initial migration from your local Rails application, and set up the database for future development.
Already have a Rails application and just want to connect to PlanetScale? Check out the Rails quick connect repo.
- Install Ruby and the Rails gem.
- Install the PlanetScale CLI.
- Authenticate the CLI with the following command:
Create a Rails project
To connect a Rails application to a PlanetScale database, you'll first create a sample Rails project named blog and install the libraries needed to connect to your PlanetScale database.
Open the command line and follow these steps:
- Create a Rails app named blog by running the following command:
- Change into the directory you just created, the
- Next, add the
mysql2gem to your Gemfile:
- Then run
At this point, you have accomplished two things: you've created a Rails project called blog and installed the libraries that you'll need to connect to your PlanetScale database. Now, it’s time to create a PlanetScale database.
Create a PlanetScale database and password
Note: You can also create passwords in the PlanetScale dashboard, as documented in our Creating a password documentation.
Using the CLI to create a connection string
- Using the
pscaleCLI, create a new database also named blog:
- Using the
pscaleCLI, create a new database password for the
mainbranch of your database named blog:
PASSWORD_NAME value represents the name of the username and password being generated. You can have multiple credentials for a branch, so this gives you a way to categorize them. To manage your passwords in the dashboard, go to your database overview page, click "Settings", and then click "Passwords".
- Take note of the values returned to you, as they will not be shown again.
Configure Rails and PlanetScale
Let's set up the Rails application to talk to the new database.
config/database.ymland configure the
developmentdatabase settings with your new credentials from the output in the previous step:
sslca path depends on your operating system and distribution. See CA root configuration for more information.
You're configuring the development Rails environment here for the sake of expedience. In actual use, the main database branch would typically serve the production environment.
Because this is a Rails app, you can also enable Automatic Rails migrations from the database's settings page. Select your database, click on the
main branch, click "Settings", check the "Automatically copy migration data" box, and select "Rails" from the dropdown.
Migrate your database
Here comes the fun stuff! Now that your application is configured to talk to PlanetScale, you can create your first migration.
- Create a Rails migration and call it
This rails command begins the migration for your table that is currently empty and generates a Ruby file that’ll be named something like this:
- Fill in the body of this skeleton file with a few more relevant details, such as a user's name and email.
- Run your migration:
- Now, give it a whirl to make sure you can query the new table with the
Promote your main branch to a production branch
A production branch is a highly available, protected database branch. Direct schema changes (
DELETE) are not allowed on production branches to prevent accidental data loss and must be applied via deploy requests.
Congratulations! You're ready to develop your Rails application against PlanetScale.
In this tutorial, you created a simple Rails application named blog and connected it to a PlanetScale database.
If you're interested in learning how to secure your application's connection to PlanetScale, please read Connecting to PlanetScale securely.
Now that you've successfully connected your Rails app to PlanetScale, it's time to make more schema changes to your tables! Learn more about how PlanetScale allows you to make non-blocking schema changes to your database, or how to keep your schema_migrations table up-to-date between development and production branches with automatic schema migrations.