@clickhouse/client-web
Advanced tools
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.See the ClickHouse website for the full documentation entry.
We have a wide range of examples, aiming to cover various scenarios of client usage. The overview is available in the examples README.
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.
Check out our contributing guide.
1.0.0 (Common, Node.js, Web)
Formal stable release milestone with a lot of improvements and some breaking changes.
Major new features overview:
From now on, the client will follow the official semantic versioning guidelines.
The following configuration parameters are marked as deprecated:
host configuration parameter is deprecated; use url instead.additional_headers configuration parameter is deprecated; use http_headers instead.The client will log a warning if any of these parameters are used. However, it is still allowed to use host instead of url and additional_headers instead of http_headers for now; this deprecation is not supposed to break the existing code.
These parameters will be removed in the next major release (2.0.0).
See "New features" section for more details.
FAQs
Official JS client for ClickHouse DB - Web API implementation
The npm package @clickhouse/client-web receives a total of 6,656 weekly downloads. As such, @clickhouse/client-web popularity was classified as popular.
We found that @clickhouse/client-web demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
The UK is proposing a bold ban on ransomware payments by public entities to disrupt cybercrime, protect critical services, and lead global cybersecurity efforts.
Security News
Snyk's use of malicious npm packages for research raises ethical concerns, highlighting risks in public deployment, data exfiltration, and unauthorized testing.
Research
Security News
Socket researchers found several malicious npm packages typosquatting Chalk and Chokidar, targeting Node.js developers with kill switches and data theft.