Documentation Index
Fetch the complete documentation index at: https://planetscale.com/docs/llms.txt
Use this file to discover all available pages before exploring further.
Lists the sizes for various components within PlanetScale.
Usage
Available commands
| Command | Product | Description |
|---|
cluster | Postgres, Vitess | List the sizes for PlanetScale databases |
Flags
| Flag | Description |
|---|
-h, --help | Help for size |
--org string | The organization for the current user |
Global flags
| Command | Description |
|---|
--api-token string | The API token to use for authenticating against the PlanetScale API |
--api-url string | The base URL for the PlanetScale API. (default “<https://api.planetscale.com/>“) |
--config string | Config file (default is $HOME/.config/planetscale/pscale.yml) |
--debug | Enable debug mode |
-f, --format string | Show output in a specific format. Possible values: [human, json, csv] (default “human”) |
--no-color | Disable color output |
--service-token string | The service token for authenticating |
--service-token-id string | The service token ID for authenticating |
The cluster sub-command
List the sizes for PlanetScale databases.
Usage:
pscale size cluster [command]
cluster, clusters
Available sub-commands
| Command | Product | Description |
|---|
list | All | List the sizes that are available for a PlanetScale database |
The list sub-command
List the sizes that are available for a PlanetScale database. Use --engine to specify the database engine type.
Usage:
pscale size cluster list [flags]
list, ls
Available flags
| Flag | Description |
|---|
--engine string | The database engine to show cluster sizes for. Supported values: mysql, postgresql. Defaults to mysql. |
-h, --help | Help for list |
--metal | View cluster sizes and rates for clusters with metal storage |
--region string | View cluster sizes and rates for a specific region |
Examples
List all available cluster sizes (defaults to Vitess)
List Vitess cluster sizes explicitly
pscale size cluster list --engine mysql
List PostgreSQL cluster sizes
pscale size cluster list --engine postgresql
List cluster sizes for a specific organization
pscale size cluster list --org <ORG_NAME>
List cluster sizes for a specific region
pscale size cluster list --region <REGION_NAME>
List PostgreSQL cluster sizes for a specific region
pscale size cluster list --engine postgresql --region us-east
pscale size cluster list --metal
pscale size cluster list --engine postgresql --metal
Need help?
Get help from the PlanetScale Support team, or join our Discord community to see how others are using PlanetScale.
