https://github.com/ClickHouse/clickhouse-js

Official JS client for ClickHouse DB
https://github.com/ClickHouse/clickhouse-js

clickhouse http https javascript nodejs streaming typescript

Last synced: about 1 month ago
JSON representation

Official JS client for ClickHouse DB

• Host: GitHub
• URL: https://github.com/ClickHouse/clickhouse-js
• Owner: ClickHouse
• License: apache-2.0
• Created: 2022-07-25T12:20:45.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-11-11T23:03:03.000Z (about 1 month ago)
• Last Synced: 2024-11-12T00:17:27.337Z (about 1 month ago)
• Topics: clickhouse, http, https, javascript, nodejs, streaming, typescript
• Language: TypeScript
• Homepage: https://clickhouse.com
• Size: 1.14 MB
• Stars: 226
• Watchers: 20
• Forks: 27
• Open Issues: 34
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-clickhouse - ClickHouse/clickhouse-js - This project is the official JavaScript client for ClickHouse DB, designed to facilitate database interactions in both Node.js and web environments. (Language bindings / JavaScript/Typescript)

README

        




ClickHouse JS client

































## About

Official JS client for [ClickHouse](https://clickhouse.com/), 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](https://nodejs.org/api/http.html)

  and [Stream](https://nodejs.org/api/stream.html) APIs; supports streaming for both selects and inserts.

- `@clickhouse/client-web` - a version of the client built on top of [Fetch](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API)

  and [Web Streams](https://developer.mozilla.org/en-US/docs/Web/API/Streams_API) 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](https://clickhouse.com/docs/en/integrations/language-clients/javascript) for the full documentation entry.

## Usage examples

We have a wide range of [examples](./examples), aiming to cover various scenarios of client usage. The overview is available in the [examples README](https://github.com/ClickHouse/clickhouse-js/blob/main/examples/README.md#overview).

## Contact us

If you have any questions or need help, feel free to reach out to us in the [Community Slack](https://clickhouse.com/slack) (`#clickhouse-js` channel) or via [GitHub issues](https://github.com/ClickHouse/clickhouse-js/issues).

## Contributing

Check out our [contributing guide](./CONTRIBUTING.md).