README.md

Connecting JavaScript 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 Node.js (version 22 or later)

   • Alternatively, you can use Bun or Deno

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

2. Install dependencies:

   npm --prefix .. install

3. Customize the script main.js as needed

   • Change the connection arguments in databaseOptions
     • 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 conn.query()

4. Run the script:

   Node.js:

   node main.js

   Bun:

   bun run main.js

   Deno:

   deno run --allow-ffi --allow-env main.js

Clean up

Stop the Docker container running ClickHouse:

docker stop some-clickhouse-server