# @dbx-tools/lakebase 中文文档

规范地址：https://npmcn.com/package/%40dbx-tools/lakebase/

版本：0\.9\.206
npm 元数据更新时间：2026-11-10T19:18:41.108Z
中文译文更新时间：2026-11-11T17:22:36.270Z
软件包许可：Apache-2\.0

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

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

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

- 包体积（解压后）：127 kB，16 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：4 个
- 首次发布：2026-10-05T01:18:56.383Z
- 最新版本发布：2026-11-10T19:18:40.767Z
- 近 30 天下载量：11924（2026-10-12 至 2026-11-10，npm 官方下载统计）
- 已发布版本数：104（近 12 个月 104 个）

## 中文简介

湖基节点地址解析、资源发现和数据库证书

## 安装

```sh
npm install @dbx-tools/lakebase
```

也可以使用：`pnpm add @dbx-tools/lakebase`、`yarn add @dbx-tools/lakebase`、`bun add @dbx-tools/lakebase`

## README

# @dbx-tools/ 湖碱

解析数据砖 湖基目标进入主机、数据库和用户a PostgreSQL客户端需要,然后请求短期数据库认证. 这个 软件包给予节点和 Bun 应用程序从工程中获取的剖析感路由 名称或资源 URL 到连接准备值。 当目标是一个湖基 没有选定数据库的路径或 URL, 发现选择分支默认 (单位:千美元)`status.default`然后Lakebase的供给 `databricks_postgres`改为 PostgreSQL 通用软件 `postgres` 数据库.

## 快开始

```ts
import { LakebaseClient, parseAddress } from "@dbx-tools/lakebase";

const client = new LakebaseClient({ profile: "PROFILE" });
const resolved = await client.resolve(parseAddress("projects/example"));
const password = await client.generateDatabaseCredential(resolved.endpoint);

const connection = {
  host: resolved.host,
  port: resolved.port,
  database: resolved.database,
  user: resolved.user,
  password,
  ssl: { rejectUnauthorized: true },
};
```

将解析的值传递给 `pg`, Drizzle,一个ORM,或者另一个PostgreSQL客户端. 在打开上游连接时请求证书 。 客户端重新使用 在API的两分钟前 `expire_time`,并存 刷新, 并且从未坚持过数据库密码 .

## 选择湖基集成

-   使用本地应用程序 `lakebase()` 用于数据砖内的请求意识池 App. (英语).
-   使用 [@dbx-tools/appkit (英语)](https://npmcn.com/package/%40dbx-tools/appkit) 当湖底环境值必须是 在 AppKit 插件初始化前解决 .
-   使用此软件包进行剖面识别发现和单独认证 节点或邦代码.
-   使用 [dbx 湖碱代氧](https://npmcn.com/package/cli/dbx-tools) 当外部 PostgreSQL 时 客户端需要本地回路 URL .

## 选择目标

`parseAddress()` 接受项目ID、Canonical项目和分支资源, 端点或数据库资源,端点主机名,以及 PostgreSQL URL :

```ts
parseAddress("my-project");
parseAddress("projects/my-project/branches/production");
parseAddress("ep-example.database.cloud.databricks.com");
parseAddress("postgresql://host/database?sslmode=require");
```

使用 `requireAddress()` 当无效输入立即失败时。 使用 `parseResourcePath()` 当呼叫者必须提供 峡谷湖基资源 路径,而不是任何支持的地址窗体.

## 选择认证

将 Databricks 配置文件传递给 `LakebaseClient` 当本地应用程序必须使用时 特定的工作空间:

```ts
const lakebase = new LakebaseClient({ profile: "PROFILE" });
```

在Databricks App中,环境应用认证仍然可用. 启动 用户提供至 `resolve()` 或者说 `generateDatabaseCredential()` 被视为 配置文件只当它完全匹配已配置的本地配置文件。 明确 客户端简介总是获胜.

## 构建代理 URL

`connectionUrl()` 格式化当地URL [@dbx-tools/cli/lakebase-代理服务器](https://npmcn.com/package/cli/dbx-tools)数字 :

```ts
import { connectionUrl } from "@dbx-tools/lakebase";

connectionUrl("projects/my-project", "localhost", 5432);
// postgresql://localhost:5432/projects/my-project?sslmode=disable
```

## API 参考

-   `address` 剖析支持的目标和格式 本地代理 URL .
-   `client` 发现Lakebase资源并创建数据库证书.

## 常见问题

### @dbx-tools/lakebase 是什么？

湖基节点地址解析、资源发现和数据库证书

### 如何安装 @dbx-tools/lakebase？

在项目目录运行 npm install @dbx-tools/lakebase，或使用 pnpm add / yarn add / bun add。

### @dbx-tools/lakebase 支持 TypeScript 吗？

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

### @dbx-tools/lakebase 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @dbx-tools/lakebase 可以商用吗？

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

### @dbx-tools/lakebase 的下载量有多少？

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

### @dbx-tools/lakebase 还在维护吗？

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