Skip to content

ClickHouse/clickhouse-js

Folders and files

NameName
Last commit message
Last commit date
Oct 17, 2023
Mar 11, 2025
Mar 31, 2025
Aug 5, 2022
Dec 13, 2024
Oct 12, 2023
Mar 29, 2024
Nov 29, 2024
Mar 17, 2025
Jul 25, 2022
Jan 12, 2024
Mar 26, 2024
Mar 28, 2024
Mar 28, 2024
Aug 15, 2022
Mar 17, 2025
Oct 17, 2023
Mar 29, 2024
Sep 13, 2024
Mar 11, 2025
Mar 11, 2025
Jul 19, 2023
Jul 19, 2023
Jul 19, 2023
Jun 6, 2024
Jul 19, 2023
Jul 19, 2023
Jul 12, 2024
Dec 13, 2024
Mar 31, 2025
Mar 29, 2024
Mar 25, 2024
Mar 25, 2024
Mar 11, 2025
Mar 25, 2024
Jul 25, 2023
Dec 13, 2024
Jul 25, 2023

Repository files navigation

ClickHouse JS client


NPM Version NPM Downloads

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.