# @clickhouse/client-web 中文文档

规范地址：https://npmcn.com/package/%40clickhouse/client-web/

版本：1\.25\.0
npm 元数据更新时间：2026-11-04T18:27:10.019Z
中文译文更新时间：2026-11-10T01:31:02.151Z
软件包许可：Apache-2\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40clickhouse/client-web
原文对照：https://npmcn.com/package/%40clickhouse/client-web/?lang=original
项目主页：https://clickhouse.com/
源码仓库：https://github.com/ClickHouse/clickhouse-js

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：579 kB，112 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2023-07-26T16:28:40.363Z
- 最新版本发布：2026-11-04T18:27:09.620Z
- 近 30 天下载量：1200507（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：122（近 12 个月 86 个）

## 中文简介

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

## 安装

```sh
npm install @clickhouse/client-web
```

也可以使用：`pnpm add @clickhouse/client-web`、`yarn add @clickhouse/client-web`、`bun add @clickhouse/client-web`

## README

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

官方网络客户端 [点击之家](https://clickhouse.com/),纯写入 TypeScript 并对照实际的 ClickHouse 版本进行彻底测试.

它建在顶上 [获取](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API) 财务报告和审定财务报表 [网络流](https://developer.mozilla.org/en-US/docs/Web/API/Streams_API) APIs 密码 ,并且支持选择的流线。 与 Chrome/ Firefox 兼容 浏览器与Cloudflare工人. 客户端的外部依赖性为零 为最大性能优化.

> 在节点上跑? 使用 [`@clickhouse/client`](https://www.npmjs.com/package/@clickhouse/client) 用于插入的流线.

## 安装

```sh
npm i @clickhouse/client-web
```

## 环境要求

客户对象为提供标准的运行时间 [获取](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API) 财务报告和审定财务报表 [网络流](https://developer.mozilla.org/en-US/docs/Web/API/Streams_API) APIs, (英语), 例如现代Chrome/Firefox浏览器和Cloudflare Workers.

如果使用类型脚本, 版本 [4.5 国家](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-4-5.html) 需要以上才能使 [内置导入和导出语法](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-4-5.html#type-modifiers-on-import-names)。 。 。 .

## 与 ClickHouse 兼容

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

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

## 快开始

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

更多信息见 [示例目录](https://github.com/ClickHouse/clickhouse-js/tree/main/examples)。 。 。 .

## 文档

见 [点击之家网站](https://clickhouse.com/docs/integrations/javascript) 用于完整文件.

## 更改日志

见 [`CHANGELOG.md`](https://github.com/ClickHouse/clickhouse-js/blob/main/packages/client-web/CHANGELOG.md)。 。 。 .

## 联系我们

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

## 许可证

[Apache 2.0 (英语)](https://github.com/ClickHouse/clickhouse-js/blob/main/LICENSE)

## 常见问题

### @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 和提交记录判断。