harlequin-clickhouse

A Harlequin adapter for ClickHouse databases.

Installation

You must install the harlequin-clickhouse package into the same environment as harlequin. The best and easiest way to do this is to use uv to install Harlequin with the additional package:

uv tool install harlequin --with harlequin-clickhouse

Usage and Configuration

Run Harlequin with the -a clickhouse option and pass a ClickHouse DSN as an argument:

harlequin -a clickhouse "clickhouse://default:@localhost:9000/default"

You can also pass all or parts of the connection string as separate options. The following is equivalent to the above DSN:

harlequin -a clickhouse --host localhost --port 9000 --database default --user default

Many more options are available; to see the full list, run:

harlequin -a clickhouse --help

Setup ClickHouse

This is from the ClickHouse single node with Keeper in the ClickHouse Examples repo

Single node ClickHouse instance leveraging 1 ClickHouse Keeper

By default the version of ClickHouse used will be latest, and ClickHouse Keeper will be latest-alpine. You can specify specific versions by setting environment variables before running docker compose up.

export CHVER=23.4
export CHKVER=23.4-alpine
docker compose up