@clickhouse/client-common

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

DEPRECATED: 此软件包不再被 @ clickhouse/ client 或 @ clickhouse/ client-web 使用; 现在共享代码被捆绑到每个客户端软件包中 。 安装 @ clickhouse/ client( Node.js) 或 @ clickhouse/ client-web(Web) .

此软件包已被标记为弃用

Deprecated: import from @clickhouse/client or @clickhouse/client-web instead.

中文使用文档
文档目录13 节
  1. 关于
  2. 安装
  3. 环境要求
  4. 节点.js
  5. 类型脚本
  6. 与 ClickHouse 兼容
  7. 快开始
  8. 文档
  9. 更改日志
  10. AI 代理技能
  11. 用法实例
  12. 联系我们
  13. 捐款

点击之家 JS 客户端


NPM Version NPM Downloads

关于

官方JS客户端 点击之家,纯用TypeScript写出,用实际的ClickHouse版本进行彻底测试.

客户端的外部依赖性为零并被优化以达到最大性能.

存储器包括四个包:

  • @clickhouse/client - 只为Node.js平台设计的客户端版本。 它建在顶部 HTTP 密码 财务报告和审定财务报表 流线 API;支持选择和插入的流线.
  • @clickhouse/client-web - 客户端的版本建在顶端 获取 财务报告和审定财务报表 网络流 API; 支持选择的流线. 与Chrome/Firefox浏览器和Cloudflare工人兼容.
  • @clickhouse/client-common - 共享共同类型和建立定制客户实施的基础框架.
  • @clickhouse/rowbinary - 用于读取(并很快写出) ClickHouse RowBinary 格式的库.

安装

节点.js客户端 :

npm i @clickhouse/client

网络客户端(浏览器,云花板工人):

npm i @clickhouse/client-web

环境要求

节点.js

节点js必须在环境中可用来运行节点js客户端. 客户端兼容所有 维持 节点Js发布.

节点.js 版本支持吗?
26.x (中文(简体) )✔
24.x 国家✔
22.x 电话✔
20.x 电话✔

类型脚本

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

与 ClickHouse 兼容

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

客户端也可能使用更古老的版本;然而,这是最有效的支持,没有保障.

快开始

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();

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

文档

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

更改日志

每个软件包都保留自己的更改日志 :

历史经过 @clickhouse/client 1.23.0 住在目前被冻结的全库 CHANGELOG.md。 。 。 .

AI 代理技能

该寄存器包含与客户端合作的代理技能:

  • clickhouse-js-node-troubleshooting ——为Node.js客户端解析游戏本.

通过 CLI 安装 :

# per project
npx skills add ClickHouse/clickhouse-js
# globally
npx skills add ClickHouse/clickhouse-js -g

或者叫你的经纪人帮你安装

从 ClickHouse/ clickhouse-js 安装代理技能

用法实例

我们有很多 实例,旨在涵盖客户使用的各种情况。 概览载于本报告 实例。 。 。 .

联系我们

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

捐款

看看我们 贡献指南。 。 。 .

如果您想要为另类运行时间( 如 Bun 或 Cloudflare Workers) 或另类协议( 如本地的 ClickHouse 协议 或 gRPC 相对于代理) 构建客户端, 请参见 为替代运行时间和协议建立专门客户端。 。 。 .

版本与发布记录

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

版本发布日期距今
1.23.0latest2026/06/304 个月前
1.23.0-head.dbc2960.1head2026/06/284 个月前
1.23.0-head.287977a.12026/06/284 个月前
1.23.0-head.fae5998.12026/06/254 个月前
1.23.0-head.b25cda1.12026/06/244 个月前
1.23.0-head.c8dc8d8.12026/06/234 个月前

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

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

@clickhouse/client-common 是什么?

DEPRECATED: 此软件包不再被 @ clickhouse/ client 或 @ clickhouse/ client-web 使用; 现在共享代码被捆绑到每个客户端软件包中 。 安装 @ clickhouse/ client( Node.js) 或 @ clickhouse/ client-web(Web) .注意:该包已被作者标记为弃用——Deprecated: import from @clickhouse/client or @clickhouse/client-web instead.

如何安装 @clickhouse/client-common?

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

@clickhouse/client-common 支持 TypeScript 吗?

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

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

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

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

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

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

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

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

最新版本 1.23.0 发布于 2026/06/30(4 个月前);至今共发布 113 个版本,其中过去 12 个月发布了 76 个;首次发布于 2023/07/20。作者已将其标记为弃用,新项目建议寻找替代方案。