Creating a database

This document explains how to create a database using the PlanetScale console.


Before you can create a database, you must first create a cluster.


To create a database, you will complete the following steps:

Step 1: Open the Overview page for a cluster.

When you create a new cluster, this page opens automatically. Otherwise, log in to the PlanetScale console.

Clusters view

Step 2: Select a cluster.

Click on the name of the cluster where your database will run. This will open the overview for the cluster.

Step 3: Click Create Database.

In the cluster overview, click the Create Database button.

Create your first Database

This opens the Create New Database pane.

Step 4: Name your database.

In the Create New Database pane, enter the name of your new database.

Create New Database pane

Database names can only contain lowercase alphanumeric characters.

By default, PlanetScale deploys your database immediately on creation. If you deselect this option, you have the option to deploy the database from the database Overview later.

Step 5: Select a region.

In the Create New Database pane, select a region from the Regions dropdown. You can choose from the regions that you selected for the cluster where this database will run.

Select region dropdown

Step 6: Assign resources to your instance.

Under Instance Configuration, select the amount of CPU, RAM, and storage for each instance.

Instance Configuration section

The Cost per instance calculator below shows the hourly cost for the current instance configuration.

Step 7: Choose the number of instances

Under Number of instances, choose the number of replicas and analytics instances per shard.

Number of instances section

The Cost per shard calculator below shows the hourly cost for the current number of instances per shard.

Note: PlanetScale does not recommend databases with fewer than three replicas per shard for production environments, because they may not survive a partial region outage and are subject to downtimes of up to 30 seconds during scheduled maintenance procedures.

Step 8: Choose the number of shards

Under Sharding, choose Unsharded or Sharded. For a sharded database, select the number of shards.

Sharding section

The Total cost calculator below shows the overall hourly cost of your database. Because each shard contains the selected number of instances, the total cost of the database is the number of shards multiplied times the number of instances.

Step 9: Click Create Database.

By default, your database deploys immediately. This process can take up to several minutes.

Once your database is ready, the Cluster Overview displays its status as Deployed.

Step 10 (Optional): Click your database name.

This opens the Database Overview for your new database.

Step 11 (Optional): Click Deploy.

If you deselected Deploy on creation in Step 4 above, you can deploy it at any time from the Database Overview.

See also