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
PostgreSQL Workbench: Add Serverpostgresql-workbench.addServer
PostgreSQL Workbench: Set Database Context Activepostgresql-workbench.useDatabaseContextAsActive
PL/pgSQL: Start Local Debug Database (Docker)postgresql-workbench.startDockerDebugDatabase
Remove Serverpostgresql-workbench.removeServer
Connectpostgresql-workbench.connectServer
Disconnectpostgresql-workbench.disconnectServer
Edit Serverpostgresql-workbench.editServer
Change Passwordpostgresql-workbench.changePassword
PL/pgSQL: Pick Connectionpostgresql-workbench.pickConnection
PL/pgSQL: Refreshpostgresql-workbench.refreshTree
PL/pgSQL Workbench: Reindex Active Databasepostgresql-workbench.indexActiveDatabase
PostgreSQL Workbench: Configure Schema Synchronizationpostgresql-workbench.configureWorkbenchSchemaSync
PostgreSQL Workbench: Provision Schema Synchronizationpostgresql-workbench.provisionWorkbenchSchemaSync
PostgreSQL Workbench: Remove Schema Synchronization Provisioningpostgresql-workbench.removeWorkbenchSchemaSyncProvisioning
PostgreSQL Workbench: Search Database Objectspostgresql-workbench.searchDatabaseObjects
Open PostgreSQL Definitionpostgresql-workbench.openDatabaseObject
Reveal PostgreSQL Object in Workbench Treepostgresql-workbench.revealDatabaseObjectInTree
Open PostgreSQL Cockpitpostgresql-workbench.openDatabaseGraph
PostgreSQL Object Actions...postgresql-workbench.showObjectActions
PostgreSQL Workbench: Execute SQL Selectionpostgresql-workbench.executeSqlSelection
PostgreSQL Workbench: New SQL Scratchpadpostgresql-workbench.newSqlNotebook
Open SQL Scratchpadpostgresql-workbench.openSqlNotebook
Rename SQL Scratchpadpostgresql-workbench.renameSqlNotebook
Delete SQL Scratchpadpostgresql-workbench.deleteSqlNotebook
Duplicate SQL Scratchpadpostgresql-workbench.duplicateSqlNotebook
Export SQL Scratchpad...postgresql-workbench.exportSqlNotebook
Refresh SQL Scratchpadspostgresql-workbench.refreshSqlNotebooks
PostgreSQL Workbench: Rebind Scratchpadpostgresql-workbench.changeSqlNotebookConnection
PostgreSQL Workbench: Reconnect Scratchpad Bindingpostgresql-workbench.reconnectSqlNotebook
PostgreSQL Workbench: Use Binding as Activepostgresql-workbench.useSqlNotebookBindingAsActive
PostgreSQL Workbench: Compare Routine with Databasepostgresql-workbench.compareRoutineWithDatabase
PL/pgSQL: Refresh pgTAP Testspostgresql-workbench.refreshTests
Show pgTAP Testspostgresql-workbench.revealRoutineTests
PL/pgSQL: Export Last Coveragepostgresql-workbench.exportCoverage
PL/pgSQL: Check Server Requirementspostgresql-workbench.checkRequirements
Terminate Debug Sessions...postgresql-workbench.manageDebugSessions
Debugpostgresql-workbench.debugFromTree
Open Sourcepostgresql-workbench.openFunction
PL/pgSQL: Debug Function/Procedurepostgresql-workbench.debugDefinition
PL/pgSQL: Debug Callpostgresql-workbench.debugCall
PL/pgSQL Results: Copy Captured Resultpostgresql-workbench.results.copy
PL/pgSQL Results: Export Captured Resultpostgresql-workbench.results.export
PL/pgSQL Results: Clear Historypostgresql-workbench.results.clear

Settings

SettingDefaultDescription
postgresql-workbench.workbench.schemaSync.enabledfalseOpt in to automatic PostgreSQL schema synchronization for DatabaseContexts without an explicit connection 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.commandTimeoutMs30000Maximum duration in milliseconds for one Code Moniker daemon command used by Workbench indexing, navigation, graph queries, and debugger syntax analysis. Changes apply to the next extension session.
postgresql-workbench.results.maxRows200Maximum number of PostgreSQL rows retained for SQL selections and debug results. It is also used as the notebook page size when results.pageSize has not been configured explicitly.
postgresql-workbench.results.pageSize200Number of rows loaded initially and by each Next action for cursor-backed SQL notebook results.
postgresql-workbench.results.maxCachedRows1000Maximum number of cursor-backed notebook rows retained for Previous navigation. Load all explicitly bypasses this limit.
postgresql-workbench.results.cursorIdleTimeoutSeconds300Close an idle PostgreSQL notebook result cursor after this many seconds.
postgresql-workbench.results.nonPagedMaxRows200Maximum rows retained for notebook statements that cannot be paged safely, including data-modifying statements with RETURNING.
postgresql-workbench.results.autoRevealtrueAutomatically reveal the PL/pgSQL Results panel without taking keyboard focus when a debugged SQL call completes or fails.
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.