Skip to content

PlanetScale CLI commands - database

Use the PlanetScale CLI to create development branches, open deploy requests, and make non-blocking schema changes directly from your terminal.

Getting Started

Make sure to first set up your PlanetScale developer environment. Once you've installed the pscale CLI, you can interact with PlanetScale and manage your databases straight from the command line.

The database command

This command allows you to create, read, delete, dump, and restore databases.

Usage:

Terminal
Copied
pscale database <SUB-COMMAND> <FLAG>

Available sub-commands

Sub-commandSub-command flagsDescription
create <DATABASE_NAME>--notes <NOTES>, --region <REGION_NAME>, --webCreate a database with the specified name
delete <DATABASE_NAME>--forceDelete the specified database
dump <DATABASE_NAME> <BRANCH_NAME>--local-addr <ADDRESS>, --output <DIRECTORY_NAME>, --tables <TABLES_LIST>Backup and dump the specified database
list <DATABASE_NAME>List all databases in the current org
restore-dump <DATABASE_NAME> <BRANCH_NAME>--dir <DIRECTORY_NAME>*, --local-addr <ADDRESS>, --overwrite-tablesRestore the specified database from a local dump directory
show <DATABASE_NAME>--webRetrieve information about a database

* Flag is required

Sub-command flag descriptions

Some of the sub-commands have additional flags unique to the sub-command. This section covers what each of those does. See the above table for which context.

Sub-command flagDescriptionApplicable sub-commands
--notesAdd a description for the new databasecreate
--regionSpecify the region of the new database. Default is us-east.create
--forceDelete a database without confirmation.delete
--local-addr <ADDRESS>Local address to bind and listen for connections. By default the proxy binds to 127.0.0.1 with a random port.dump, restore-dump
--output <DIRECTORY_NAME>Output directory of the dump. By default the dump is saved to a folder in the current directory.dump
--tables <TABLES_LIST>Comma separated string of tables to dump. By default, all tables are dumped.dump
--dir <DIRECTORY_NAME>Directory containing the files to be used for the restore.restore-dump
--overwrite-tablesIf true, will attempt to DROP TABLE before restoring.restore-dump
--webPerform the action in your web browsershow

Available flags

FlagDescription
--hGet help with the database command
--org <ORGANIZATION_NAME>Specify the organization for the database you're acting upon

Global flags

CommandDescription
--api-token <TOKEN>The API token to use for authenticating against the PlanetScale API.
--api-url <URL>The base URL for the PlanetScale API. Default is https://api.planetscale.com/.
--config <CONFIG_FILE>Config file. Default is $HOME/.config/planetscale/pscale.yml.
--debugEnable debug mode.
-f, --format <FORMAT>Show output in a specific format. Possible values: human (default), json, csv.
--no-colorDisable color output.
--service-token <TOKEN>The service token for authenticating.
--service-token-id <TOKEN_ID>The service token ID for authenticating.

Examples

The database command with create subcommand and --notes flag

Command:

Terminal
Copied
pscale database create new-database --notes "This is my new database" --region <REGION_NAME>

Output:

Database new-database was successfully created.

Need help?

Get help from the PlanetScale support team, or join our GitHub discussion board to see how others are using PlanetScale.

Was this page useful?
Last updated on August 1, 2022
Help us improve this page
© 2022 PlanetScale Inc.