clickhouse-sql

library1.2.4jsnpmunverified

ClickHouse SQL dialect implementation for JavaScript/TypeScript that provides a query builder interface for constructing ClickHouse SQL queries programmatically. Current stable version is 1.2.4. Developed by mbIkola, this package offers an alternative to raw query composition with method chaining and built-in functions specific to ClickHouse (e.g., toStartOfMinute, uniq, sum, divide). It is primarily used in Node.js environments. As a small utility library, it has a limited maintenance scope but covers essential ClickHouse SQL features. The package is ESM-only and requires the latest Node versions.

database

npm install clickhouse-sql

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · CLICKHOUSE-SQL

clickhouse-sql

databasejavascriptv1.2.4

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

default

✓ import Dialect from 'clickhouse-sql'

✗ const Dialect = require('clickhouse-sql')

The package is ESM-only. CommonJS require() will not work.

Constructs a simple SELECT COUNT query with GROUP BY and ORDER BY using method chaining.

import Dialect from 'clickhouse-sql'; const s = new Dialect(); const query = s .select('count()', 'status') .from('events') .where('date', s.GREATER, '2021-01-01') .groupBy('status') .orderBy('status') .toString(); console.log(query); // SELECT count(), status FROM events WHERE date > '2021-01-01' GROUP BY status ORDER BY status

Debug

Known issues

breakingPackage version 2.0 changes default exports to named exports. Import statements from v1 will break.

fix

Update import to use named exports: import { Dialect } from 'clickhouse-sql'

affects: >=1.0.0 <2.0.0

gotchaThe package does not support CommonJS require() because it is ESM-only.

fix

Use import syntax or configure your project for ESM. For older Node versions, you may need to use dynamic import: const Dialect = await import('clickhouse-sql');

affects: >=1.0.0

deprecatedMethod someMethod is deprecated. Use newMethod instead.

fix

Replace someMethod with newMethod in your queries.

affects: >=1.0.0

Errors

Common errors & fixes

ERR_REQUIRE_ESM: require() of ES Module not supported

Using require() on an ESM-only package.

fix

Use import Dialect from 'clickhouse-sql' instead of require.

Upgrade

Version history

1.2.4latest on npm

Audit

Dependencies

No dependency data recorded yet.

Agent activity

9 hits · last 30 days

node

OpenAI (training)

Resources

githubssh://git@github.com/mbIkola/node-clickhouse-sql ↗

packageclickhouse-sql ↗

homepagehttps://github.com/mbIkola/node-clickhouse-sql#readme ↗