Waddler <> ClickHouse

To use Waddler with a ClickHouse database, you should use the @clickhouse/client driver.

Waddler natively supports @clickhouse/client with waddler/clickhouse package.

Step 1 - Install packages

npm

yarn

pnpm

bun

npm i waddler @clickhouse/client

yarn add waddler @clickhouse/client

pnpm add waddler @clickhouse/client

bun add waddler @clickhouse/client

Step 2 - Initialize the driver and make a query

clickhouse

clickhouse with config

import { waddler } from "waddler/clickhouse";

const sql = waddler(process.env.DATABASE_URL);

const result = await sql`select 1;`;

import { waddler } from "waddler/clickhouse";

// You can specify any property from the clickhouse connection options
const sql = waddler({ connection: { url: process.env.DATABASE_URL }});
// process.env.DATABASE_URL should look like this: http[s]://<user>:<password>@<host>:<port>/<database>;

const result = await sql`select 1;`;

If you need to provide your existing driver:

import { waddler } from "waddler/clickhouse";
import { createClient } from '@clickhouse/client';
  
const client = createClient({
  url: '...',
  // url should have the following format: http[s]://<host>:<port>
  user: 'user',
  password: 'password',
  database: 'database',
});

const sql = waddler({ client });

const result = await sql`select 1;`;