Release PlanetScale Discovery Tools v2.0.0 · planetscale/ps-discovery

PlanetScale Discovery Tools v2.0.0
Release Date: 2026-09-15

Quick Start

Extract the archive:

unzip ps-discovery-2.0.0.zip
cd ps-discovery-2.0.0

Run the setup script:
```
chmod +x setup.sh
./setup.sh
```
Fill in config.yaml (created by setup.sh), then run discovery
(see INSTALL.txt for options):
```
./ps-discovery
```

Query workload capture. A new opt-in ps-discovery workload subcommand records a PostgreSQL query workload over a few days from cron and writes a bundle for the PlanetScale migration team to plan a sharding scheme from. See Workload Capture and Workload Bundle Format.
Query log capture, for transaction shapes and per-value skew. pg_stat_statements records statements rather than transactions and normalizes every literal, so it cannot say which tables one transaction writes together, or how unevenly a candidate shard key's values are accessed. Both answers are in the server's own query log, and collect can now read it. See Capturing transaction shapes and values.
PlanetScale cloud discovery provider. Records the current PlanetScale Postgres estate: organizations, databases, branches, the cluster size and SKU each branch runs, and branch storage usage against capacity. Postgres databases only at this time.

For detailed usage instructions, see README.md
For provider-specific setup, see docs/providers/