pscale sql

Execute a single SQL query against a PlanetScale database branch using ephemeral credentials.

pscale sql is intended for agents and scripts. For interactive exploratory sessions, use pscale shell instead.

Common commands

# Read query with machine-readable output (default role is reader)
pscale sql <database> <branch> --org <org> --format json --query "SELECT 1"

# Read from replicas
pscale sql <database> <branch> --org <org> --format json --replica --query "SELECT count(*) FROM users"

# MySQL/Vitess: target a specific keyspace when needed
pscale sql <database> <branch> --org <org> --format json --keyspace <keyspace> --query "SELECT 1"