PlanetScale CLI commands: size

Lists the sizes for various components within PlanetScale.

Usage

pscale size [command]

Available commands

Command	Product	Description
`cluster`	Postgres, Vitess, Neki	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]

Alias: clusters

Available sub-commands

Command	Product	Description
`list`	Postgres, Vitess, Neki	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]

Alias: ls

Available flags

Flag	Description
`--engine string`	Filter cluster sizes by database engine. Supported values: `mysql`, `postgresql`, `neki`. Omit to list all engines.
`--external`	View cluster sizes for external Vitess keyspaces. Mutually exclusive with `--metal`. Only valid with the MySQL engine.
`-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

pscale size cluster list

Omitting --engine lists Vitess, Neki, and Postgres sizes.

List Vitess cluster sizes explicitly

pscale size cluster list --engine mysql

List PostgreSQL cluster sizes

pscale size cluster list --engine postgresql

List Neki cluster sizes

pscale size cluster list --engine neki

Neki admin and router SKUs are listed separately with pscale branch admin sizes and pscale branch router sizes. See Neki cluster sizing.

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

pscale size cluster list --metal

For Postgres or Neki Metal clusters, use:

pscale size cluster list --engine postgresql --metal
pscale size cluster list --engine neki --metal

List external keyspace cluster sizes

pscale size cluster list --external

--cluster-size is optional on create-external. Use these sizes with pscale keyspace create-external --cluster-size and pscale keyspace resize --cluster-size for external keyspaces. --external is MySQL/Vitess only. For more information about PlanetScale cluster sizes and pricing, see:

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: size

Usage

Available commands

Flags

Global flags

The `cluster` sub-command

Available sub-commands

The `list` sub-command

Available flags

Examples

List all available cluster sizes

List Vitess cluster sizes explicitly

List PostgreSQL cluster sizes

List Neki cluster sizes

List cluster sizes for a specific organization

List cluster sizes for a specific region

List PostgreSQL cluster sizes for a specific region

List Metal cluster sizes

List external keyspace cluster sizes

Need help?

​Usage

​Available commands

​Flags

​Global flags

​The cluster sub-command

​Available sub-commands

​The list sub-command

​Available flags

​Examples

​List all available cluster sizes

​List Vitess cluster sizes explicitly

​List PostgreSQL cluster sizes

​List Neki cluster sizes

​List cluster sizes for a specific organization

​List cluster sizes for a specific region

​List PostgreSQL cluster sizes for a specific region

​List Metal cluster sizes

​List external keyspace cluster sizes

​Need help?

Usage

Available commands

Flags

Global flags

The `cluster` sub-command

Available sub-commands

The `list` sub-command

Available flags

Examples

List all available cluster sizes

List Vitess cluster sizes explicitly

List PostgreSQL cluster sizes

List Neki cluster sizes

List cluster sizes for a specific organization

List cluster sizes for a specific region

List PostgreSQL cluster sizes for a specific region

List Metal cluster sizes

List external keyspace cluster sizes

Need help?