PlanetScale CLI commands: shell
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 shell command
This command opens a secure MySQL shell instance to your database so that you can manipulate it from the command line.
It uses the MySQL command line client (mysql), which must be installed prior to use.
Usage:
pscale shell <DATABASE_NAME> <BRANCH_NAME> <FLAG>
If no branch is specified, you'll be prompted to enter one. If only one branch exists on the database, you can leave off <BRANCH_NAME>.
Available flags
| Flag | Description |
|---|---|
-h, --help | View help for shell command |
--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. |
--org <ORGANIZATION_NAME> | The organization for the current user |
--remote-addr <ADDRESS> | PlanetScale database remote network address. By default, the remote address is automatically populated from the PlanetScale API. |
--role <ROLE> | Define the access level with a role |
Available roles for the --role flag are:
readerwriterreadwriteradmin
Global flags
| Command | Description |
|---|---|
--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. |
--debug | Enable debug mode. |
-f, --format <FORMAT> | Show output in a specific format. Possible values: human (default), json, csv. |
--no-color | Disable color output. |
--service-token <TOKEN> | The service token for authenticating. |
--service-token-id <TOKEN_ID> | The service token ID for authenticating. |
Examples
The shell command
Command:
pscale shell <DATABASE_NAME> <BRANCH_NAME>
Once the shell is opened, you can run SQL as expected.
Output:
DATABASE_NAME/BRANCH_NAME > DATABASE_NAME/BRANCH_NAME > show tables; +---------------+ | Tables_in_db | +---------------+ | users | +---------------+ DATABASE_NAME/BRANCH_NAME > exit;
Type exit to exit the shell.
Import an existing .sql file using the shell command
Command:
The following example assumes you have already ran the pscale shell command and you have the shell open to run a MySQL command.
To import an existing .sql file you may have available you would want to use the MySQL source command and provide it the path to your file:
DATABASE_NAME/BRANCH_NAME > source <YOUR_DUMP_FILE>.sql;
Output:
Your file should be imported as expected.
Note
When importing .sql dump files there are a few caveats to be aware of as sometimes the .sql file may have everything wrapped in a START TRANSACTION; / COMMIT; transaction which will result in the import timing out if it takes more than 20 seconds to complete due to our 20 second transaction timeout limit so you will want to make sure those are removed prior to beginning an import of the file.
Additionally, if your current schema requires our foreign key constraints support you may need to ensure it has been enabled within your database Settings area first before proceeding with your import.
Need help?
Get help from the PlanetScale Support team, or join our GitHub discussion board to see how others are using PlanetScale.