How to Connect ClickHouse to VS Code

How do I connect ClickHouse to VS Code?

Install SQLTools in VS Code and add a ClickHouse connection string to run ClickHouse queries directly inside the editor.

Welcome to the Galaxy, Guardian!
You'll be receiving a confirmation email

Follow us on twitter :)

Oops! Something went wrong while submitting the form.

Description

Example H2

Example H3

Why use VS Code for ClickHouse?

Running ClickHouse inside VS Code lets you keep coding, data exploration, and version control in one place. You gain IntelliSense, snippets, and Git history without switching tools.

What extensions are required?

Install SQLTools (Editor: SQLTools) and SQLTools ClickHouse Driver. Both are available in the VS Code Marketplace.

How do I configure the connection?

Open the VS Code Command Palette → "SQLTools: Add new connection" → choose ClickHouse. Provide a name, host, port, username, password, and default database.Save to settings.json.

Connection JSON example

{ "sqltools.connections": [ { "name": "Local ClickHouse", "driver": "ClickHouse", "server": "127.0.0.1", "port": 9000, "database": "ecommerce", "username": "default", "password": "mypassword", "readTimeout": 30000, "ssl": false } ]}

How do I run a query?

Create a .sql file, select the connection in the Status Bar, highlight a statement, and press Ctrl + Shift + E.Results appear in an inline grid.

Best practices

Use parameterized snippets

Create user snippets for repetitive tasks (e.g., select_top_customers) to reduce typing.

Version-control queries

Store your .sql files in Git to track history alongside application code.

Common troubleshooting steps

If connection fails, verify the ClickHouse port (default 9000) is open and not blocked by a firewall. Check that the SQLTools ClickHouse driver matches your ClickHouse server version.

Why How to Connect ClickHouse to VS Code is important

How to Connect ClickHouse to VS Code Example Usage


/* Find products that need restocking */
SELECT id, name, stock
FROM Products
WHERE stock < 20
ORDER BY stock ASC;

How to Connect ClickHouse to VS Code Syntax


-- Connection is handled by SQLTools JSON above
-- Example ClickHouse query using ecommerce schema
SELECT  c.id,
        c.name,
        SUM(o.total_amount) AS lifetime_value
FROM Customers AS c
JOIN Orders   AS o ON o.customer_id = c.id
GROUP BY c.id, c.name
ORDER BY lifetime_value DESC
LIMIT 10;

Common Mistakes

Forgetting to install the SQLTools ClickHouse driver. Installing only the core SQLTools extension will let you add connections, but ClickHouse won’t appear. Fix: search for “SQLTools ClickHouse Driver” in the VS Code Marketplace and install it.
Using the HTTP port (8123) instead of the native TCP port (9000). SQLTools needs the native port. Fix: open ClickHouse with `--port 9000` or update the connection to match your server’s TCP port.