;
};
## Getting Started
Make sure to first [set up your PlanetScale developer environment](/docs/cli/planetscale-environment-setup). Once you've installed the `pscale` CLI, you can interact with PlanetScale and manage your databases straight from the command line.
## The `deploy-request` command
This command allows you to create, review, diff, and manage deploy requests for your Vitess clusters. This command is not currently available for Postgres database clusters.
**Usage:**
```bash theme={null}
pscale deploy-request
```
Your database must have a production branch with [safe migrations](/docs/vitess/schema-changes/safe-migrations) enabled before you can create a deploy request.
### Available sub-commands
| Sub-command | Sub-command flags | Description | **Product** |
| :------------------------------------------------ | :-------------------------------------------------------------------------------------- | :--------------------------------------------------------- | :---------- |
| `apply ` | | Trigger a deploy request to swap over to the new schema. | Vitess |
| `cancel ` | | Cancel a deploy request. | Vitess |
| `close ` | | Close the specified deploy request. | Vitess |
| `create ` | `--into `, `--notes `, `--enable-auto-apply`, `--disable-auto-apply` | Create a new deploy request. | Vitess |
| `deploy ` | `--instant`, `--strategy ` | Deploy the specified deploy request. | Vitess |
| `deployment ` | | Show the deployment for a deploy request. | Vitess |
| `diff ` | `--web` | Show the diff of the specified deploy request. | Vitess |
| `edit ` | `--enable-auto-apply`, `--disable-auto-apply`, `--auto-delete-branch` | Alias for `update`. | Vitess |
| `force-cutover ` | `--force` | Force cutover when a migration is delayed by a table lock. | Vitess |
| `list ` | `--web` | List all deploy requests for a database. | Vitess |
| `operations ` | | List deploy operations for a deploy request. | Vitess |
| `queue ` | | Show the deploy queue for a database. | Vitess |
| `revert ` | | Revert a deployed deploy request. | Vitess |
| `review ` | `--web`, `--approve`, `--comment ` | Approve or comment on a deploy request. | Vitess |
| `reviews ` | | List reviews for a deploy request. | Vitess |
| `show ` | `--web` | Show the specified deploy request. | Vitess |
| `skip-revert ` | | Skip and close a pending deploy request revert. | Vitess |
| `storage-check ` | | Check storage readiness for a deploy request. | Vitess |
| `throttler show ` | | Show throttler configuration for a deploy request. | Vitess |
| `throttler update ` | `--ratio `, `--configuration ` | Update throttler configuration for a deploy request. | Vitess |
| `unblock ` | | Unblock the deploy queue after a failed deploy or revert. | Vitess |
| `update ` | `--enable-auto-apply`, `--disable-auto-apply`, `--auto-delete-branch` | Update settings on a deploy request. | Vitess |
> \* *Flag is required*
The value `` represents the deploy request number (not to be confused with `id`). To see a deploy request number, run `pscale deploy-request list `.
You can also find the number in the PlanetScale dashboard in the URL of the specified deploy request: `https://app.planetscale.com///deploy-requests/`.
#### 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 | Description | Applicable sub-commands |
| :--------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :---------------------- |
| `--into ` | Specify that the new deploy request deploy to a specified branch. Default is `main`. | `create` |
| `--notes ` | A note describing the deploy request. Acts as the first comment. | `create` |
| `--enable-auto-apply` | Enable auto-apply for this deploy request. When enabled, the deploy request will swap over to the new schema once ready. | `create`, `update` |
| `--disable-auto-apply` | Disable auto-apply for this deploy request. If neither flag is provided, the setting is inherited from the previous deploy request. | `create`, `update` |
| `--auto-delete-branch` | Delete the source branch after the deploy request completes (`--auto-delete-branch=false` to keep it). | `create`, `update` |
| `--web` | Perform the action in your web browser | `diff`, `list`, `show` |
| `--approve` | Approve a deploy request | `review` |
| `--comment ` | Leave a comment on a deploy request | `review` |
| `--instant` | Deploy a deploy request using MySQL's built-in ALGORITHM=INSTANT option. Deployment will be faster, but cannot be reverted. | `deploy` |
| `--strategy ` | Deployment strategy. `serial` (default) joins the deploy queue. `parallel` runs alongside the queue. See [Parallel deployments](/docs/vitess/schema-changes/deploy-requests#parallel-deployments). | `deploy` |
| `--force` | Skip the confirmation prompt and force cutover now. | `force-cutover` |
| `--ratio ` | Throttler ratio between 0 and 95 applied to all eligible keyspaces. 0 disables throttling; 95 slows migrations the most. | `throttler update` |
| `--configuration ` | Per-keyspace throttler ratio as `keyspace=ratio` (repeatable). Use instead of `--ratio`, not together. | `throttler update` |
### Available flags
| Flag | Description |
| :-------------------------- | :----------------------------------------------------------------- |
| `-h`, `--help` | Get help with the `deploy-request` command |
| `--org ` | Specify the organization for the deploy request you're acting upon |
### Global flags
| Command | Description |
| :------------------------------ | :----------------------------------------------------------------------------------- |
| `--api-token ` | The API token to use for authenticating against the PlanetScale API. |
| `--api-url ` | The base URL for the PlanetScale API. Default is `https://api.planetscale.com/`. |
| `--config ` | Config file. Default is `$HOME/.config/planetscale/pscale.yml`. |
| `--debug` | Enable debug mode. |
| `-f`, `--format ` | Show output in a specific format. Possible values: `human` (default), `json`, `csv`. |
| `--no-color` | Disable color output. |
| `--service-token ` | The service token for authenticating. |
| `--service-token-id ` | The service token ID for authenticating. |
## Examples
### The `deploy-request` command with `review` subcommand and `--comment` flag
**Command:**
```bash theme={null}
pscale deploy-request review 1 --comment 'Lets wait on this.'
```
**Output:**
A comment is added to the deploy request ``/1.
### The `deploy-request` command with `force-cutover` subcommand
The final step of a migration requires a brief table lock. Long-running transactions can block that lock and delay completion. PlanetScale retries for up to 1 hour, then forces cutover automatically. Use this command to skip the wait. It kills long-running transactions that are blocking the table lock so the migration can finish.
Only allowed when the deployment state is `in_progress_cutover`. See [Aggressive cutover](/docs/vitess/schema-changes/aggressive-cutover).
**Command:**
```bash theme={null}
pscale deploy-request force-cutover
```
**Output:**
Successfully requested force cutover for deploy request ``/``. Vitess will attempt again momentarily.
### The `deploy-request` command with `throttler update` subcommand
Adjust the migration throttler for a single deploy request. This is per deploy request, not the [database-level throttler](/docs/cli/database#database-level-vitess-migration-throttler). Use `--ratio` for one ratio across all eligible keyspaces, or `--configuration` for per-keyspace ratios.
**Command:**
```bash theme={null}
pscale deploy-request throttler update --ratio 25
```
**Output:**
The throttler configuration for deploy request ``/`` is updated.
### The `deploy-request` command with `unblock` subcommand
When a deployment or revert errors, PlanetScale blocks the deploy queue as a precaution. This is the same
action as **Unblock deploy queue** in the dashboard. It does not apply a gated deploy, which is
[`deploy-request apply`](/docs/cli/deploy-request), and it does not fix a schema that failed deploy checks.
**Command:**
```bash theme={null}
pscale deploy-request unblock
```
### The `deploy-request` command with `update` subcommand
Changes settings on an existing deploy request. At least one flag is required, and flags you leave off are
not sent. `edit` is an alias for this command.
**Command:**
```bash theme={null}
pscale deploy-request update --enable-auto-apply
pscale deploy-request update --auto-delete-branch
pscale deploy-request update --auto-delete-branch=false
```
## Need help?
Get help from [the PlanetScale Support team](https://planetscale.com/contact?initial=support), or join our [Discord community](https://pscale.link/community) to see how others are using PlanetScale.