@clickhouse/client-web

中文文档
1.25.0发布于 2026/11/05Apache-2.0TypeScriptCommonJS零依赖构建来源已验证近 30 天下载 120.1万

ClickHouse DB - Web API 执行的官方JS客户端

中文使用文档
文档目录8 节
  1. 安装
  2. 环境要求
  3. 与 ClickHouse 兼容
  4. 快开始
  5. 文档
  6. 更改日志
  7. 联系我们
  8. 许可证

@ 点击之家/ 客户端- 网络

官方网络客户端 点击之家,纯写入 TypeScript 并对照实际的 ClickHouse 版本进行彻底测试.

它建在顶上 获取 财务报告和审定财务报表 网络流 APIs 密码 ,并且支持选择的流线。 与 Chrome/ Firefox 兼容 浏览器与Cloudflare工人. 客户端的外部依赖性为零 为最大性能优化.

在节点上跑? 使用 @clickhouse/client 用于插入的流线.

安装

npm i @clickhouse/client-web

环境要求

客户对象为提供标准的运行时间 获取 财务报告和审定财务报表 网络流 APIs, (英语), 例如现代Chrome/Firefox浏览器和Cloudflare Workers.

如果使用类型脚本, 版本 4.5 国家 需要以上才能使 内置导入和导出语法。 。 。 .

与 ClickHouse 兼容

客户端版本点击之家
1.1.2.0+ (单位:千美元)24.8+ (韩语)

客户端也可能使用更古老的版本;然而,这是最好的 支持和不保证.

快开始

import { createClient } from "@clickhouse/client-web";

const client = createClient({
  url: "http://localhost:8123",
  username: "default",
  password: "",
});

const resultSet = await client.query({
  query: "SELECT * FROM system.tables",
  format: "JSONEachRow",
});

const tables = await resultSet.json();
console.log(tables);

await client.close();

更多信息见 示例目录。 。 。 .

文档

见 点击之家网站 用于完整文件.

更改日志

见 CHANGELOG.md。 。 。 .

联系我们

如果你有任何问题或需要帮助, 请随意联系我们 社区黑 (单位:千美元)#clickhouse-js 频道)或 通过 GitHub 问题。 。 。 .

许可证

Apache 2.0 (英语)

版本与发布记录

@clickhouse/client-web 共发布 122 个版本,首次发布于 2023/07/27;过去 12 个月发布了 86 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
1.25.0latest2026/11/055 天前
1.25.0-head.a5b9c61.1head2026/11/045 天前
1.24.0-head.6a265d2.12026/10/091 个月前
1.24.02026/10/061 个月前
1.24.0-head.710aea5.12026/10/061 个月前
1.24.0-head.443b2f0.12026/07/163 个月前

其他发布通道:tracing_logging_command → 0.4.0,faster_exception_detection → 0.100.1,rc → 1.17.0,beta → 1.18.2,head → 1.25.0-head.a5b9c61.1。

关于 @clickhouse/client-web 的常见问题

@clickhouse/client-web 是什么?

ClickHouse DB - Web API 执行的官方JS客户端

如何安装 @clickhouse/client-web?

在项目目录运行 npm install @clickhouse/client-web,或使用 pnpm add / yarn add / bun add。

@clickhouse/client-web 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@clickhouse/client-web 支持 ESM 还是 CommonJS?

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

@clickhouse/client-web 可以商用吗?

@clickhouse/client-web 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。

@clickhouse/client-web 的下载量有多少?

根据 npm 官方下载统计,@clickhouse/client-web 在 2026/10/10 – 2026/11/08 这 30 天内被下载 1,200,507 次,日均约 40,017 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@clickhouse/client-web 还在维护吗?

最新版本 1.25.0 发布于 2026/11/05(5 天前);至今共发布 122 个版本,其中过去 12 个月发布了 86 个;首次发布于 2023/07/27。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。