PlanetScale CLI commands: maintenance

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 `maintenance` command

List and show maintenance schedules for a Vitess database on an Enterprise plan. Maintenance schedules define when PlanetScale can perform planned maintenance (for example Vitess or MySQL version updates). This command is read-only. --org is required. Usage:

pscale maintenance <SUB-COMMAND> <FLAG>

Available sub-commands

Sub-command	Description	Product
`list <DATABASE_NAME>`	List maintenance schedules for a database	Vitess
`show <DATABASE_NAME> <SCHEDULE_ID>`	Show a maintenance schedule	Vitess
`windows <DATABASE_NAME> <SCHEDULE_ID>`	List maintenance windows for a schedule	Vitess

Available flags

Flag	Description
`-h`, `--help`	View help for the `maintenance` command
`--org <ORGANIZATION_NAME>`	The organization for the current user (required)

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

List schedules

pscale maintenance list <DATABASE_NAME> --org <ORGANIZATION_NAME>

Show a schedule

pscale maintenance show <DATABASE_NAME> <SCHEDULE_ID> --org <ORGANIZATION_NAME>

List windows for a schedule

pscale maintenance windows <DATABASE_NAME> <SCHEDULE_ID> --org <ORGANIZATION_NAME>

Need help?

Get help from the PlanetScale Support team, or join our Discord community to see how others are using PlanetScale.

Introduction

Using the pscale CLI

CLI command reference

PlanetScale CLI commands: maintenance

Getting Started

The `maintenance` command

Available sub-commands

Available flags

Global flags

Examples

List schedules

Show a schedule

List windows for a schedule

Need help?

​Getting Started

​The maintenance command

​Available sub-commands

​Available flags

​Global flags

​Examples

​List schedules

​Show a schedule

​List windows for a schedule

​Need help?

Getting Started

The `maintenance` command

Available sub-commands

Available flags

Global flags

Examples

List schedules

Show a schedule

List windows for a schedule

Need help?