Skip to content

Vitess vs Postgres command docs#1091

Merged
mscoutermarsh merged 1 commit into
mainfrom
show-database-kind
Jul 25, 2025
Merged

Vitess vs Postgres command docs#1091
mscoutermarsh merged 1 commit into
mainfrom
show-database-kind

Conversation

@mscoutermarsh
Copy link
Copy Markdown
Member

Organizes the commands & documents which are vitess or postgres specific.

The API has also been updated to return an error message is someone does use a command which is not available for their database. For example:

pscale keyspace list pg main
Error: This endpoint is only available for Vitess databases.
exit status 2

Full help output

pscale is a CLI library for communicating with PlanetScale's API.

Usage:
  pscale [command]

Database management:
  backup         Create, list, show, and delete branch backups
  branch         Create, delete, diff, and manage branches
  database       Create, read, delete, and dump/restore databases

Vitess-specific commands:
  connect        Create a secure connection to a database and branch for a local client
  data-imports   Create, list, and delete branch data imports
  deploy-request Create, review, diff, revert, and manage deploy requests
  keyspace       List, show, and manage keyspaces
  password       Create, list, and delete branch passwords
  shell          Open a MySQL shell instance to a database and branch
  workflow       Manage the workflows for PlanetScale databases

Postgres-specific commands:
  role           Manage database roles for a Postgres database branch

Platform & account management:
  api            Performs authenticated calls against the PlanetScale API. Useful for scripting.
  audit-log      List audit logs
  auth           Login and logout via the PlanetScale API
  completion     Generate completion script for your shell
  mcp            Manage and use the MCP server
  org            List, show, and switch organizations
  ping           Ping public PlanetScale database endpoints
  region         List regions
  service-token  Create, list, and manage access for service tokens
  signup         Signup for a new PlanetScale account
  size           Lists the sizes for various components within PlanetScale

Additional Commands:
  help           Help about any command

Flags:
      --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")
  -h, --help                      help for pscale
      --no-color                  Disable color output
      --service-token string      Service Token for authenticating.
      --service-token-id string   The Service Token ID for authenticating.
      --version                   Show pscale version

Use "pscale [command] --help" for more information about a command.

Organizes the commands & documents which are vitess or postgres specific.

```
pscale is a CLI library for communicating with PlanetScale's API.

Usage:
  pscale [command]

Database management:
  backup         Create, list, show, and delete branch backups
  branch         Create, delete, diff, and manage branches
  database       Create, read, delete, and dump/restore databases

Vitess-specific commands:
  connect        Create a secure connection to a database and branch for a local client
  data-imports   Create, list, and delete branch data imports
  deploy-request Create, review, diff, revert, and manage deploy requests
  keyspace       List, show, and manage keyspaces
  password       Create, list, and delete branch passwords
  shell          Open a MySQL shell instance to a database and branch
  workflow       Manage the workflows for PlanetScale databases

Postgres-specific commands:
  role           Manage database roles for a Postgres database branch

Platform & account management:
  api            Performs authenticated calls against the PlanetScale API. Useful for scripting.
  audit-log      List audit logs
  auth           Login and logout via the PlanetScale API
  completion     Generate completion script for your shell
  mcp            Manage and use the MCP server
  org            List, show, and switch organizations
  ping           Ping public PlanetScale database endpoints
  region         List regions
  service-token  Create, list, and manage access for service tokens
  signup         Signup for a new PlanetScale account
  size           Lists the sizes for various components within PlanetScale

Additional Commands:
  help           Help about any command

Flags:
      --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")
  -h, --help                      help for pscale
      --no-color                  Disable color output
      --service-token string      Service Token for authenticating.
      --service-token-id string   The Service Token ID for authenticating.
      --version                   Show pscale version

Use "pscale [command] --help" for more information about a command.
```
@mscoutermarsh mscoutermarsh requested a review from a team as a code owner July 25, 2025 19:08
@mscoutermarsh mscoutermarsh merged commit 064cb71 into main Jul 25, 2025
1 check passed
@mscoutermarsh mscoutermarsh deleted the show-database-kind branch July 25, 2025 19:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants