Dump a database to local files

backups & data

// what it does

Streams a full logical dump (schema + data) of a Vitess branch to a local directory over the secure proxy, parallelized with --threads. This is your export path: archiving, seeding another environment, or migrating off PlanetScale.

// shell

$ pscale database dump mydb main --output ./dump
$ pscale database dump mydb main --output ./dump --replica --threads 8

// gotcha

Vitess-only — for Postgres branches use pg_dump against a role's connection string. Dumping production reads production: use --replica to dump from a replica, or dump off-peak.

// resources