PostgreSQL Workbench
Install extension

Documentation / Commands and settings

Generated reference

Commands and settings.

This page is generated from vscode-extension/package.json at build time, so names, identifiers, defaults, and descriptions stay aligned with the extension.

Commands

CommandIdentifier
Manage Connectionspostgresql-workbench.manageConnections
Add Connectionpostgresql-workbench.addConnection
Start Local Debug Database (Docker)postgresql-workbench.startDockerDebugDatabase
Removepostgresql-workbench.removeConnection
Connectpostgresql-workbench.connectConnection
Disconnectpostgresql-workbench.disconnectConnection
Editpostgresql-workbench.editConnection
Renamepostgresql-workbench.renameConnection
Change Passwordpostgresql-workbench.changePassword
Pick Connectionpostgresql-workbench.pickConnection
Refresh Connectionspostgresql-workbench.refreshTree
Reindex Databasepostgresql-workbench.indexDatabase
Cancel Indexingpostgresql-workbench.cancelDatabaseIndex
Index Associationpostgresql-workbench.indexAssociation
Configurepostgresql-workbench.configureWorkbenchSchemaSync
Provisionpostgresql-workbench.provisionWorkbenchSchemaSync
Remove Provisioningpostgresql-workbench.removeWorkbenchSchemaSyncProvisioning
Searchpostgresql-workbench.searchDatabaseObjects
Open Definitionpostgresql-workbench.openDatabaseObject
Open Graphpostgresql-workbench.openObjectGraph
Open Data Viewpostgresql-workbench.openDataView
Open Data View for Statementpostgresql-workbench.openDataViewForStatement
Revealpostgresql-workbench.revealDatabaseObjectInTree
Open Cockpitpostgresql-workbench.openDatabaseGraph
Actions...postgresql-workbench.showObjectActions
Execute SQL Selectionpostgresql-workbench.executeSqlSelection
New SQL Scratchpadpostgresql-workbench.newSqlNotebook
Openpostgresql-workbench.openSqlNotebook
Renamepostgresql-workbench.renameSqlNotebook
Deletepostgresql-workbench.deleteSqlNotebook
Duplicatepostgresql-workbench.duplicateSqlNotebook
Export...postgresql-workbench.exportSqlNotebook
Refreshpostgresql-workbench.refreshSqlNotebooks
Filter...postgresql-workbench.filterSqlNotebooks
Association...postgresql-workbench.changeSqlNotebookConnection
Reconnectpostgresql-workbench.reconnectSqlNotebook
Connectpostgresql-workbench.connectSqlNotebookAssociation
Mode AUTOpostgresql-workbench.setScratchpadAutoMode
Mode MANUALpostgresql-workbench.setScratchpadManualMode
Statement Timeout...postgresql-workbench.setScratchpadStatementTimeout
Commitpostgresql-workbench.commitScratchpadTransaction
Rollbackpostgresql-workbench.rollbackScratchpadTransaction
Change Cell Execution Intentpostgresql-workbench.setScratchpadCellExecutionIntent
Compare Routine with Databasepostgresql-workbench.compareRoutineWithDatabase
Refresh pgTAP Testspostgresql-workbench.refreshTests
Show pgTAP Testspostgresql-workbench.revealRoutineTests
Export Last Coveragepostgresql-workbench.exportCoverage
Check Connection Requirementspostgresql-workbench.checkRequirements
Terminate Debug Sessions...postgresql-workbench.manageDebugSessions
Debugpostgresql-workbench.debugFromTree
Open Sourcepostgresql-workbench.openFunction
Debug Function/Procedurepostgresql-workbench.debugDefinition
Debug Callpostgresql-workbench.debugCall
Choose Document Associationpostgresql-workbench.assignDocumentConnection
Run SQL Statementpostgresql-workbench.runSqlCall
Deploy Managed PL/pgSQL Routinepostgresql-workbench.deployManagedRoutine
Copy Captured Resultpostgresql-workbench.results.copy
Export Captured Resultpostgresql-workbench.results.export
Clear Historypostgresql-workbench.results.clear

Settings

SettingDefaultDescription
postgresql-workbench.sqlAuthoring.aliasStyle"fullName"Alias strategy used when PostgreSQL Workbench composes a query from dragged relations. Changes apply to the next composition.
postgresql-workbench.sqlAuthoring.syntaxMaxDepth1024Maximum PostgreSQL syntax-tree depth used to classify SQL safely before execution and composition. Code Moniker applies this client-selected budget without an additional server cap.
postgresql-workbench.sqlAuthoring.syntaxMaxNodes100000Maximum PostgreSQL syntax-tree nodes used to classify SQL safely before execution and composition. Increase this client-selected budget for exceptionally large SQL documents.
postgresql-workbench.sql.statementTimeoutMs60000Default PostgreSQL Statement timeout in milliseconds for SQL Scratchpads and free SQL documents. Each Scratchpad can persist its own override.
postgresql-workbench.workbench.schemaSync.enabledfalseOpt in to automatic PostgreSQL schema synchronization for Connections without an explicit override. Provisioning remains a separate confirmed action. Data changes (DML) never trigger synchronization.
postgresql-workbench.workbench.schemaSync.supportSchema"workbench"PostgreSQL schema containing the Workbench DDL notification functions. Event triggers remain database-level objects and are not contained by this schema.
postgresql-workbench.workbench.codeMoniker.commandTimeoutMs120000Maximum duration in milliseconds for a Code Moniker daemon command or workspace readiness transition used by Workbench indexing, navigation, graph queries, and debugger syntax analysis. Changes apply to the next extension session.
postgresql-workbench.workbench.graph.compactZoomThreshold0.8Zoom level below which PostgreSQL graph nodes switch from detailed cards to compact named cards. Changes apply immediately to an open graph.
postgresql-workbench.workbench.graph.compactNodeFontScale1.6Font scale used for object names in compact PostgreSQL graph nodes. Changes apply immediately to an open graph.
postgresql-workbench.workbench.graph.edgeLabelFontScale1.3Font scale applied to PostgreSQL graph edge labels. Changes apply immediately to an open graph.
postgresql-workbench.results.maxRows200Maximum number of PostgreSQL rows retained for SQL selections and debug results. It is also used as the Scratchpad page size when results.pageSize has not been configured explicitly.
postgresql-workbench.results.pageSize200Number of rows requested by each LIMIT/OFFSET result page.
postgresql-workbench.results.maxCellBytes262144Hard maximum number of UTF-8 bytes retained for one result cell. Grid display remains compact; inspection and export use the retained value.
postgresql-workbench.results.nonPagedMaxRows200Maximum rows retained for Scratchpad statements that cannot be paged safely, including data-modifying statements with RETURNING.
postgresql-workbench.results.autoRevealtrueAutomatically reveal the PostgreSQL Results panel without taking keyboard focus when a debugged SQL call completes or fails.
postgresql-workbench.dataView.hideKeyColumnstrue
postgresql-workbench.tests.patterns["*_ut.test_*","*_it.test_*"]Glob patterns used to discover pgTAP test functions, matched against schema.function. Matching functions must return SETOF text; zero-argument functions can be run automatically. Schemas containing matched tests are treated as test infrastructure for coverage mapping.
postgresql-workbench.coverage.include[]Glob patterns for routines eligible for coverage, matched against schema.name(identity arguments). An empty list includes all discovered routines.
postgresql-workbench.coverage.exclude[]Glob patterns for routines excluded from coverage, matched after the include patterns.
postgresql-workbench.coverage.maxRoutines200Maximum number of PL/pgSQL routines instrumented by one coverage request.
postgresql-workbench.coverage.maxOutputLines200Maximum number of TAP output lines attached to each VS Code test result.
postgresql-workbench.coverage.maxOutputBytes1048576Maximum TAP payload retained for one pgTAP test. Individual rows are truncated in PostgreSQL before transmission.
postgresql-workbench.coverage.maxParallelDatabases2Maximum number of independent PostgreSQL databases covered in parallel.
postgresql-workbench.coverage.timeoutMs300000Maximum duration in milliseconds for one database coverage suite, including rollback and cleanup.