Docs
Everything NexQL does, in one place.
Start with the setup guide, read how a feature works, or look up any of the 325 commands and 71 settings. The reference is generated from the extension itself, so it lists what ships.
New here?Getting startedInstall NexQL, add a connection and run your first query.Looking for one?Search all 325 commandsFilter by name, id or where you find it.Tuning something?Search all 71 settingsDefaults, allowed values and a settings.json line to copy.
Guides
Task by task, with the exact steps.
Connect to Neon, Supabase, RDS and other managed PostgresAdd a hosted PostgreSQL database with the right platform preset, SSL mode and endpoint, then check it with Test Connection.Connect through an SSH tunnel or with SSL certificatesReach a database in a private network through a bastion host, or verify the server with a CA certificate and optional client certificate.Set up production guardrailsTag production connections, turn on read-only mode, and get warnings and confirmation prompts before anything destructive runs.Use connection profilesSwitch a notebook between safety presets such as read-only with a row limit, and share your profiles as a JSON file.
Features
How each part of NexQL works, step by step.
Connect
FreeSentinel safetyEnvironment tags, read-only mode and a risk score before destructive SQL runs.Pro, SingularityCloud syncEnd-to-end encrypted sync of connections, saved queries and notebooks.
Explore
FreeDatabase explorerBrowse connections, databases, schemas and 16+ object types without leaving VS Code.Pro, SponsorVisual schema toolsTable designer, schema diff, ERD and an import wizard, all as editor tabs.
Query
FreeSQL notebooksMix SQL cells and markdown in a .pgsql file, run them, and keep the file in git.Pro, free AI includedSQL assistantAsk in plain English. The assistant grounds on your live schema and never runs SQL for you.
Analyze
Reference, by area
Every command and setting sits in one area. Open an area to see what is in it and where to find each item.
ProConnections & safetyAdd, edit, group and switch connections; Sentinel environment cues.24 commands · 11 settingsProfilesCreate, switch, export and import connection profiles.5 commandsExplorer & objectsBrowse, inspect and search objects in the tree and the Definition Viewer.59 commands · 4 settingsObject managementCreate, edit, drop and maintain tables, views, roles and other objects.101 commandsScripts & templatesGenerate SELECT, INSERT, UPDATE, DELETE and DDL scripts from the tree.27 commands ProNotebooks & queriesSQL notebooks, Query Tool, Query Studio, psql and the SQL formatter.18 commands · 11 settingsResults & exportResult limits, binary display, streaming and exporting.4 commands · 5 settingsSaved queries & historySave, search, load and share queries; query history.17 commands · 1 setting ProSchema toolsTable designer, ERD, schema diff, data import, DBML and the database index.13 commands · 2 settings ProPerformance & Plan StudioEXPLAIN, index usage, table activity and statistics.9 commands · 1 setting ProDashboardThe live database dashboard and the LISTEN/NOTIFY monitor.4 commands ProAI / NexQL BotNexQL Bot, Ask AI, query generation and AI provider settings.9 commands · 19 settings ProMCPSettings for the NexQL MCP server the extension can start.4 settings ProBackup & restoreBack up and restore a database.3 commands ProSyncCloud sync for notebooks and saved items, with workspace sharing.21 commands · 5 settings ProSettings, license & helpSettings hub, What's New and license commands.6 commandsDiagnosticsDebug logging, telemetry and server configuration.5 commands · 8 settings
Reference
OverviewReferenceCommands, settings, shortcuts, sidebar views and walkthroughs.Commands325 commandsWhere to find each one and its keyboard shortcut.Settings71 settingsType, default, allowed values and a settings.json snippet.ShortcutsKeyboard shortcutsDefault keybindings for Windows, Linux and macOS.