Lists the sizes for various components within PlanetScale.

Usage

pscale size [command]

Available commands

CommandProductDescription
clusterPostgres, VitessList the sizes for PlanetScale databases

Flags

FlagDescription
-h, --helpHelp for size
--org stringThe organization for the current user

Global flags

CommandDescription
--api-token stringThe API token to use for authenticating against the PlanetScale API
--api-url stringThe base URL for the PlanetScale API. (default “<https://api.planetscale.com/>“)
--config stringConfig file (default is $HOME/.config/planetscale/pscale.yml)
--debugEnable debug mode
-f, --format stringShow output in a specific format. Possible values: [human, json, csv] (default “human”)
--no-colorDisable color output
--service-token stringThe service token for authenticating
--service-token-id stringThe service token ID for authenticating

The cluster sub-command

List the sizes for PlanetScale databases. Usage:
pscale size cluster [command]
Aliases: cluster, clusters

Available sub-commands

CommandProductDescription
listAllList 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]
Aliases: list, ls

Available flags

FlagDescription
--engine stringThe database engine to show cluster sizes for. Supported values: mysql, postgresql. Defaults to mysql.
-h, --helpHelp for list
--metalView cluster sizes and rates for clusters with metal storage
--region stringView cluster sizes and rates for a specific region

Examples

List all available cluster sizes (defaults to Vitess)

pscale size cluster list

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

List Metal cluster sizes (Vitess only)

pscale size cluster list --metal
For more information about PlanetScale cluster sizes and pricing, see:

Need help?

Get help from the PlanetScale Support team, or join our GitHub discussion board to see how others are using PlanetScale.