README.md

Connecting Python and ClickHouse with ADBC

Instructions

Tip

If you already have a ClickHouse instance running, skip the steps to set up and clean up ClickHouse.

Prerequisites

1. Install uv

2. Install dbc

Set up ClickHouse

1. Install Docker

2. Start a ClickHouse instance:

   docker run -d --rm --name some-clickhouse-server -p 8123:8123 -e CLICKHOUSE_USER=user -e CLICKHOUSE_PASSWORD=pass clickhouse/clickhouse-server

Connect to ClickHouse

1. Install the ClickHouse ADBC driver:

   dbc install clickhouse --pre

2. Customize the Python script main.py as needed

   • Change the connection arguments in db_kwargs
     • Format uri according to the ClickHouse HTTP interface, or keep it as is
   • If you changed which database you're connecting to, also change the SQL SELECT statement in cursor.execute()

3. Run the Python script:

   uv run main.py

Clean up

Stop the Docker container running ClickHouse:

docker stop some-clickhouse-server