Skip to main content

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

Metadata

Release files for harlequin-clickhouse 0.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for harlequin-clickhouse 0.1.1
File Size Uploaded
harlequin_clickhouse-0.1.1.tar.gz 4.9 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for harlequin-clickhouse 0.1.1
File Interpreter ABI Platform
harlequin_clickhouse-0.1.1-py3-none-any.whl Python 3 none any Details

Total release size: 11.3 kB

Release files / harlequin_clickhouse-0.1.1.tar.gz

Download URL harlequin_clickhouse-0.1.1.tar.gz
Size 4.9 kB
Tags Source
SHA-256 checksum
How to use checksums
2a2609909cb95280ace5a7e108e8bb13c586ad0865401bf83f911ec94d4f0402
BLAKE2b-256 checksum
How to use checksums
8b259a173ad1f8fa562e4b560e4581b3b21ed2f44f9c91c3b3181d3c6b9a750e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.12.9

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Aug 26, 2025.

Transparency log

Release files / harlequin_clickhouse-0.1.1-py3-none-any.whl

Download URL harlequin_clickhouse-0.1.1-py3-none-any.whl
Size 6.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
3290495a8098f507fe0df277b9270461bebbe2d79d0122f97775ac1e7559c086
BLAKE2b-256 checksum
How to use checksums
05ac7898826ac9ed65e8ddb3af3f753d72f44ddad62801d7d790669db96d8802
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.12.9

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Aug 26, 2025.

Transparency log

Release history Release notifications | RSS feed

This release

0.1.1 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page