# 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:
```bash
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:
```bash
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:
```bash
harlequin -a clickhouse --host localhost --port 9000 --database default --user default
```
Many more options are available; to see the full list, run:
```bash
harlequin -a clickhouse --help
```
## Setup ClickHouse
This is from the [ClickHouse single node with Keeper](https://github.com/ClickHouse/examples/blob/main/docker-compose-recipes/recipes/ch-1S_1K/README.md) in the [ClickHouse Examples](https://github.com/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`.
```bash
export CHVER=23.4
export CHKVER=23.4-alpine
docker compose up
```
Raw data
{
"_id": null,
"home_page": null,
"name": "harlequin-clickhouse",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.14.0,>=3.9",
"maintainer_email": null,
"keywords": "harlequin, clickhouse, sql, tui",
"author": "Thomaub",
"author_email": "Thomaub <github.thomaub@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/8b/25/9a173ad1f8fa562e4b560e4581b3b21ed2f44f9c91c3b3181d3c6b9a750e/harlequin_clickhouse-0.1.1.tar.gz",
"platform": null,
"description": "# harlequin-clickhouse\n\nA Harlequin adapter for ClickHouse databases.\n\n## Installation\n\nYou 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:\n\n```bash\nuv tool install harlequin --with harlequin-clickhouse\n```\n\n## Usage and Configuration\n\nRun Harlequin with the `-a clickhouse` option and pass a ClickHouse DSN as an argument:\n\n```bash\nharlequin -a clickhouse \"clickhouse://default:@localhost:9000/default\"\n```\n\nYou can also pass all or parts of the connection string as separate options. The following is equivalent to the above DSN:\n\n```bash\nharlequin -a clickhouse --host localhost --port 9000 --database default --user default\n```\n\nMany more options are available; to see the full list, run:\n\n```bash\nharlequin -a clickhouse --help\n```\n\n## Setup ClickHouse\n\nThis is from the [ClickHouse single node with Keeper](https://github.com/ClickHouse/examples/blob/main/docker-compose-recipes/recipes/ch-1S_1K/README.md) in the [ClickHouse Examples](https://github.com/ClickHouse/examples) repo\n\nSingle node ClickHouse instance leveraging 1 ClickHouse Keeper\n\nBy default the version of ClickHouse used will be `latest`, and ClickHouse Keeper\nwill be `latest-alpine`. You can specify specific versions by setting environment\nvariables before running `docker compose up`.\n\n```bash\nexport CHVER=23.4\nexport CHKVER=23.4-alpine\ndocker compose up\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A Harlequin adapter for Clickhouse",
"version": "0.1.1",
"project_urls": {
"Homepage": "https://github.com/harlequin-org/harlequin-clickhouse",
"Issues": "https://github.com/harlequin-org/harlequin-clickhouse/issues",
"Repository": "https://github.com/harlequin-org/harlequin-clickhouse"
},
"split_keywords": [
"harlequin",
" clickhouse",
" sql",
" tui"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "05ac7898826ac9ed65e8ddb3af3f753d72f44ddad62801d7d790669db96d8802",
"md5": "80b7f553380b8da701bb9a31eafe7912",
"sha256": "3290495a8098f507fe0df277b9270461bebbe2d79d0122f97775ac1e7559c086"
},
"downloads": -1,
"filename": "harlequin_clickhouse-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "80b7f553380b8da701bb9a31eafe7912",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.14.0,>=3.9",
"size": 6407,
"upload_time": "2025-08-26T12:20:06",
"upload_time_iso_8601": "2025-08-26T12:20:06.955046Z",
"url": "https://files.pythonhosted.org/packages/05/ac/7898826ac9ed65e8ddb3af3f753d72f44ddad62801d7d790669db96d8802/harlequin_clickhouse-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "8b259a173ad1f8fa562e4b560e4581b3b21ed2f44f9c91c3b3181d3c6b9a750e",
"md5": "e877fae06f86e0308432b65a33518455",
"sha256": "2a2609909cb95280ace5a7e108e8bb13c586ad0865401bf83f911ec94d4f0402"
},
"downloads": -1,
"filename": "harlequin_clickhouse-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "e877fae06f86e0308432b65a33518455",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.14.0,>=3.9",
"size": 4904,
"upload_time": "2025-08-26T12:20:08",
"upload_time_iso_8601": "2025-08-26T12:20:08.228290Z",
"url": "https://files.pythonhosted.org/packages/8b/25/9a173ad1f8fa562e4b560e4581b3b21ed2f44f9c91c3b3181d3c6b9a750e/harlequin_clickhouse-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-26 12:20:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "harlequin-org",
"github_project": "harlequin-clickhouse",
"github_not_found": true,
"lcname": "harlequin-clickhouse"
}
JSON
