# @databricks/sql 中文文档

规范地址：https://npmcn.com/package/%40databricks/sql/

版本：3\.0\.0
npm 元数据更新时间：2026-11-05T01:56:41.344Z
中文译文更新时间：2026-11-11T13:06:09.270Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40databricks/sql
原文对照：https://npmcn.com/package/%40databricks/sql/?lang=original
项目主页：https://github.com/databricks/databricks-sql-nodejs#readme
源码仓库：https://github.com/databricks/databricks-sql-nodejs

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

- 包体积（解压后）：1.8 MB，401 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=22\.23\.4 \<23 \|\| \>=24\.22\.1 \<25 \|\| \>=26\.12\.1
- 运行依赖：11 个
- 首次发布：2022-06-24T18:08:24.089Z
- 最新版本发布：2026-11-05T01:56:41.114Z
- 近 30 天下载量：2581245（2026-10-12 至 2026-11-10，npm 官方下载统计）
- 已发布版本数：35（近 12 个月 12 个）

## 中文简介

通过Thrift API连接到Databricks SQL的驱动程序.

## 安装

```sh
npm install @databricks/sql
```

也可以使用：`pnpm add @databricks/sql`、`yarn add @databricks/sql`、`bun add @databricks/sql`

## README

# 节点的 Databricks SQL 驱动程序

![http://www.apache.org/licenses/LICENSE-2.0.txt](http://img.shields.io/:license-Apache%202-brightgreen.svg) [![npm](https://img.shields.io/npm/v/@databricks/sql?color=blue&style=flat)](https://www.npmjs.com/package/@databricks/sql) [![test](https://github.com/databricks/databricks-sql-nodejs/workflows/test/badge.svg?branch=main)](https://github.com/databricks/databricks-sql-nodejs/actions?query=workflow%3Atest+branch%3Amain) [![coverage](https://codecov.io/gh/databricks/databricks-sql-nodejs/branch/main/graph/badge.svg)](https://codecov.io/gh/databricks/databricks-sql-nodejs)

## 说明

Databricks SQL Driver for Node.js是连接到Databricks集群和SQL仓库的应用程序的Javascript驱动程序. 这个项目是一个叉子 [蜂巢驱动程序](https://github.com/lenchv/hive-driver) 它通过 Thrift API 连接.

## 所需资源

-   节点.js 22.23.4+, 24.22.1+, 26.12.1+,或后发

## 安装

```bash
npm i @databricks/sql
```

## 使用量

[实例/使用情况.js](https://npmcn.com/package/%40databricks/sql/examples/usage.js)

```javascript
const { DBSQLClient } = require('@databricks/sql');

const client = new DBSQLClient();

client
  .connect({
    host: '********.databricks.com',
    path: '/sql/2.0/warehouses/****************',
    token: 'dapi********************************',
  })
  .then(async (client) => {
    const session = await client.openSession();

    const queryOperation = await session.executeStatement('SELECT "Hello, World!"');
    const result = await queryOperation.fetchAll();
    await queryOperation.close();

    console.table(result);

    await session.close();
    await client.close();
  })
  .catch((error) => {
    console.log(error);
  });
```

## 配置

见 [(原始内容存档于2013-10-12). connection parameters.md](https://npmcn.com/package/%40databricks/sql/CONNECTION_PARAMETERS.md) 对于每一个连接, 会话,以及驱动程序接受的每个报表参数,以及是否每个参数 适用于 Thrift 后端(默认),SEA后端,或两者兼有.

## 遥测

驱动程序释放连接、 语句和 CloudFetch 度量衡加 已编辑错误事件来帮助 Databricks 改进驱动程序可靠性 。 没有 SQL 文本,参数值,或行数据被收集过. 排放为: 由服务器侧功能旗设置并禁用每次连接 与 `telemetryEnabled: false` 或全球范围 `DATABRICKS_TELEMETRY_DISABLED` (原始内容存档于2018-10-21). env var.

见 [文件/电信](https://npmcn.com/package/%40databricks/sql/docs/TELEMETRY.md) 以活动的有效载荷为限, 调取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取.

## 运行测试

### 单位测试

您可以运行所有单位测试, 或者指定要运行的特定测试 :

```bash
npm test
npm test -- <path/to/file.test.js>
```

### e2e测试

在运行端到端测试前, 创建一个名为的文件 `tests/e2e/utils/config.local.js` 并设置 Databricks SQL 连接信息 :

```javascript
{
    host: '***.databricks.com',
    path: '/sql/2.0/warehouses/***',
    token: 'dapi***',
    database: ['catalog', 'database'],
}
```

然后运行

```bash
npm run e2e
npm run e2e -- <path/to/file.test.js>
```

## 捐款

见 [捐款额](https://npmcn.com/package/%40databricks/sql/CONTRIBUTING.md)

## 问题

如果您发现任何问题,请随意创建问题或直接发送拉出请求.

## 许可证

[Apache 许可证 2.0](https://npmcn.com/package/%40databricks/sql/LICENSE)

## 常见问题

### @databricks/sql 是什么？

通过Thrift API连接到Databricks SQL的驱动程序\.

### 如何安装 @databricks/sql？

在项目目录运行 npm install @databricks/sql，或使用 pnpm add / yarn add / bun add。

### @databricks/sql 支持 TypeScript 吗？

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

### @databricks/sql 支持 ESM 还是 CommonJS？

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

### @databricks/sql 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=22\.23\.4 \<23 \|\| \>=24\.22\.1 \<25 \|\| \>=26\.12\.1。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @databricks/sql 可以商用吗？

@databricks/sql 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @databricks/sql 的下载量有多少？

根据 npm 官方下载统计，@databricks/sql 在 2026/10/12 – 2026/11/10 这 30 天内被下载 2,581,245 次，日均约 86,042 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @databricks/sql 还在维护吗？

最新版本 3\.0\.0 发布于 2026/11/05（6 天前）；至今共发布 35 个版本，其中过去 12 个月发布了 12 个；首次发布于 2022/06/25。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。