#Database Client

All-in-one database management extension for Visual Studio Code. Connect to SQL and NoSQL databases, browse and edit data, run queries with IntelliSense, manage SSH servers, Docker, and remote files — without leaving the editor.

Website: database-client.com · Docs: https://database-client.com/docs

##Telemetry

The extension collects anonymous usage data to help improve the product. Read the Privacy Policy for details.

Telemetry follows VS Code's telemetry settings. You can also disable it independently:

"database-client.telemetry.usesOnlineServices": false

##Getting Started

###Connect

1. ›Open the Database panel in the sidebar.
2. ›Click the + button.
3. ›Select a service type, fill in the connection details, and click Connect.

Connections support SSH tunnel, SSL/TLS, SOCKS proxy, and HTTP auth where applicable.

###Browse Tables

1. ›Click a table to open the table view.
2. ›Click the button beside a table to open it in a new tab.
3. ›Edit data directly in the grid.

Use the search box next to Tables to filter objects in the explorer.

###Execute SQL

Click Open Query on a connection to open a SQL editor bound to that database.

The editor provides:

• ›SQL IntelliSense and auto-completion
• ›Snippets: sel, del, ins, upd, joi, etc.
• ›Run current/selected SQL — Ctrl+Enter / Cmd+Enter
• ›Run all SQL — Ctrl+Shift+Enter / Cmd+Shift+Enter
• ›Run in new panel — Ctrl+Alt+Enter / Cmd+Ctrl+Enter

###Cache

Database metadata is cached for performance. If the schema changes externally, click the Refresh button on the connection to update.

###Backup & Import

Right-click any database or table node to access Export and Import options.

For MySQL and PostgreSQL, adding mysqldump or pg_dump to your PATH enables native backup tools.

###SSH & Port Forwarding

Connect to an SSH server to access the terminal, browse remote files, and set up port forwarding for tunneling database connections.

###Mock Data

Generate test data from table templates or mock.json files. Press Ctrl+Enter / Cmd+Enter in a mock file to run.

###Query History

Click the history button in the SQL editor toolbar to view recently executed queries.

##Settings

Open VS Code Settings and search for database-client to configure SQL behavior, result layout, telemetry, and more.

Common options:

##Development

###Prerequisites

• ›Node.js 20+
• ›Yarn

###Build

yarn install
yarn dev      # watch mode for development
yarn build    # production build to out/
yarn lint     # type check

Press F5 in VS Code to launch the Extension Development Host.

###Package

yarn repackage  # build and create .vsix

##Credits

• ›ssh2 — SSH client
• ›sql-formatter — SQL formatting
• ›Client libraries:
  • ›@cweijan/mysql2 — MySQL
  • ›pg — PostgreSQL
  • ›tedious — SQL Server
  • ›ioredis — Redis
  • ›mongodb — MongoDB
  • ›kafkajs — Kafka
  • ›neo4j-driver — Neo4j
  • ›snowflake-sdk — Snowflake
  • ›vscode-sqlite — SQLite client code reference