ClickHouse/clickhouse-js

Dernière activité source enregistrée: 31 octobre 2026 à 08:05

Catalogue SkillsMP mis à jour: 2 novembre 2026 à 18:02

skills collectés: 5

Étoiles GitHub: 330
Forks GitHub: 81

Installer avec un assistant IA

Copiez ce prompt dans l’assistant IA que vous utilisez.

Follow https://skillsmp.com/skill-install/prompt.md to install Agent Skills from https://github.com/ClickHouse/clickhouse-js.

README du dépôt

Fichier source du README : README.md

Lire le README source

Afficher le README complet

<p align="center"> <img src=".static/logo.svg" width="200px" align="center"> <h1 align="center">ClickHouse JS client</h1> </p> <br/> <p align="center"> <a href="https://www.npmjs.com/package/@clickhouse/client"> <img alt="NPM Version" src="https://img.shields.io/npm/v/%40clickhouse%2Fclient?color=%233178C6&logo=npm"> </a> <a href="https://www.npmjs.com/package/@clickhouse/client"> <img alt="NPM Downloads" src="https://img.shields.io/npm/dw/%40clickhouse%2Fclient?color=%233178C6&logo=npm"> </a> <a href="https://github.com/ClickHouse/clickhouse-js/actions/workflows/tests-node.yml"> <img src="https://github.com/ClickHouse/clickhouse-js/actions/workflows/tests-node.yml/badge.svg?branch=main"> </a> <a href="https://github.com/ClickHouse/clickhouse-js/actions/workflows/tests-web.yml"> <img src="https://github.com/ClickHouse/clickhouse-js/actions/workflows/tests-web.yml/badge.svg?branch=main"> </a> <a href="https://codecov.io/gh/ClickHouse/clickhouse-js"> <img src="https://codecov.io/gh/ClickHouse/clickhouse-js/graph/badge.svg?token=B832WB00WJ"> </a> <img src="https://api.scorecard.dev/projects/github.com/ClickHouse/clickhouse-js/badge"> </p> ## About Official JS client for [ClickHouse](https://clickhouse.com/), written purely in TypeScript, thoroughly tested with actual ClickHouse versions. The client has zero external dependencies and is optimized for maximum performance. The repository consists of four 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. - `@clickhouse/rowbinary` - a library for reading (and soon writing) ClickHouse RowBinary format. The client works with both ClickHouse Cloud and self-hosted ClickHouse. You can [start a free Cloud trial](https://console.clickhouse.cloud/signUp?utm_medium=referral&utm_source=github&utm_campaign=readme&utm_content=clickhouse-js) or [install ClickHouse](https://clickhouse.com/docs/get-started/setup/install) locally. ## Installation Node.js client: ```sh npm i @clickhouse/client ``` Web client (browsers, Cloudflare workers): ```sh npm i @clickhouse/client-web ``` ## Environment requirements ### Node.js Node.js must be available in the environment to run the Node.js client. The client is compatible with all the [maintained](https://github.com/nodejs/release#readme) Node.js releases. | Node.js version | Supported? | | --------------- | ---------- | | 26.x | ✔ | | 24.x | ✔ | | 22.x | ✔ | | 20.x | ✔ | ### TypeScript If using TypeScript, version [4.5](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-4-5.html) or above is required to enable [inline import and export syntax](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-4-5.html#type-modifiers-on-import-names). ## Compatibility with ClickHouse | Client version | ClickHouse | | -------------- | ---------- | | 1.12.0+ | 24.8+ | The client may work with older versions too; however, this is best-effort support and is not guaranteed. ## Quick start ```ts import { createClient } from "@clickhouse/client"; // or '@clickhouse/client-web' const client = createClient({ url: process.env.CLICKHOUSE_URL ?? "http://localhost:8123", username: process.env.CLICKHOUSE_USER ?? "default", password: process.env.CLICKHOUSE_PASSWORD ?? "", }); const resultSet = await client.query({ query: "SELECT * FROM system.tables", format: "JSONEachRow", }); const tables = await resultSet.json(); console.log(tables); await client.close(); ``` See more examples in the [examples directory](./examples). ## Documentation See the [ClickHouse website](https://clickhouse.com/docs/integrations/javascript) for the full documentation. ## Changelog Each package keeps its own changelog: - `@clickhouse/client` — [`packages/client-node/CHANGELOG.md`](./packages/client-node/CHANGELOG.md) - `@clickhouse/client-web` — [`packages/client-web/CHANGELOG.md`](./packages/client-web/CHANGELOG.md) - `@clickhouse/client-common` (deprecated) — [`packages/client-common/CHANGELOG.md`](./packages/client-common/CHANGELOG.md) - `@clickhouse/datatype-parser` — [`packages/datatype-parser/CHANGELOG.md`](./packages/datatype-parser/CHANGELOG.md) - `@clickhouse/rowbinary` — [`skills/clickhouse-js-node-rowbinary/CHANGELOG.md`](./skills/clickhouse-js-node-rowbinary/CHANGELOG.md) History through `@clickhouse/client` 1.23.0 lives in the now-frozen repository-wide [`CHANGELOG.md`](./CHANGELOG.md). ## AI Agent Skills This repository contains agent skills for working with the client: - `clickhouse-js-node-troubleshooting` — troubleshooting playbook for the Node.js client. Install via CLI: ```sh # per project npx skills add ClickHouse/clickhouse-js # globally npx skills add ClickHouse/clickhouse-js -g ``` Or ask your agent to install it for you: > install agent skills from ClickHouse/clickhouse-js ## 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). If you'd like to build a client for an alternative runtime (such as Bun or Cloudflare Workers) or an alternative protocol (such as the native ClickHouse protocol or gRPC over a proxy), see [Building specialized clients for alternative runtimes and protocols](./ALTERNATIVE_CLIENTS.md).

Chargement du README du dépôt…

Skills dans ce dépôt

Développeurs de logiciels

1 catégories métier · 60% classifié

skill

métier

description

mis à jour

clickhouse-js-node-troubleshooting

non classé

Troubleshoot and resolve common issues with the ClickHouse Node.js client (@clickhouse/client). Use this skill whenever a user reports errors, unexpected behavior, or configuration questions involving the Node.js client specifically — including socket hang-up…