PostgreSQL Workbench documentation

PostgreSQL Workbench documentation covers the complete PostgreSQL development workflow in VS Code: schema navigation, SQL Scratchpads, editable Data Views, pgTAP coverage, PL/pgSQL debugging, and the standalone DAP server.

Start with a development database

1. Run PostgreSQL Workbench: Add Connection. Several Connections can stay open at once; each one keeps its own index, Cockpit scope, and Scratchpads.
2. Expand the Connection, then its database: Schemas indexes PostgreSQL structure automatically on connect. Run Reindex Database on that Connection whenever you need a fresh snapshot.

For a disposable local environment, run PostgreSQL Workbench: Start Local Debug Database (Docker). PostgreSQL 17 and 127.0.0.1:5432 are the defaults; database, user, and password are all postgres.

Use those fixed credentials only for a local container. Never expose it on 0.0.0.0 or a remote host.

Choose a guide

• Workbench Cockpit — index structure, navigate relations, and understand every control.
• SQL scratchpads — bind notebooks, execute SQL, and work safely with results.
• Data View — open tables, views, and results in an editable grid, compose the query, and write rows back.
• SQL authoring — format, complete, and compose PostgreSQL SQL from one indexed context.
• Run, debug, and deploy SQL — understand the action matrix for Scratchpads, free SQL files, and managed PostgreSQL sources.
• pgTAP and coverage — discover tests, calculate coverage, and understand the limits.
• PL/pgSQL debugger — prepare PostgreSQL, launch sessions, step, and inspect values.
• Standalone DAP server — integrate the debugger engine with another editor or DAP client.
• MCP server and project integration — manage the local server from Settings, install Codex and Claude Code configurations, or run independently.
• Commands and settings — browse the complete generated reference.
• Measured performance — review reproducible indexing measurements on synthetic ERP-scale PostgreSQL catalogs.