pgconfigurator
pgconfigurator

Documentation

pgconfigurator gives you opinionated defaults; these docs explain the opinions. Skim what's relevant, click through to the tools when you want to apply it.

What's here

  • Tuning guide — how to think about each parameter category, what we change vs. what we leave alone, and when the defaults break down.
  • Plan analysis guide — how to read an EXPLAIN plan, which signals to trust, and which common anti-patterns the analyzer detects.
  • Plan nodes reference — a plain-language page for every executor node (Seq Scan, Index Scan, Hash Join, Sort …): what it does, when the planner picks it, and whether it's a problem.
  • Parameter reference — how to tune the settings that matter (shared_buffers, work_mem, max_wal_size …), each with a live recommendation computed in your browser.
  • Query tuning cookbook — six representative slow-plan patterns, with the snippet that points at the problem and the fix that works.
  • Integrations & developer tooling — a GitHub Action for CI, a psql one-liner, the CLI, and a browser bookmarklet.
  • HTTP API reference — curl examples for /analyze, /generate, /render, /narrate, and /describe.
  • FAQ — short answers to the questions we hear most.

Need a human?

The tool covers ~80% of common situations. For the remaining 20% — odd workloads, gnarly migrations, 3 AM incidents — there are humans who do this for a living. Talk to CYBERTEC engineers →