@clickhouse/client-common

ClickHouse JS client

About

Official JS client for ClickHouse, written purely in TypeScript, thoroughly tested with actual ClickHouse versions.

The repository consists of three packages:

• @clickhouse/client - a version of the client designed for Node.js platform only. It is built on top of HTTP and Stream APIs; supports streaming for both selects and inserts.
• @clickhouse/client-web - a version of the client built on top of Fetch and Web Streams APIs; supports streaming for selects. Compatible with Chrome/Firefox browsers and CloudFlare workers.
• @clickhouse/client-common - shared common types and the base framework for building a custom client implementation.

Documentation

See the ClickHouse website for the full documentation entry.

Usage examples

We have a wide range of examples, aiming to cover various scenarios of client usage. The overview is available in the examples README.

Contact us

If you have any questions or need help, feel free to reach out to us in the Community Slack (#clickhouse-js channel) or via GitHub issues.

Contributing

Check out our contributing guide.

Changelog

1.0.2 (Common, Node.js, Web)

Bug fixes

• The command method now drains the response stream properly, as the previous implementation could cause the Keep-Alive socket to close after each request.
• Removed an unnecessary error log in the ResultSet.stream method if the request was aborted or the result set was closed (#263).

Improvements

• ResultSet.stream logs an error via the Logger instance, if the stream emits an error event instead of a simple console.error call.
• Minor adjustments to the DefaultLogger log messages formatting.
• Added missing rows_before_limit_at_least to the ResponseJSON type (@0237h, #267).