Your first check
From a working install to a read-only health report in under a minute.
Takes about a minute. Assumes installation is done and you have a reachable database.
What pgdba is, in three sentences
pgdba connects to your database, runs a registry of read-only health
checks, and prints a ranked report: every finding says what is wrong,
what it costs to ignore, and the exact SQL to fix it. You decide what to
apply — fixes only run when you pass --apply and approve them. It also
migrates databases server-to-server behind preflight gates, with
verification.
The three commands you will actually use:
| Command | What it does |
|---|---|
pgdba check |
The health report (read-only, always safe) |
pgdba check --apply |
Execute the fixes you approved |
pgdba migrate |
Server-to-server migration with gates |
Everything else — profiles, thresholds, webhooks, doctor — hangs off these.
Run your first check
$ pgdba check
Zero flags: the connection profile comes from pgdba-run.toml. You get
ranked findings in the terminal plus pgdba-report.md / pgdba-report.json,
with matching stable IDs, a duty-group triage view, and exit codes
suitable for cron:
- 0 OK — no warning-or-worse findings
- 1 WARNING — warning threshold reached
- 2 CRITICAL — critical threshold reached
- 3 UNKNOWN — config, connection, or apply error
Read one finding
Pick any finding ID and ask what it means in plain language:
$ pgdba why config.shared_buffers
$ pgdba check --explain-flag connection
Where to next
- Understand every flag and config key: flags reference
- Set up cron + webhooks: recurring mode
- Migrating servers: the migrate safe lane
- Checking many databases: run a fleet