PlanetScale CLI commands: workflow
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 workflow command
This command allows you to create and manage workflows for PlanetScale databases, including creating workflows, listing them, and performing actions like traffic switching and cutover.
Usage:
pscale workflow <SUB-COMMAND> <FLAG>
Available sub-commands
| Sub-command | Sub-command flags | Description |
|---|---|---|
cancel <DATABASE_NAME> <WORKFLOW_NUMBER> | --force | Cancel a workflow that is in progress |
complete <DATABASE_NAME> <WORKFLOW_NUMBER> | Mark a workflow as complete | |
create <DATABASE_NAME> <BRANCH_NAME> | --defer-secondary-keys, --global-keyspace <KEYSPACE_NAME>, -i, --interactive, --name <WORKFLOW_NAME>, --on-ddl <ACTION>, --source-keyspace <KEYSPACE_NAME>, --tables <TABLE_NAMES>, --target-keyspace <KEYSPACE_NAME> | Create a new workflow within a branch |
cutover <DATABASE_NAME> <WORKFLOW_NUMBER> | --force | Completes the workflow, cutting over all traffic to the target keyspace |
list <DATABASE_NAME> | List all of the workflows for a PlanetScale database | |
retry <DATABASE_NAME> <WORKFLOW_NUMBER> | Retry a workflow that has been stopped or failed | |
reverse-cutover <DATABASE_NAME> <WORKFLOW_NUMBER> | Reverse the cutover of a workflow back to the source keyspace | |
reverse-traffic <DATABASE_NAME> <WORKFLOW_NUMBER> | Route queries back to the source keyspace for a specific workflow | |
show <DATABASE_NAME> <WORKFLOW_NUMBER> | Show a specific workflow for a PlanetScale database | |
switch-traffic <DATABASE_NAME> <WORKFLOW_NUMBER> | --force, --replicas-only | Route queries to the target keyspace for a specific workflow |
verify-data <DATABASE_NAME> <WORKFLOW_NUMBER> | Verify data consistency for a specific workflow |
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 flag | Type | Description | Applicable sub-commands |
|---|---|---|---|
--defer-secondary-keys | boolean | Don't create secondary indexes for tables until they've been copied (default true) | create |
--force | boolean | Force the operation without prompting for confirmation | cancel, cutover, switch-traffic |
--global-keyspace <KEYSPACE_NAME> | string | Choose an unsharded keyspace where sequence tables will be created for any workflow table that contains AUTO_INCREMENT | create |
-i, --interactive | boolean | Create the workflow in interactive mode | create |
--name <WORKFLOW_NAME> | string | Name of the workflow | create |
--on-ddl <ACTION> | string | Action to take when a DDL statement is encountered during a running workflow. Options: EXEC, EXEC_IGNORE, STOP, IGNORE (default "STOP") | create |
--replicas-only | boolean | Route read queries from the replica and read-only tablets to the target keyspace | switch-traffic |
--source-keyspace <KEYSPACE_NAME> | string | Keyspace where the tables will be copied from | create |
--tables <TABLE_NAMES> | strings | Tables to migrate to the target keyspace | create |
--target-keyspace <KEYSPACE_NAME> | string | Keyspace where the tables will be copied to | create |
Available flags
| Flag | Description |
|---|---|
-h, --help | View help for workflow command |
--org <ORGANIZATION_NAME> | The organization for the current user |
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. |
Need help?
Get help from the PlanetScale Support team, or join our GitHub discussion board to see how others are using PlanetScale.